option — An option for a software command.



An 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 D, Interchanging DocBook Documents.

Parents [+]

This element occurs in 53 elements.

Children [+]

This element contains 16 elements.


  1 <article xmlns='http://docbook.org/ns/docbook'>
  2 <title>Example option</title>
  4 <para>The <option>-a</option> option on the <acronym>UNIX</acronym>
    <command>ls</command> command or the <option>/r</option> option on the
  6 <acronym>DOS</acronym> <command>attrib</command>
    command, for example.
  8 </para>
 10 </article>

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

Last revised by Norman Walsh on 6 Jun 2011 (git hash: 6ffcc7640bbc5f852a318e452c9f210f03292cb9)