Re: [docbook-apps] Docbook man page: Both short and long option alternative example?

[Thomas Schraitle <tom_schr@web.de>]

Hi Dan,

On Wed, 18 Jul 2012 12:05:38 +0200
Dan Shelton <dan.f.shelton@gmail.com> wrote:

> I need help with the Docbook syntax for manual pages.
> I'm trying to create a Docbook man page segment for this kind of
> --help output but fail miserably:
> -------cut-------
>   -m, --mode=mode Set the mode of created directories to mode. mode is
> symbolic or octal mode as in chmod(1). Relative modes assume an
> initial mode of a=rwx.
> -------cut-------
> Can anyone help me and express this in Docbook/XML, please? I'm stuck
> after 10 hours of trial&error. HELP!

I guess, this is one of many options you describe? In that case you
could use variablelist:

  <variablelist>
    <varlistentry>
      <term><option>-m</option></term>
      <term><option>--mode</option>=<replaceable>mode</replaceable></term>
      <listitem>
        <para>Set the mode of created directories to mode. mode is
            symbolic or octal mode as in <citerefentry>
              <refentrytitle>chmod</refentrytitle>
              <manvolnum>1</manvolnum>
            </citerefentry>. Relative modes assume an initial mode of
            <literal>a=rwx</literal>.
        </para>
      </listitem>
    </varlistentry>
    <!-- Add more varlistentrys with the same structure -->
  </variablelist>

Hope that helps.


-- 
Gruß/Regards,
    Thomas Schraitle