OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

docbook message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [Elist Home]


Subject: DOCBOOK: option description in reference pages


Hi,

what is the recommended way (tag sequence) of describing
program switches in <refentry> pages?

I'd like to have output like

    OPTIONS

    -r, --some-option=[fred]

        option description text

    --another-option

        more text

is it:

    <refsynopsisdiv><title>OPTIONS</title>
      <cmdsynopsis>

        <arg><option>-r</option>, <option>--some-option=</option><replaceable>fred</replaceable></arg>
        <para>
          option description text
        </para>

        <arg><option>--another-option</arg>
        <para>
          more text
        </para>

      </cmdsynopsis>
    </refsynopsisdiv>

or is there another recommended way?

-- 
   Johannes


[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [Elist Home]


Powered by eList eXpress LLC