Updated: May 29, 2023 |
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 |
Constants | NULL |
Data types | unsigned short |
Environment variables | PATH |
File and pathnames | /dev/null |
Function names | exit() |
Keyboard chords | CtrlAltDelete |
Keyboard input | Username |
Keyboard keys | Enter |
Program output | login: |
Variable names | stdin |
Parameters | parm1 |
User-interface components | Navigator |
Window title | Options |
We use notes, cautions, and warnings to highlight important messages:
In our documentation, we typically use a forward slash (/) as a delimiter in pathnames, including those pointing to Windows files. We also generally follow POSIX/UNIX filesystem conventions.