prompts in command examples

narendra sisodiya narendra.sisodiya at gmail.com
Thu Oct 2 01:26:08 UTC 2008


Possible Solutions could be
1) make a png image of "#" and  "$" sign, and display as image, instead of
text, This will disallow user to paste prompt while copy paste. He will be
able to select all line of shell code but images will not be pasted on text
screen or text editor. (NOT applicable to rich editor)
2) give code in two tab, one one will be visible at a time , both will be
identical in term of content but one will not be having prompt sign. When
page will load User will see content of tab which has "prompts" but when he
will try to copy paste , the focus event "toggle" the tabs so user will copy
the content without tabs. ( A small JavaScript can do these thing all places
)
(Note : take consideration to html to other format export, user can see both
tab )

I hope I am not out of context..

2008/10/2 Murray McAllister <murray.mcallister at gmail.com>

> 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
> >
>
> --
> 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.orghttp://www.lug-iitd.org
└────────────[ +91-93790-75930 ]──────┘
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/fedora-docs-list/attachments/20081002/4e672e09/attachment.htm>


More information about the fedora-docs-list mailing list