Re: [docbook] Docbook-man: command with sub commands?

[Robert Fekete <frobert@balabit.com>]

Hi,

in such cases I use separate refsection tags for the subcommands. For the 
options of the subcommand I use the variablelists described in the earlier 
thread. The source looks like:

<refsect1 id="pdbtool_dump">
      <title>The dump command</title>
      <cmdsynopsis>
        <command>dump</command>
        <arg>options</arg>
      </cmdsynopsis>
      <para>Display the RADIX tree built from the patterns. This shows how are 
the patterns represented in syslog-ng and it might also help to track down 
pattern-matching problems. The dump utility can dump the tree used for matching 
the PROGRAM or the MSG parts. </para>
      <variablelist>
        <varlistentry>
          <term><command>--pdb</command> or <command>-p</command></term>
          <listitem>
            <para>Name of the pattern database file to
              use.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>--program</command> or <command>-P</command></term>
          <listitem>
            <para>Displays the RADIX tree built from the patterns belonging to 
the <parameter>$PROGRAM</parameter> application.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>--program-tree</command> or <command>-T</command></term>
          <listitem>
            <para>Display the <parameter>$PROGRAM</parameter> tree.</para>
          </listitem>
        </varlistentry>
      </variablelist>

And the output is like this:
http://www.balabit.com/sites/default/files/documents/syslog-ng-ose-3.3-guides/syslog-ng-ose-v3.3-guide-admin-en.html/pdbtool.1.html


HTH,

Robert


On 07/18/2012 10:56 PM, ольга крыжановская wrote:

> I hope this is the right place to ask (after seeing some Docbook man
> questions coming through):
> How can I express sub commands in Docbook man pages, for example I
> like to write a myfs(1M) manual page, where command myfs has several
> sub commands:
>
>         myfs create [-s] [-b blocksize] [[-o property=value]]... -V size volume
>
>         myfs destroy [-rRf] filesystem|volume|snapshot
>
> How would the syntax for these 2 look alike?
>
> Olga