arg
arg — An argument in a cmdsynopsis.
Synopsis
arg ::= × ⏵
- Zero or more of:
- text
arg
group
(db.group)option
replaceable
sbr
synopfragmentref
- Graphic inlines ⏵
- Indexing inlines ⏵
- Linking inlines ⏵
- Ubiquitous inlines ⏵
Attributes
Common attributes and common linking attributes.
Additional attributes:
- choice (enumeration) [default=“opt”]
- “opt”
- “plain”
- “req”
- rep (enumeration) [default=“norepeat”]
- “norepeat”
- “repeat”
Description
Used in cmdsynopsis
for command arguments. See
cmdsynopsis
for more information and examples.
Processing expectations
May be formatted inline or as a displayed block, depending on context.
Attributes
Common attributes and common linking attributes.
- any attribute
Any attribute in any other explicit namespace
- choice
Indicates optionality.
Enumerated values: “opt” Formatted to indicate that it is optional.
“plain” Formatted without indication.
“req” Formatted to indicate that it is required.
- rep
Indicates whether or not repetition is possible.
Enumerated values: “norepeat” Can not be repeated.
“repeat” Can be repeated.
Parents
4 elements contain arg
. × ⏵
Children
34 elements occur in arg
. × ⏵
See Also
Related elements: cmdsynopsis
, group
, refsynopsisdiv
, sbr
, synopfragment
, synopfragmentref
.