command

$Revision: 1.3 $

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

command — The name of an executable program or other software command

Synopsis

Mixed Content Model

command ::=
(#PCDATA|link|olink|ulink|action|application|classname|methodname|
 interfacename|exceptionname|ooclass|oointerface|ooexception|
 command|computeroutput|database|email|envar|errorcode|errorname|
 errortype|errortext|filename|function|guibutton|guiicon|guilabel|
 guimenu|guimenuitem|guisubmenu|hardware|interface|keycap|keycode|
 keycombo|keysym|literal|code|constant|markup|medialabel|
 menuchoice|mousebutton|option|optional|parameter|prompt|property|
 replaceable|returnvalue|sgmltag|structfield|structname|symbol|
 systemitem|uri|token|type|userinput|varname|nonterminal|anchor|
 remark|subscript|superscript|inlinegraphic|inlinemediaobject|
 indexterm|beginpage)*

Attributes

Common attributes

Name

Type

Default

moreinfo
Enumeration:
none
refentry
"none"

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.

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 XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<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, refentry, synopfragment.