Alexis's Helpme Pages: Meta Information: Document Conventions

Within the document body text, the following comvections apply:

Text generated by or entered into the computer is shown in courier font
Text to be entered is show additionally in bold
Prompts containing the hash character imply the command should be run as root
Prompts containing the dollar character imply the command should be run as non-root
Prompts containing a specific hostname imply the command should be run on that host
Placeholders (i.e. terse descriptions of what should be entered or seen at a particular point) are represented by either italic courier text or italic text in angled brackets, or both

Here is an example:

unix$ date
Sat Sep 5 11:29:51 BST 1998
unix$ su -
Password: <root_password>
unix# shutdown -h now

$Header: /diska/home/alexis/dev/helpme/doc/meta/RCS/document-conventions.html,v 1.7 1998/09/05 10:54:00 alexis Exp $