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

Command

Name

Command -- The name of an executable program or other software command

Synopsis

Mixed Content Model

Command ::=
((#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

Name

Type

Default

MoreInfo

Enumeration:

None
RefEntry

"None"

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

This element holds the name of an executable program or the text of a command that a user enters to execute a program.

Command is an integral part of the CmdSynopsis environment as well as being a common inline.

Processing expectations

Formatted inline. The MoreInfo attribute can help generate a link or query to retrieve additional information.

(4.0) Future Changes

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

Attributes

MoreInfo

If MoreInfo is set to RefEntry, it implies that a RefEntry exists which further describes the Command.

See Also

Constant, Literal, Replaceable, VarName

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<para>
In <acronym>UNIX</acronym>,
<command>ls</command> is used to get a directory listing.
</para>

In UNIX, ls is used to get a directory listing.

For additional examples, see also CmdSynopsis, MediaLabel, Option, Parameter, SynopFragment.

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.