prompts in command examples

[Murray McAllister]

2008/10/2 narendra sisodiya <narendra.sisodiya at gmail.com>:
> IMHO,
> rule 1 = If a normal user can run a command then it must have $ prompt. ex
> ls -l
> rule 2 = If a command need root privilege to run, it must have # prompt   ex
> dd if=/dev/zero of=/dev/hda
> rule3 = rule 1 has high priority then rule 2.

Someone brought up the point that there are a lot of people
complaining on forums and getting the response "the '$' is the prompt,
not part of the command", so if a user needs to copy and paste, it is
easier if the prompt isn't there...

>
> On Thu, Oct 2, 2008 at 3:57 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
>>
>> --
>> fedora-docs-list mailing list
>> fedora-docs-list at redhat.com
>> To unsubscribe:
>> https://www.redhat.com/mailman/listinfo/fedora-docs-list
>
>
>
> --
> ┌───[ Narendra Sisodiya ]──────────────┐
> │     http://narendra.techfandu.org
> │     http://www.lug-iitd.org
> └────────────[ +91-93790-75930 ]──────┘
>
> --
> fedora-docs-list mailing list
> fedora-docs-list at redhat.com
> To unsubscribe:
> https://www.redhat.com/mailman/listinfo/fedora-docs-list
>