Whole document tree
Group
Description
Group of constituent parts of a CmdSynopsis. A Group consists of one or more Args, Groups, SynopFragmentrefs,
Attributes
- Choice
Choice indicates whether the Arg must be supplied, and how it is to be rendered. Opt means it is optional (e.g., [arg]) and is the default; Req means that it is required, and is to be shown as such (e.g., {arg}); Plain means that it is required but is to be shown without decoration (e.g., arg).
- Rep
Rep indicates whether the Arg or Group is repeatable. Repeat is commonly rendered by an ellipsis; the default, Norepeat, needs no redition.
Examples
<cmdsynopsis>
<!-- This is a synopsis for the command foo.
The options -a and -x are optional and exclusive
The option -c takes a cheese and is optional and repeatable
The options -t and -k are referred to in another fragment
The options -i, -j, and -k are required and exclusive
The option -f takes a filename and is required
The -t and -k options specify the kind of milk and mold in an
optional and repeatable group
-->
<command>foo</command>
<group>
<arg>-a</arg>
<arg>-x</arg>
</group>
<group>
<arg rep=repeat>-c <replaceable>cheese</replaceable></arg>
<synopfragmentref linkend=cheesetype>cheesetype</synopfragmentref>
</group>
<group choice=req>
<arg>-i</arg>
<arg>-j</arg>
<arg>-k</arg>
</group>
<arg choice=req>-f <replaceable>filename</replaceable></arg>
<synopfragment id=cheesetype>
<group rep=repeat>
<arg>-t <replaceable>milk</replaceable></arg>
<arg>-k <replaceable>mold</replaceable></arg>
</group>
</synopfragment>
</cmdsynopsis>