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.  The best way to learn how to use the macros is to take an existing manual page and hack it over to your own requirements. 

Any text argument t may be zero to six words.  Quotes may be used to include blanks in a ‘word’.  If text is empty, the special 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 followed by .B to make small bold letters. 

A prevailing indent distance is remembered between successive 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 macros. 

These strings are predefined by −man:

\∗R‘®’, ‘(Reg)’ in nroff. 

\∗SChange to default type size. 

FILES

/usr/lib/tmac/tmac.an

SEE ALSO

troff(1), nroff(1), man(1)

BUGS

Relative indents don’t nest. 

REQUESTS

RequestCauseIf noExplanation

BreakArgument

.B tnot=n.t.l.∗Text t is bold. 

.BI tnot=n.t.l.Join words of t alternating bold and italic. 

.BR tnot=n.t.l.Join words of t alternating bold and Roman. 

.DTno.5i 1i...Restore default tabs. 

.HP iyesi=p.i.∗Set prevailing indent to i.  Begin paragraph with hanging indent. 

.I tnot=n.t.l.Text t is italic. 

.IB tnot=n.t.l.Join words of t alternating italic and bold. 

.IP x iyesx=""Same as .TP with tag x. 

.IR tnot=n.t.l.Join words of t alternating italic and Roman. 

.LPyes-Same as .PP. 

.PD dnod=.4vInterparagraph distance is d. 

.PPyes-Begin paragraph.  Set prevailing indent to .5i. 

.REyes-End of relative indent.  Set prevailing indent to amount of starting .RS. 

.RB tnot=n.t.l.Join words of t alternating Roman and bold. 

.RI tnot=n.t.l.Join words of t alternating Roman and italic. 

.RS iyesi=p.i.Start relative indent, move left margin in distance i.  Set prevailing indent to .5i for nested indents. 

.SH tyest=n.t.l.Subhead. 

.SM tnot=n.t.l.Text t is small. 

.TH n c x v myes-Begin page named n of chapter c; x is extra commentary, e.g. ‘local’, for page foot center; v alters page foot left, e.g. ‘4th Berkeley Distribution’; m alters page head center, e.g. ‘Brand X Programmer’s Manual’.  Set prevailing indent and tabs to .5i. 

.TP iyesi=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

Sun Release 2.0  —  Last change: 5 November 1984