BSD 3 development

[unix-history] / usr / man / man7 / man.7

.TH MAN 7 
.SH NAME
man \- macros to typeset manual
.SH SYNOPSIS
.B
nroff  \-man\ 
file ...
.PP
.B
troff  \-man\ 
file ...
.SH DESCRIPTION
These macros are used to lay out pages of this manual.
A skeleton page may be found in the file 
/usr/man/man0/xx.
.PP
Any text argument
.I t
may be zero to six words.
Quotes may be used to include blanks in a `word'.
If 
.I text
is empty,
the special treatment is applied to
the next input line with text to be printed.
In this way
.BR . I
may be used to italicize a whole line, or
.BR . SM
followed by
.BR . B
to make small bold letters.
.PP
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 i
are ens.
.PP
Type font and size are reset to default values
before each paragraph, and after processing
font and size setting macros.
.PP
These strings are predefined by
.BR \-man :
.IP \e*R
.if t `\*R', `(Reg)' in
.if t .I nroff.
.if n `(Reg)', trademark symbol in
.if n .I troff.
.IP \e*S
Change to default type size.
.SH FILES
/usr/lib/tmac/tmac.an
.br
/usr/man/man0/xx
.SH SEE ALSO
troff(1), man(1)
.SH BUGS
Relative indents don't nest.
.SH REQUESTS
.ta \w'.TH n c x 'u +\w'Cause 'u +\w'Argument\ 'u
.di xx
			\ka
.br
.di
.in \nau
.ti0
Request	Cause	If no	Explanation
.ti0
	Break	Argument
.ti0
.li
.B \fIt\fR	no	\fIt\fR=n.t.l.*	Text
.I t
is bold.
.ti0
.li
.BI \fIt\fR	no	\fIt\fR=n.t.l.	Join
words of
.I t
alternating bold and italic.
.ti0
.li
.BR \fIt\fR	no	\fIt\fR=n.t.l.	Join
words of
.I t
alternating bold and Roman.
.ti0
.li
.DT	no	.5i 1i...	Restore default tabs.
.ti0
.li
.HP \fIi\fR	yes	\fIi\fR=p.i.*	Set prevailing indent to
.I i.
Begin paragraph with hanging indent.
.ti0
.li
.I \fIt\fR	no	\fIt\fR=n.t.l.	Text
.I t
is italic.
.ti0
.li
.IB \fIt\fR	no	\fIt\fR=n.t.l.	Join
words of
.I t
alternating italic and bold.
.ti0
.li
.IP \fIx i\fR	yes	\fIx\fR=""	Same as .TP with tag
.I x.
.ti0
.li
.IR \fIt\fR	no	\fIt\fR=n.t.l.	Join
words of
.I t
alternating italic and Roman.
.ti0
.li
.LP	yes	-	Same as .PP.
.ti0
.li
.PD \fId\fR	no	\fId\fR=.4v	Interparagraph distance is 
.I d.
.ti0
.li
.PP	yes	-	Begin paragraph.
Set prevailing indent to .5i.
.ti0
.li
.RE	yes	-	End of relative indent.
Set prevailing indent to amount of starting .RS.
.ti0
.li
.RB \fIt\fR	no	\fIt\fR=n.t.l.	Join
words of
.I t
alternating Roman and bold.
.ti0
.li
.RI \fIt\fR	no	\fIt\fR=n.t.l.	Join
words of
.I t
alternating Roman and italic.
.ti0
.li
.RS \fIi\fR	yes	\fIi\fR=p.i.	Start relative indent,
move left margin in distance
.I i.
Set prevailing indent to .5i for nested indents.
.ti0
.li
.SH \fIt\fR	yes	\fIt\fR=n.t.l.	Subhead.
.ti0
.li
.SM \fIt\fR	no	\fIt\fR=n.t.l.	Text
.I t
is small.
.ti0
.li
.TH \fIn c x\fR	yes	-	Begin page named
.I n
of chapter
.IR c;
.I x
is extra commentary, e.g. `local', for page foot.
Set prevailing indent and tabs to .5i.
.ti0
.li
.TP \fIi\fR	yes	\fIi\fR=p.i.	Set prevailing indent to
.I i.
Begin indented paragraph
with hanging tag given by next text line.
If tag doesn't fit, place it on separate line.
.PP
.ti0
* n.t.l. = next text line; p.i. = prevailing indent