Throughout this manual, we use certain typographical conventions to distinguish technical terms. In general, the conventions we use conform to those found in IEEE POSIX publications. The following table summarizes our conventions:
Reference | Example |
---|---|
Code examples | if( stream == NULL ) |
Command options | -lR |
Commands | make |
Environment variables | PATH |
File and pathnames | /dev/null |
Function names | exit() |
Keyboard chords | Ctrl-Alt-Delete |
Keyboard input | something you type |
Keyboard keys | Enter |
Program output | login: |
Programming constants | NULL |
Programming data types | unsigned short |
Programming literals | 0xFF, "message string" |
Variable names | stdin |
User-interface components | Cancel |
We use an arrow (→) in directions for accessing menu items, like this:
You'll find the Other... menu item under.
We use notes, cautions, and warnings to highlight important messages:
Notes point out something important or useful. |
Cautions tell you about commands or procedures that may have unwanted or undesirable side effects. |
Warnings tell you about commands or procedures that could be dangerous to your files, your hardware, or even yourself. |
In our documentation, we use a forward slash (/) as a delimiter in all pathnames, including those pointing to Windows files.
We also generally follow POSIX/UNIX filesystem conventions.
At the top and bottom of our HTML docs, you'll see some or all of these buttons:
Use this button: | To move: |
---|---|
To the previous part of the document. | |
“Up” in the document:
|
|
To the keyword index. | |
To the next part of the document. |