Search the Catalog
DocBook: The Definitive Guide

DocBook: The Definitive Guide

By Norman Walsh & Leonard Muellner
1st Edition October 1999
1-56592-580-7, Order Number: 5807
652 pages, $36.95 , Includes CD-ROM

Option

Name

Option -- An option for a software command

Synopsis

Mixed Content Model

Option ::=
((#PCDATA|Link|OLink|ULink|Action|Application|ClassName|Command|
  ComputerOutput|Database|Email|EnVar|ErrorCode|ErrorName|
  ErrorType|Filename|Function|GUIButton|GUIIcon|GUILabel|GUIMenu|
  GUIMenuItem|GUISubmenu|Hardware|Interface|InterfaceDefinition|
  KeyCap|KeyCode|KeyCombo|KeySym|Literal|Constant|Markup|
  MediaLabel|MenuChoice|MouseButton|MsgText|Option|Optional|
  Parameter|Prompt|Property|Replaceable|ReturnValue|SGMLTag|
  StructField|StructName|Symbol|SystemItem|Token|Type|UserInput|
  VarName|Anchor|Comment|Subscript|Superscript|InlineGraphic|
  InlineMediaObject|IndexTerm)+)

Attributes

Common attributes

Tag Minimization

Both the start- and end-tags are required for this element.

Parameter Entities

%cptr.char.mix;%ndxterm.char.mix;%para.char.mix;
%programlisting.content;%refinline.char.mix;%refname.char.mix;
%screen.content;%tbl.entry.mdl;%tech.char.class;
%title.char.mix;

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. See Appendix F.

(4.0) Future Changes

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

See Also

ComputerOutput, Constant, Literal, Markup, Optional, Parameter, Prompt, Replaceable, SGMLTag, UserInput, VarName

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<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.

For additional examples, see also Optional.

Back to: DocBook: The Definitive Guide


oreilly.com Home | O'Reilly Bookstores | How to Order | O'Reilly Contacts
International | About O'Reilly | Affiliated Companies | Privacy Policy

© 2001, O'Reilly & Associates, Inc.