This is the mail archive of the
docbook@lists.oasis-open.org
mailing list for the DocBook project.
Re: [docbook] how to represent userinput with a command option?
- From: Yann Dirson <ydirson at fr dot alcove dot com>
- To: "Robert P. J. Day" <rpjday at mindspring dot com>
- Cc: docbook mailing list <docbook at lists dot oasis-open dot org>
- Date: Tue, 13 May 2003 18:05:19 +0200
- Subject: Re: [docbook] how to represent userinput with a command option?
- References: <Pine.LNX.4.44.0305131122350.26521-100000@dell>
On Tue, May 13, 2003 at 11:29:41AM -0400, Robert P. J. Day wrote:
> let's say i wanted to, as part of a <screen>, show a sample command
>
> $ wc [-w] letter
>
> now, the standard way to represent userinput is to display it in
> bold, to emphasize that it's typed by the user. so, as a first
> attempt:
>
> <pr>$</pr> <ui>wc <op><o>-w</o></op> letter</ui>
This looks much more like a <cmdsynopsys> use case - did you try to
use that ?
<cmdsynopsis>
<command>wc</command>
<arg choice="opt"><option>-w</option></arg>
<arg choice="req" rep="repeat">
<replaceable>file</replaceable>
</arg>
</cmdsynopsis>
--
Yann Dirson <Yann.Dirson@fr.alcove.com> http://www.alcove.com/
Technical support manager Responsable de l'assistance technique
Senior Free-Software Consultant Consultant senior en Logiciels Libres
Debian developer (dirson@debian.org) Développeur Debian
---------------------------------------------------------------------
To unsubscribe, e-mail: docbook-unsubscribe@lists.oasis-open.org
For additional commands, e-mail: docbook-help@lists.oasis-open.org