group

group — A group of elements in a CmdSynopsis

Synopsis

Content Model

group ::=

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • choice (enumeration)
    • “opt”
    • “plain”
    • “req”
  • rep (enumeration)
    • “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

FIXME:

Enumerated values:

opt

FIXME:

plain

FIXME:

req

FIXME:

rep

FIXME:

Enumerated values:

norepeat

FIXME:

repeat

FIXME:

Parents

These elements contain group: arg, cmdsynopsis, group, synopfragment.

Children

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

See Also

arg, cmdsynopsis, refsynopsisdiv, sbr, synopfragment, synopfragmentref

ChangeLog

This alpha reference page is $Revision: 1.3 $ published $Date: 2005/07/07 16:40:57 $.