arg

Name

arg -- command argument element

Content Model

arg ::= (#PCDATA | replaceable)+

Description

arg elements hold command line arguments in command synopses of refentry documents. The parent node is cmdsynopsis or group.

Attributes

arg elements have choice and rep attributes.

choice attributes take one of the following values.

opt

Optional argument

plain

Plain argument

required

Required argument

choice values are implied if not given.

rep attributes take the following values.

norepeat

Argument may not be repeated

repeat

Argument may be repeated

rep values are implied if not given.

Formatting Expectations

When the choice attribute is optional, surround with brackets ([ arg ]). When the choice element is required, surround with braces ({ arg }). When the rep element is repeat, follow with an ellipsis, (arg ...).