10. Conventions used in this document

The following typographic and usage conventions occur in this text:

Table 1. Typographic and usage conventions

Text typeMeaning
"Quoted text"Quotes from people, quoted computer output.
terminal view
Literal computer input and output captured from the terminal, usually rendered with a light grey background.
command Name of a command that can be entered on the command line.
VARIABLE Name of a variable or pointer to content of a variable, as in $VARNAME.
option Option to a command, as in "the -a option to the ls command".
argument Argument to a command, as in "read man ls ".

command options arguments

Command synopsis or general usage, on a separated line.
filename Name of a file or directory, for example "Change to the /usr/bin directory."
Key Keys to hit on the keyboard, such as "type Q to quit".
Button Graphical button to click, like the OK button.
Menu->Choice Choice to select from a graphical menu, for instance: "Select Help->About Mozilla in your browser."
Terminology Important term or concept: "The Linux kernel is the heart of the system."
See Glossary link to related subject within this guide.
The author Clickable link to an external web resource.
Copyright © 2010-2021 Platon Technologies, s.r.o.           Home | Man pages | tLDP | Documents | Utilities | About
Design by styleshout