Re: writing commands
I use brackets to show a limited choice or option for a user. [...]
e.g.
> init [basic/pro/delux] {serial_number}
Brackets often represent optional arguments for commands in linux/unix.
For examples of this see traditional man pages:
http://web.cse.msu.edu/cgi-bin/man2html?ls?1?/usr/man
Cheers
Sam
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help format plus PDF, HTML and more. Flexible, precise, and efficient content delivery. Try it today! http://www.webworks.com/techwr-l
Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
To unsubscribe send a blank email to techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com
To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.
Follow-Ups:
- paragraph numbering, wongword
References:
writing commands: From: Carrie Baker
Re: writing commands: From: Lori Olcott
Previous by Author:
Split a Table cell into 4 equal diagonals.
Next by Author:
Re: Customizing Help
Previous by Thread:
RE: writing commands
Next by Thread:
paragraph numbering
Search our Technical Writing Archives & Magazine
Visit TechWhirl's Other Sites
Sponsored Ads