prompts in command examples

[Jason Taylor]

On Thu, 2008-10-02 at 08:17 +1000, Murray McAllister wrote:
> Hi,
> 
> The Red Hat documentation team recently had a discussion about using
> prompts (such as "$" and "#") in command examples.
> 
> Joshua "top-posting ftw" Wulf came up with the following, and everyone
> agreed (I think...):
> 
> ---
> 
> OK, here it is:
> 
> When it's a command that should (could) be cut and pasted, it should
> have no prompt. Example:
> 
> ls -Z /tmp
> 
> When it's a record of an interactive session then the prompt should be
> included to distinguish commands from output. Example:
> 
> # ls -Z /tmp
> 
> -rw-rw-r--  auser   auser   user_u:object_r:user_home_t   bar
> -rw-rw-r--  auser   auser   user_u:object_r:user_home_t   foo
> 
> And when you want to make some commentary on that, you close the box
> and then speak.
> 
> ---
> 
> Does anyone have any suggestions or objections?
> 
> Cheers.

Commentary being along the lines of whether or not the command
should/has to be run as root or normal user?

-Jason
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 197 bytes
Desc: This is a digitally signed message part
URL: <http://listman.redhat.com/archives/fedora-docs-list/attachments/20081001/a21b8cf6/attachment.sig>