1.5. Document Conventions

This document uses the following conventions:

DescriptionsAppearance
Caution

Caution

Don't run with scissors!

Hint or Tip

Tip

For best results...

Note

Note

Dear John...

Warning

Warning

Read this or the cat gets it.

File or directory name filename
Command to be typed command
Application name application
Normal user's prompt under bash shellbash$
Root user's prompt under bash shellbash#
Normal user's prompt under tcsh shelltcsh$
Environment variables VARIABLE
Term found in the glossary Bugzilla
Code example
<para>
Beginning and end of paragraph
</para>

This documentation is maintained in DocBook 4.1.2 XML format. Changes are best submitted as plain text or XML diffs, attached to a bug filed in the Bugzilla Documentation component.