This is the mail archive of the
docbook@lists.oasis-open.org
mailing list for the DocBook project.
option description in reference pages
- From: Johannes Zellner <johannes at zellner dot org>
- To: docbook at lists dot oasis-open dot org
- Date: Sat, 07 Sep 2002 20:02:02 +0200
- 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