man(5) man(5)
NAME
man - macros for formatting entries in a manual (man pages)
SYNOPSIS
nroff -man file ...
troff -man [-rs1] file ...
DESCRIPTION
These troff(1M) macros are used to lay out the format of the entries
of a manual. These macros are used by the man(1) command.
The default page size is 8.5" x 11", with a 6.5" x 10" text area; the
-rs1 option reduces these dimensions to 6" x 9" and 4.75" x 8.375",
respectively; this option [which is not effective in nroff(1M)] also
reduces the default type size from 10-point to 9-point, and the verti-
cal line spacing from 12-point to 10-point. The -rV2 option may be
used to set certain parameters to values appropriate for certain Ver-
satec printers: it sets the line length to 82 characters, the page
length to 84 lines, and it inhibits underlining; this option should
not be confused with the -Tvp option of the man(1) command, which is
available at some UNIX system sites.
Any text argument below may be one to six "words". Double quotes ("")
may be used to include blanks in a "word". If text is empty, the spe-
cial treatment is applied to the next line that contains text to be
printed. For example, .I may be used to italicize a whole line, or .SM
followed by .B to make small bold text. By default, hyphenation is
turned off for nroff(1M), but remains on for troff(1M).
Type font and size are reset to default values before each paragraph
and after processing font- and size-setting macros, e.g. .I, .RB, .SM.
Tab stops are neither used nor set by any macro except .DT and .TH.
Default units for indents in are ens. When in is omitted, the previous
indent is used. This remembered indent is set to its default value
(7.2ens in troff, 5ens in nroff; this corresponds to 0.5" in the
default page size) by .TH, .P, and .RS, and restored by .RE.
.TH t s c n Set the title and entry heading; t is the title, s is
the section number, c is extra commentary, e.g. "local",
n is new manual name. Invokes .DT (see below).
.SH text Place subhead text, e.g. SYNOPSIS, here.
.SS text Place sub-subhead text, e.g. Attributes, here.
.B text Make text bold.
.I text Make text italic.
.SM text Make text 1 point smaller than default point size.
Page 1 Reliant UNIX 5.44 Printed 11/98
man(5) man(5)
.RI a b Concatenate roman a with italic b, and alternate these
two fonts for up to six arguments. Similar macros alter-
nate between any two of roman, italic, and bold: .IR .RB
.BR .IB .BI
.P Begin a paragraph with normal font, point size, and
indent.
.PP Synonym for .P.
.HP in Begin paragraph with hanging indent.
.TP in Begin indented paragraph with hanging tag. The next line
that contains text to be printed is taken as the tag. If
the tag does not fit, it is printed on a separate line.
.IP t in Same as .TP in with tag t; often used to get an indented
paragraph without a tag.
.RS in Increase relative indent (initially zero). Indent all
output an extra in units from the current left margin.
.RE k Return to the kth relative indent level (initially, k=1;
k=0 is equivalent to k=1); if k is omitted, return to
the most recent lower indent level.
.PM m y Produces proprietary markings; where m may be P for
Proprietary, RS for Restricted, RG for Registered, CR
for Copyright, UW for Unpublished Work, or CP for See
Cover Page; where y is the year used for the copyright
date for notices CR and UW (default is current year).
.DT Restore default tab settings (every 7.2ens in troff,
5ens in nroff).
.PD v Set the interparagraph distance to v vertical spaces. If
v is omitted, set the interparagraph distance to the
default value (0.4v in troff, 1v in nroff).
The following strings are defined:
\*R ® in troff, (Reg.) in nroff.
\*S Change to default point size.
\*(Tm Trademark indicator.
Page 2 Reliant UNIX 5.44 Printed 11/98
man(5) man(5)
The following number registers are given default values by .TH:
IN Left margin indent relative to subheads (default is 7.2ens in
troff, 5ens in nroff).
LL Line length including IN.
PD Current interparagraph distance.
NOTES
In addition to the macros, strings, and number registers mentioned
above, a number of internal macros, strings, and number registers are
also defined. Except for names predefined by troff(1M) and number
registers d, m, and y, all such internal names are of the form XA,
where X is one of ), ], and }, and A stands for any alphanumeric char-
acter.
If a manual entry needs to be preprocessed by eqn(1M) [or neqn(1M)],
and/or tbl(1M), it must begin with a special line [described in
man(1)], causing the man command to invoke the appropriate
preprocessor(s).
The programs that prepare the Table of Contents and the Permuted Index
for this Manual assume the NAME section of each entry consists of a
single line of input that has the following format:
name[, name, name ...] \- explanatory text
The macro package increases the inter-word spaces (to eliminate ambi-
guity) in the SYNOPSIS section of each entry.
The macro package itself uses only the roman font (so that one can
replace, for example, the bold font by the constant-width font (CW).
Of course, if the input text of an entry contains requests for other
fonts (e.g. .I, .RB, \fI), the corresponding fonts must be mounted.
NOTE
If the argument to .TH contains any blanks and is not enclosed by dou-
ble quotes (""), there will be strange irregular dots on the output.
FILES
/usr/lib/tmac/tmac.an
/usr/lib/macros/an
SEE ALSO
man(1), eqn(1M), nroff(1M), tbl(1M), tc(1M), troff(1M).
Page 3 Reliant UNIX 5.44 Printed 11/98