option

$Revision: 1.3 $

$Date: 2002/06/12 11:18:20 $

option — An option for a software command

Synopsis

Mixed Content Model

option ::=
(#PCDATA|replaceable|inlinemediaobject)*

Attributes

Common attributes

Description

Option identifies an optional argument to a software command.

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.

Future Changes

The content model of Option will be constrained to (#PCDATA | Replaceable | InlineGraphic) in DocBook V4.0.

Parents

These elements contain option: attribution, bibliomisc, citetitle, command, computeroutput, emphasis, entry, lineannotation, link, literal, literallayout, para, phrase, programlisting, quote, subtitle, term, title, titleabbrev, trademark, ulink, userinput.

Children

The following elements occur in option: inlinemediaobject, replaceable.

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<para>
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.
</para>

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

Prev	Home	Next
objectinfo	Up	orderedlist