MAN(5) DOMAIN/IX Reference Manual (SYS5) MAN(5)
NAME
man - macros for formatting UNIX manual pages.
USAGE
nroff -man files
troff -man [ -rs1 ] files
DESCRIPTION
These troff(1) macros were developed to format UNIX manual
pages. A skeleton entry may be found in the file
/usr/pub/skeleton. These macros are used by the man(1) com-
mand.
The default page size is 8.5x11, with a 6.5x10 text area;
the -rs1 option reduces these dimensions to 6x9 and
4.75x8.375, respectively; this option (which is not effec-
tive in nroff(1)) also reduces the default type size from
10-point to 9-point, and the vertical line spacing from 12-
point to 10-point. The -rV2 option may be used to set cer-
tain parameters to values appropriate for certain Versatec
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.
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 special 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, but remains on for troff.
Type font and size are reset to default values before each
paragraph and after processing font- and size-setting mac-
ros, 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.2 ens in troff, 5 ens in nroff-this
corresponds to 0.5 inches in the default page size) by .TH,
.PP, 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 com-
mentary, e.g., ``local'', n is new manual name.
Invokes .DT (see below).
.SH text Place subhead text, e.g., USAGE, here.
.SS text Place sub-subhead text, e.g., Options, here.
.B text Make text bold.
Printed 5/30/85 MAN-1
MAN(5) DOMAIN/IX Reference Manual (SYS5) MAN(5)
.I text Make text italic.
.SM text Make text 1 point smaller than default point
size.
.RI a b Concatenate roman a with italic b, and alter-
nate these two fonts for up to six arguments.
Similar macros alternate 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 is a 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 (ini-
tially, k=1; k=0 is equivalent to k=1); if k is
omitted, return to the most recent lower indent
level.
.PM m Produces proprietary markings; where m may be P
for PRIVATE, N for NOTICE, etc.
.DT Restore default tab settings (every 7.2 ens in
troff, 5 ens in nroff).
.PD v Set the interparagraph distance to v vertical
spaces. If v is omitted, set the interpara-
graph distance to the default value (0.4v in
troff, 1v in nroff).
The following strings are defined:
\*R ``(Reg.)'' in nroff(1), ``Registered'' symbol
in troff(1).
\*S Change to default type size.
The following number registers are given default values by
.TH:
IN Left margin indent relative to subheads
(default is 7.2 ens in troff, 5 ens in nroff).
LL Line length including IN.
PD Current interparagraph distance.
NOTES
In addition to the macros, strings, and number registers
mentioned above, there are defined a number of internal mac-
ros, strings, and number registers. Except for names prede-
fined by troff(1) and number registers d, m, and y, all such
MAN-2 Printed 5/30/85
MAN(5) DOMAIN/IX Reference Manual (SYS5) MAN(5)
internal names are of the form XA, where X is one of ), ],
and }, and A stands for any alphanumeric character.
If a manual entry needs to be preprocessed by cw(1), eqn(1)
(or neqn), and/or tbl(1), 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 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 elim-
inate ambiguity) in the USAGE 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-see cw(1)). 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.
RELATED FILES
/usr/lib/tmac/tmac.an
/usr/lib/macros/cmp.[nt].[dt].an
/usr/lib/macros/ucmp.[nt].an
/usr/pub/skeleton
RELATED INFORMATION
man(1), manx(5), troff(1).
Printed 5/30/85 MAN-3