Noeud:Command Synopsis, Noeud « Next »:Function Synopsis, Noeud « Previous »:Class Synopsis, Noeud « Up »:Synopsis

Command Synopsis

CmdSynopsis = ( ( Command | Arg | Group | SBR )+,
                SynopFragment*
              )

Arg = ( ( #PCDATA
          | Arg
          | Group
          | Option
          | SynopFragmentRef
          | Replaceable
          | SBR
        )+
      )

Group = ( ( Arg
            | Group
            | Option
            | SynopFragmentRef
            | Replaceable
            | SBR
          )+
        )

SynopFragment = ( (Arg | Group )+
                )

Option = (%smallcptr.char.mix;)*

Elements : CmdSynopsis, Command, Arg, Group, SBR, Option, SynopFragmentRef, Replaceable.

Attributes : Sepchar, CmdLength, Choice, Rep.

The CmdSynopsis element is used to give the definition, or synopsis, for a software command.

<cmdsynopsis>
  <command>ls</command>
  <arg choice="opt">-l <arg choice="plain"><replaceable>col</replaceable
></arg></arg>
</cmdsynopsis>

<cmdsynopsis>
<command>telnet</command>
  <arg choice="opt"><replaceable>host</replaceable
><arg choice="opt"><replaceable>port</replaceable></arg></arg>
</cmdsynopsis>

<cmdsynopsis>
<command>ls</command>
  <arg>--time<arg choice="plain">=<group choice="req">
      <arg>atime</arg>
      <arg>access</arg>
      <arg>use</arg>
      <arg>ctime</arg>
      <arg>status</arg>
    </group>
</arg></arg><sbr>
  <arg>--color<arg>=<group choice="req">
        <arg>none</arg>
        <arg>auto</arg>
        <arg>always</arg>
      </group>
</arg></arg>
</cmdsynopsis>

<cmdsynopsis>
<command>gcc</command>
  <arg><synopfragmentref linkend="overall"
>overall options</synopfragmentref></arg>
  <arg><replaceable>filename</replaceable></arg>
  <synopfragment id="overall">
    <arg>-c</arg>
    <arg>-S</arg>
    <arg>-E</arg>
    <arg>-o <replaceable>file</replaceable></arg>
    <arg>-pipe</arg>
    <arg>-v</arg>
    <arg>-x <replaceable>language</replaceable></arg>
  </synopfragment>
</cmdsynopsis>