Re: DOCBOOK: option description in reference pages

[davidw@dedasys.com (David N. Welton)]

Johannes Zellner <johannes@zellner.org> writes:

> 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?

You can't use <option> in <cmdsynopsis>.  You want to do something
like

	  <cmdsynopsis>
	    <command>load_env</command>
            <arg choice="opt">--someoption</arg>
	    <arg choice="opt"><replaceable>array_name</replaceable></arg>
	  </cmdsynopsis>

Outside of cmdsynopsis, you can use <option>, but not <arg>.

(see http://sourceforge.net/tracker/?func=detail&aid=598994&group_id=21935&atid=384107)

-- 
David N. Welton
   Consulting: http://www.dedasys.com/
     Personal: http://www.dedasys.com/davidw/
Free Software: http://www.dedasys.com/freesoftware/
   Apache Tcl: http://tcl.apache.org/