MAN(5-BSD) RISC/os Reference Manual MAN(5-BSD)
NAME
man - macros to typeset manual
SYNOPSIS
nroff -man file ...
troff -man file ...
DESCRIPTION
These macros are used to lay out pages of this manual.
Any text argument t may be zero to six words. Quotes may be
used to include blanks in a `word'. If text is empty, spe-
cial treatment is applied to the next input line with 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
letters.
A prevailing indent distance is remembered between succes-
sive indented paragraphs, and is reset to 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 mac-
ros.
These strings are predefined by -man:
\*R `(Reg.)', registered symbol in troff.
\*Tm `TM', trademark symbol in troff.
\*S Change to default type size.
Special macros, strings, and number registers exist, inter-
nal to man, in the form of )A, ]A, and }A, where A stands
for any alphanumeric character. User-defined macros should
avoid using )A, ]A, and }A in naming macros.
The NAME section of every manual page must be one line long,
in the following format:
name \- short description
without font changes, size changes, or other dashes, and
ideally less than 80 characters long. Programs for creating
permuted indexes and tables of contents depend upon the NAME
section following these conventions.
FILES
/usr/lib/tmac/tmac.an
Printed 11/19/92 Page 1
MAN(5-BSD) RISC/os Reference Manual MAN(5-BSD)
SEE ALSO
nroff(1), man(1), troff(1).
REQUESTS
The following table lists the requests defined by -man.
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.
Page 2 Printed 11/19/92
MAN(5-BSD) RISC/os Reference Manual MAN(5-BSD)
Request Cause If no Explanation
Break Argument
.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 talternating
italic and Roman.
.LP yes - Same as .PP.
.PD d no d=.4v Interparagraph distance is d.
.P yes - Same as .PP.
.PP yes - Begin paragraph. Set prevail-
ing 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.
.SS t yes t=n.t.l. Sub-subhead.
.TH n c x v m yes - Begin page named n of chapter
c; x is extra commentary, e.g.
`local', added before `Page';
v alters opposite page foot,
e.g. `MIPS Computer Systems';
m alters page head center,
e.g. `RISC/os Reference
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
Printed 11/19/92 Page 3