O'Reilly logo

DocBook 5: The Definitive Guide by Richard L. Hamilton, Norman Walsh

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Name

group — A group of elements in a cmdsynopsis

Synopsis

group ::= (arg | group | option | replaceable | sbr | synopfragmentref)+

Attribute synopsis

Common attributes and common linking attributes.

Additional attributes:

  • choice (enumeration) = “opt” | “plain” | “req” [default=“opt”]

  • rep (enumeration) = “norepeat” | “repeat” [default=“norepeat”]

Description

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.

Processing expectations

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.

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

arg, cmdsynopsis, refsynopsisdiv, sbr, synopfragment, synopfragmentref ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required