<command> vs <application>

Brad Smith brads at redhat.com
Thu Sep 8 20:48:39 UTC 2005


> We've had a convention of not including the prompt at all.  This is
> different from other UNIX documentation.  However, I don't think anyone
> has complained.
> 
> My guess is, the prompt was dropped for clarity sake?  In RH docs, we
> use <prompt> only when specifically discussing the prompt, otherwise
> it's left out for visual clarity, I reckon.


Hmm.. My concern about this is that since sometimes a prompt is
necessary eg to differentiate between stationX and stationY in a
networking example, we should always show a prompt. Otherwise it looks
wierd and inconsistent to have a prompt for some commands, but not for
others. 

Opinions?
--Brad
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
Url : http://lists.fedoraproject.org/pipermail/docs/attachments/20050908/4e837685/attachment.bin 


More information about the docs mailing list