Contents|Index|Previous|Next

Documentation conventions

The documentation uses the following conventions for commands, filenames, and other program-specific subjects.

- Typewriter-text for input
  Indicates onscreen text that is an example of input for a program, such as PATH=/usr/cygnus.

It will also indicate other literal bits of text from a program, such as filenames or source code.

- Typewriter-text in bold for output
  Indicates text that is an example of a program’s onscreen output such as ‘#’ or ‘(gdb)’ as command prompt.

Important:
‘#’ indicates a command prompt in most documentation; a command prompt, depending on the system in use and the program’s tool, may actually be ‘%’ or ‘$’ or ‘(gdb)’.

- Typewriter-text in italics for variables
  Indicates text to substitute in source data.

For instance, the documentation may read “To delete the file named filename, type rm filename.” filename stands for the file you want to substitute, according to its name.

- Keys or keystoke combinations
  This font indicates keys on your keyboard, such as Ctrl, Del, or Spacebar.

The Ctrl key and the Meta key are often indicated in the text by C- and M-, respectively. In addition, Meta (or M-) may indicate, for example, the Alt key on a DOS/Windows keyboard, or a diamond key on some Unix keyboards.

The ENTER (carriage return) key on your keyboard may appear as ENTER or Ret (for return).