group (db.group)

group — A group of elements in a cmdsynopsis.

Synopsis

group (db.group) ::=

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • choice (enumeration) [default=“opt”]
    • “opt”
    • “plain”
    • “req”
  • rep (enumeration) [default=“norepeat”]
    • “norepeat”
    • “repeat”

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”

Can not be repeated.

“repeat”

Can be repeated.

Parents

These elements contain group: arg, cmdsynopsis, group (db.group), synopfragment.

Children

The following elements occur in group: arg, group (db.group), option, replaceable, sbr, synopfragmentref.

Examples

<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>
mycmd [[-r revision] [ -h | -l | -p ]] { URL | filename } [parameters...]
Last revised by Norman Walsh on (git hash: c3457cab689d8fd89ba4252de204cf9a14e40acd 6a501344525f32f9834f0e4a5c3c3f8131803fa4 47fe34b28bad7941a61b9c1c17d47f6eed36cd04)