SynopFragment

Description

Part of CmdSynopsis. It contains one or more Args or Groups, in any order, and has common attributes with ID required.

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>