[Prev] [Next]

Option

Name

Synopsis

  (#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 | Markup | MediaLabel | MenuChoice
  | MouseButton | MsgText | Option | Optional | Parameter
  | Prompt | Property | Replaceable | ReturnValue | SGMLTag
  | StructField | StructName | Symbol | SystemItem | Token
  | Type | UserInput | Anchor | Comment | Subscript
  | Superscript
  | InlineGraphic)+

Attributes

This element has common and Role attributes.

Tag Minimization

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

Description

Option for a computer program command. It may contain members of cptr.char.mix, and has common attributes.

Processing Expectations

DocBook does not specify that a symbol (such as + or -) shall be generated before the content of Option. Unlike some other characters used in synopses (such as [ ]), these symbols are actually input by the user on the command line. While you may wish to generate them through your style sheet, it may be safer to include them literally, as content. If you generate them, you should warn your interchange partners.

Parents

These elements contain Option: Action, Application, Arg, Attribution, BiblioMisc, BridgeHead, Citation, CiteTitle, Command, Comment, ComputerOutput, Database, Emphasis, Filename, ForeignPhrase, FuncParams, FuncSynopsisInfo, Function, GlossSee, GlossSeeAlso, GlossTerm, Group, Hardware, Interface, InterfaceDefinition, KeyCap, LineAnnotation, Link, Literal, LiteralLayout, LoTentry, Member, MsgAud, OLink, Option, Optional, Para, Parameter, Phrase, Primary, PrimaryIE, ProductName, ProgramListing, Property, Quote, RefDescriptor, RefEntryTitle, RefName, RefPurpose, Screen, ScreenInfo, Secondary, SecondaryIE, See, SeeAlso, SeeAlsoIE, SeeIE, Seg, SegTitle, SimPara, Subtitle, Synopsis, SystemItem, Term, Tertiary, TertiaryIE, Title, TitleAbbrev, ToCback, ToCentry, ToCfront, Trademark, ULink, UserInput, and entry.

Children

Option contains these elements: Action, Anchor, Application, ClassName, Command, Comment, ComputerOutput, Database, Email, EnVar, ErrorCode, ErrorName, ErrorType, Filename, Function, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, Hardware, InlineGraphic, Interface, InterfaceDefinition, KeyCap, KeyCode, KeyCombo, KeySym, Link, Literal, Markup, MediaLabel, MenuChoice, MouseButton, MsgText, OLink, Option, Optional, #PCDATA, Parameter, Prompt, Property, Replaceable, ReturnValue, SGMLTag, StructField, StructName, Subscript, Superscript, Symbol, SystemItem, Token, Type, ULink, and UserInput.

In some contexts, some of these elements may be invalid due to exclusions in parent elements.

Examples

<REFSYNOPSISDIV ID="RS-061-66">
<SYNOPSIS>
<COMMAND>ls</COMMAND>
<OPTIONAL><PARAMETER>options</PARAMETER></OPTIONAL>
<REPLACEABLE CLASS="PARAMETER">directory name
</REPLACEABLE>
</SYNOPSIS>
</REFSYNOPSISDIV>

[Prev] OLink
[Next] Optional
[Reference Home] [Davenport Group Home]