docbook: markup for shell input
Subject:
Re: markup for shell input
From:
Emma Jane Hogbin ####@####.####
Date:
16 Jun 2003 22:25:01 -0000
Message-Id: <20030616222441.GB10176@xtrinsic.com>
On Mon, Jun 16, 2003 at 05:19:47PM -0500, David Horton wrote:
> Do a <command>locate <parameter>file</parameter></command> if they're
> not where they should be.
What's the difference between:
parameter http://docbook.org/tdg/en/html/parameter.html
parameter - A value or a symbolic reference to a value
A Parameter identifies something passed from one part of a computer system
to another.
option http://docbook.org/tdg/en/html/option.html
option - An option for a software command
Option identifies an optional argument to a software command.
Shouldn't the file (in the example above) be marked up with an <option>
not a <parameter>?
I understand that
replaceable http://docbook.org/tdg/en/html/replaceable.html
means "I'm not telling you what you should actually type, instead you
should REPLACE this word with the value that's appropriate for you."
> Or if you are giving a literal filename, for example readme.txt:
> Do a <command>locate <filename>readme.txt</filename></command> if
> they're not where they should be.
Hmm. I'd not been wrapping my options/parameters with the command tag.
Instead I'd been doing it like this:
<userinput>
<command>cd</command>
<filename class="directory">/usr/src</filename>
</userinput>
I'd love to shorten it to remove the <userinput> if I can. thoughts?
emma :)
--
Emma Jane Hogbin
[[ 416 417 2868 ][ www.xtrinsic.com ]]
