Name
arg — An argument in a cmdsynopsis
Synopsis
arg ::=
(text | arg | group |
option | phrase db._phrase | replaceable
| sbr | synopfragmentref |
Graphic inlines | Indexing inlines | Linking inlines | Ubiquitous inlines)*
Attribute synopsis
Common attributes and common linking attributes.
Additional attributes:
choice(enumeration) = “opt” | “plain” | “req” [default=“opt”]rep(enumeration) = “norepeat” | “repeat” [default=“norepeat”]
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” Cannot be repeated
“repeat” Can be repeated
See Also
cmdsynopsis, group, refsynopsisdiv, sbr, synopfragment, synopfragmentref
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access