    | DocBook: The Definitive Guide 2.0.17 (Alpha) |
| | DocBook: The Definitive Guide 2.0.17 (Alpha) |
$Revision: 1666 $
$Date: 2002-06-12 07:19:37 -0400 (Wed, 12 Jun 2002) $
group — A group of elements in a CmdSynopsis
group ::= ((arg|group|option|synopfragmentref|replaceable|sbr)+)
Name | Type | Default | ||||
| choice |
| "opt" | ||||
| rep |
| "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.
The OptMult and ReqMult values for the
Choice attribute will be removed in
DocBook V4.0. Use the Rep attribute
instead to indicate that the choice is repeatable.
The following elements occur in group:
arg, group, option, replaceable, sbr, synopfragmentref.
Choice indicates whether the Arg
is required (Req or Plain) or
optional (Opt). Arguments identified as Plain
are required, but are shown without additional decoration. The
OptMult and ReqMult choices will
be removed in DocBook V4.0; use the Rep
attribute instead.
A Rep value of Repeat indicates that
the Group is reapeatable. This is frequently rendered with an
ellipsis.
| | | |
| graphicco | | guibutton |