User`s guide

B Documentation Guidelines
B.5 Format and Style
159
B
■
A group of all-uppercase words on a line by itself. Underscores and numbers
are also permitted. For example:
THIS IS A HEADING
This is the text that follows....
■
A group of all-uppercase words at the start of a line and followed by a colon,
optionally followed by non-heading text on the same line. For example:
THIS IS A HEADING: This is the text that follows....
In special cases where such input should not be interpreted as a heading, the words
can be preceded with \&. For example:
\&THIS IS NOT A HEADING
Occasionally, it is necessary to include lowercase letters in a heading. For such
exceptions, use the \h tag. For example:
\h ARCHITECTURE NOTE FOR x86
This is the text that follows...
Longer reference entries sometimes call for subheadings. Type subheadings in
mixed-case on a separate line and apply the \sh tag. Capitalize words following
standard capitalization practices for mixed-case headings.
1
For example:
\sh Title for a Subheading
This is the text that follows...
Special Words
Literal Names of Commands, Global Variables, Files, and Other Elements
The literal names of many system elements are automatically made bold:
■
words ending in an empty pair of parentheses (routine names)
■
words ending in .c, .h, .o, and .tcl (file types)
■
words ending in Lib, Drv, Show, or Sio (library names)
■
words beginning with if_ (network interface library names)
■
words in all uppercase with one or more underscore characters (constants)
■
words that begin with S_ and end with an uppercase string (errno names)
Set off all other literal names with single quotes ( ‘ ). These include filenames, tools,
commands, operators, C keywords, global variables, structure members, network
interfaces, and so on.
1. Standard practice: always capitalize the first and last word, and capitalize all other words
except articles, prepositions, short conjunctions (fewer than five letters), and the word to.