option

option — An option for a software command.

Synopsis

Zero or more of:
- text
- phrase (db._phrase)
- replaceable
- Graphic inlines
  inlinemediaobject
- Indexing inlines
  indexterm (db.indexterm.endofrange)
  indexterm (db.indexterm.singular)
  indexterm (db.indexterm.startofrange)
- Linking inlines
  anchor
  biblioref
  link
  olink
  xref
- Ubiquitous inlines
  alt
  anchor
  annotation
  biblioref
  indexterm (db.indexterm.endofrange)
  indexterm (db.indexterm.singular)
  indexterm (db.indexterm.startofrange)
  inlinemediaobject
  link
  olink
  remark
  subscript
  superscript
  xref

Attributes

Common attributes and common linking attributes.

Description

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.

Examples

  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.


oointerface		optional