This is the mail archive of the docbook@lists.oasis-open.org mailing list for the DocBook project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

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


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]