prompts in command examples

[Paul W. Frields]

On Wed, Oct 01, 2008 at 09:32:22PM -0400, Matthew Daniels wrote:
> I'm pretty happy with the original proposal.  The prompt character makes 
> sense if you're copying and pasting console output to demonstrate a 
> point, but if you're advising a person to execute a command, the prompt 
> isn't necessary.  The idea that it should be in a prompt is relayed 
> through context.

I agree.

However, we shouldn't have users scratching their heads about what's
run by root and what's not.  Instead, use the following text:

'''
To restart the iptables firewall, run the following command.  Provide
the password for the root account at the prompt.

  su -c '/sbin/service iptables restart'

'''

Note that the su command removes the need for the user to look for
niggling prompt details.  It also clarifies that the user should
expect a prompt for the root password.

-- 
Paul W. Frields                                http://paul.frields.org/
  gpg fingerprint: 3DA6 A0AC 6D58 FEC4 0233  5906 ACDB C937 BD11 3717
  http://redhat.com/   -  -  -  -   http://pfrields.fedorapeople.org/
  irc.freenode.net: stickster @ #fedora-docs, #fedora-devel, #fredlug
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/fedora-docs-list/attachments/20081001/1e0d1e61/attachment.sig>