Describing Arguments

PreviousUpNext
Up: Special Formatting Next: Common Blocks of Text Previous: Special Formatting

Arguments to routines and command-line options for programs are described by using a plus (+), period (.), and minus (-) in the first column, followed by one or more spaces. The name of the argument or command line variable is next. Several arguments may be placed together, separated with spaces and/or commas. To include a hyphen (-) in the argument, prefix it with a backslash (\). Follow this with one or more spaces, then a dash (-), optional spaces, and finally the text of the description. The description may use multiple lines. The + should be used to start an argument list and - should be used to end the list. The period (.) should be used for all other arguments in the list. For example,

 
+ a - Pointer to 
      the data item 
. i, j - Sizes of data item 
. str - Another argument value 
- \-arg value - Sample command-line argument 
The + and - are optional but recommended. They permit better formatting of lists of arguments.


PreviousUpNext
Up: Special Formatting Next: Common Blocks of Text Previous: Special Formatting