man.5 (2010 09)

m
man(5) man(5)
produces a footer with text in the form:
XYZ Company − 1 − Release 2.3: May 1996
Tables
The tbl preprocessor (see tbl (1)) can be used to insert tables in manpages. The
man macros allow you to
use the standard
tbl macros: .TS, .T&
, and .TE. They do not support the mm macro extensions,
.TS H and .TH (see mm(5)).
In general, avoid using the
man macros within a table, particularly the font macros, which can produce
peculiar and unpredictable results. Use the
nroff/troff intrinsic macros instead. For example, to
specify bold type, use the in-line macro
\fB, or, more generally, \f3. To insert horizontal blank lines,
you can use the
.PP or .IP
macro, depending on which one preceded the table, but you must then avoid
using the
center and expand table format specifications. Otherwise, indentation will be erratic.
WARNINGS
HP no longer uses the NAME section to prepare the Table of Contents and Index for the printed manual.
Instead, that information is coded as comments at the end of each manpage source file where it can be
accessed by various tools and programs as desired. The NAME section is still used for the
whatis data-
base, as described below.
The macro package used to print the HP-UX Reference increases the interword spaces (to eliminate ambi-
guity) in the SYNOPSIS section of each entry.
In addition to the macros, strings, and number registers mentioned above, a number of internal macros,
strings, and number registers are defined. These include
• The names predefined by the
nroff/troff processor.
• The macro
th,
• The number register
:m,
• Macro, string, and number names in the forms
)x, ]x, and
}x, where x stands for some
alphanumeric character,
• Macro, string, and number names in the form XY, where X and Y are capital letters.
Fonts
nroff uses only three fonts: roman, italic, and bold, designated as font positions 1, 2, and 3, respec-
tively. The constant-width font macros in the macro package (
.C, .RC, .IC, .BC, .CR, .CI, .CB) simu-
late a constant-width font with the bold font, since all
nroff output is constant width or typewriter for-
mat.
To use a true constant-width font with
troff, change the corresponding font 3 specification in each
constant-width font macro to font 4 and mount a constant-width font in position 4 using a
troff .fp
request, as in:
.fp4CW
The whatis Database
The NAME section of each manpage is processed by catman (see catman (1M)) to create an entry in the
whatis database, which is used by the -f and -k options of the man command. catman processes the
lines of the NAME section into a single line in the format:
name[
, name]... - explanatory-text
Hyphens (typed as
- or \-), en-dashes (\(mi), and em-dashes (\(em) are treated equivalently. The last
space-hyphen-space in the line becomes the dividing point between names and explanatory text.
FILES
/usr/share/lib/macros/an
The man macros.
/usr/share/lib/tmac/tmac.an
Called by man. Sources (.so) the macros in /usr/share/lib/macros/an. Other macro files
can be specified here to accommodate manpages with additional macro requirements.
6 Hewlett-Packard Company − 6 − HP-UX 11i Version 3: September 2010