MAN(7) BSD MAN(7)
NAME
man - macros to typeset manual
SYNOPSIS
nroff -man file ...
troff -man file ...
DESCRIPTION
The man macros are used to format UNIX manual pages.
Any text argument t may be zero to six words. Quotes may be used to
include blanks in a "word". If text is empty, special treatment is
applied to the next input line containing text to be printed. In this
way, .I may be used to italicize a whole line, or . SM may be followed by
. B to make small bold text.
A prevailing indent distance is remembered between successive indented
paragraphs, and is reset to the default value upon reaching a non-
indented paragraph. Default units for indents i are ens.
Type font and size are reset to default values before each paragraph, and
after processing font and size setting macros.
These strings are predefined by -man:
\*R `(Reg)', trademark symbol in troff.
\*S Change to default type size.
REQUESTS
Request Cause If no Explanation
Break Argument
.B t no t=n.t.l.* Text t is bold.
.BI t no t=n.t.l. Join words of t alternating bold and italic.
.BR t no t=n.t.l. Join words of t alternating bold and Roman.
.DT no .5i 1i... Restore default tabs.
.HP i yes i=p.i.* Set prevailing indent to i. Begin paragraph with
hanging indent.
.I t no t=n.t.l. Text t is italic.
.IB t no t=n.t.l. Join words of t alternating italic and bold.
.IP x i yes x="" Same as .TP with tag x.
.IR t no t=n.t.l. Join words of t alternating italic and Roman.
.LP yes - Same as .PP.
.PD d no d=.4v Interparagraph distance is d.
.PP yes - Begin paragraph. Set prevailing indent to .5i.
.RE yes - End of relative indent. Set prevailing indent
to amount of starting .RS.
.RB t no t=n.t.l. Join words of t alternating Roman and bold.
.RI t no t=n.t.l. Join words of t alternating Roman and italic.
.RS i yes i=p.i. Start relative indent, move left margin in
distance i. Set prevailing indent to .5i for
nested indents.
.SH t yes t=n.t.l. Subhead.
.SM t no t=n.t.l. Text t is small.
.TH n c x v m yes - Begin page named n of chapter c; x is extra
commentary, for example, local, for page foot
center; v alters page foot left, for example,
4th Berkeley Distribution; m alters page head
center, for example, Brand X Programmer's
Manual. Set prevailing indent and tabs to .5i.
.TP i yes i=p.i. Set prevailing indent to i. Begin indented
paragraph with hanging tag given by next text
line. If tag doesn't fit, place it on separate
line.
* n.t.l. = next text line; p.i. = prevailing indent
FILES
/usr/lib/tmac/tmac.an
/usr/lib/tmac/tmac.an.new
BUGS
Relative indents don't nest.
SEE ALSO
troff(1), man(1)