prompts in command examples

[Karsten 'quaid' Wade]

On Wed, 2008-10-01 at 18:27 -0400, Jason Taylor wrote:
> On Thu, 2008-10-02 at 08:17 +1000, Murray McAllister wrote:
> > 
> > And when you want to make some commentary on that, you close the box
> > and then speak.

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

This is about comment blocks included in a command example, which is a
long-standing technical/developer habit.  For example:

'''Don't do this'''

        <screen>
        ls -hal  ## this is a great shortcut for seeing all the file
                 ## attributes
        
        ## Additional options for ls are: -Z, -q ..
        </screen>
        
'''Do this'''

        This is a great shortcut for seeing all the file attributes:
        
        <screen>
        ls -hal
        </screen>
        
        In addition to <option>-hal</option>, try the options ...


-- 
Karsten Wade, Community Gardener
Dev Fu : http://developer.redhatmagazine.com
Fedora : http://quaid.fedorapeople.org
gpg key : AD0E0C41
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
Url : http://lists.fedoraproject.org/pipermail/docs/attachments/20081002/394f3207/attachment.bin