prompts in command examples

[Murray McAllister]

On Thu, Oct 2, 2008 at 8:27 AM, Jason Taylor <jmtaylor90 at gmail.com> wrote:
> 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
>
Commentary was regarding (sorry Karsten)
<http://www.redhat.com/docs/manuals/enterprise/RHEL-4-Manual/selinux-guide/rhlcommon-chapter-0017.html#RHLCOMMON-SECTION-0070>,
which has comments (# blah blah blah) in the example output.