Linux FAQ's & Manuals

9. 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.
commandname of a command that can be entered on the command line.
variablename of a variable or pointer to content of a variable, as in $varname.
optionoption to a command, as in "the -a option to the ls command".
argumentargument to a command, as in "read man ls".

command options arguments

command synopsis or general usage, on a separated line.
filenamename of a file or directory, for example "change to the /usr/bin directory."
keykeys to hit on the keyboard, such as "type q to quit".
buttongraphical button to click, like the ok button.
menu->choicechoice to select from a graphical menu, for instance: "select help->about mozilla in your browser."
terminologyimportant term or concept: "the linux kernel is the heart of the system."
\
the backslash in a terminal view or command synopsis indicates an unfinished line. in other words, if you see a long command that is cut into multiple lines, \ means "don't press enter yet!"
see chapter 1link to related subject within this guide.
the authorclickable link to an external web resource.