group — A group of elements in a cmdsynopsis
group ::=
(arg
| group
|
option
| replaceable
|
sbr
| synopfragmentref
)+
Common attributes and common linking attributes.
Additional attributes:
choice
(enumeration) = “opt” | “plain” | “req”
[default=“opt”]
rep
(enumeration) = “norepeat” | “repeat”
[default=“norepeat”]
A group
surrounds several related items.
Usually, they are grouped because they are mutually exclusive. The user
is expected to select one of the items.
Formatted inline. The additional processing expectations of a
group
are significant. For a complete discussion,
see cmdsynopsis
.
Multiple arguments within a group are considered exclusive and are separated by vertical bars.
Brackets are used to distinguish between optional, required,
or plain arguments. Usually square brackets are placed around
optional arguments, [-f | -g]
, and curly brackets
are placed around required arguments, {-f | -g}
.
Plain arguments are required, but are not decorated with
brackets.
Repeatable arguments are followed by an ellipsis.
Common attributes and common linking attributes.
Indicates optionality
Enumerated values: | |
---|---|
“opt” | Formatted to indicate that it is optional |
“plain” | Formatted without indication |
“req” | Formatted to indicate that it is required |
Indicates whether or not repetition is possible
Enumerated values: | |
---|---|
“norepeat” | Cannot be repeated |
“repeat” | Can be repeated |
<article xmlns='http://docbook.org/ns/docbook'> <title>Example group in cmdsynopsis</title> <cmdsynopsis> <command>mycmd</command> <group> <arg>-r <replaceable>revision</replaceable></arg> <group> <arg choice="plain">-h</arg> <arg choice="plain">-l</arg> <arg choice="plain">-p</arg> </group> </group> <group choice="req"> <arg choice="plain">URL</arg> <arg choice="plain">filename</arg> </group> <arg rep="repeat">parameters</arg> </cmdsynopsis> </article>