$Revision: 3588 $

$Date: 2004-05-19 11:56:44 -0400 (Wed, 19 May 2004) $

option — An option for a software command


Mixed Content Model

option ::=


Common attributes

Parameter Entities

The following parameter entities contain option:

Parameter Entities


Option identifies an argument to a software command or instruction. Options may or may not be required. The optional element can be used to explicitly identify options that are not required.

Processing expectations

Formatted inline.

DocBook does not specify whether or not a symbol (such as - or /) is generated before the content of Option, or what that symbol might be. Generating the text may or may not be desirable, but in either case, it is an interchange issue. See Appendix F, Interchanging DocBook Documents.

See Also

computeroutput, constant, literal, markup, optional, parameter, prompt, replaceable, sgmltag, userinput, varname.


<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
The <option>-a</option> option on the <acronym>UNIX</acronym>
<command>ls</command> command or the <option>/r</option> option on the
<acronym>DOS</acronym> <command>attrib</command>
command, for example.

The -a option on the UNIX ls command or the /r option on the DOS attrib command, for example.

For additional examples, see also optional, refentry.