Whole document tree
    

Whole document tree

Option

Option

Name

Option -- Option for a computer program command

Description

Option for a computer program command. It may contain members of cptr.char.mix, and has common attributes.

Processing Expectations

DocBook does not specify that a symbol (such as + or -) shall be generated before the content of Option. Unlike some other characters used in synopses (such as [ ]), these symbols are actually input by the user on the command line. While you may wish to generate them through your style sheet, it may be safer to include them literally, as content. If you generate them, you should warn your interchange partners.

Examples

<REFSYNOPSISDIV ID="RS-061-66">
<SYNOPSIS>
<COMMAND>ls</COMMAND>
<OPTIONAL><PARAMETER>options</PARAMETER></OPTIONAL>
<REPLACEABLE CLASS="PARAMETER">directory name
</REPLACEABLE>
</SYNOPSIS>
</REFSYNOPSISDIV>