1.6. Document Conventions

This document uses the following conventions[1]:

DescriptionsAppearance
Information requiring special attention

Warning

This is a warning.

Caution

Caution

This cautions the reader.

Hint

Tip

This is a hint.

Notes

Note

This is a note.

File Namesfile.extension
Directory Namesdirectory
Commands to be typedcommand
Applications Namesapplication
Prompt of users command under bash shellbash$
Prompt of root users command under bash shellbash#
Prompt of user command under tcsh shelltcsh$
Environment VariablesVARIABLE
Emphasized wordword
Quoted text"quote"
Code Example
<para>Beginning and end of paragraph</para>

Notes

[1]

Please, take a look at the source to see how to get similar results on your documents. You should also remember that the way this appears to you depends on the format in which you are reading this document: online appearance is slightly different from the PostScript or PDF ones.

mirror server hosted at Truenetwork, Russian Federation.