arg
arg — An argument in a CmdSynopsis.
Synopsis
- Zero or more of:
- text
arggroupoptionphrase(db._phrase)replaceablesbrsynopfragmentref- Graphic inlines
![[+]](figs/web/nav/right.gif)
- Indexing inlines
- Linking inlines
- Ubiquitous inlines
![[-]](figs/web/nav/down.gif)
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.
- 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
These elements contain arg: arg, cmdsynopsis, group, synopfragment.
Children
This element contains 21 elements.
See Also
cmdsynopsis, group, refsynopsisdiv, sbr, synopfragment, synopfragmentref