avoid throwing away errors when reinitializing (from guy@sun.com)
[unix-history] / usr / src / share / man / man7 / man.7
CommitLineData
0b3b654e 1.\" @(#)man.7 6.3 (Berkeley) %G%
a5468a26 2.\"
4579a99c 3.TH MAN 7 ""
a5468a26
KM
4.AT 3
5.SH NAME
6man \- macros to typeset manual
7.SH SYNOPSIS
8.B
9nroff \-man\
10file ...
11.PP
12.B
13troff \-man\
14file ...
15.SH DESCRIPTION
16These macros are used to lay out pages of this manual.
17A skeleton page may be found in the file
18/usr/man/man0/xx.
19.PP
20Any text argument
21.I t
22may be zero to six words.
23Quotes may be used to include blanks in a `word'.
24If
25.I text
26is empty,
8510b0c0 27special treatment is applied to
a5468a26
KM
28the next input line with text to be printed.
29In this way
30.BR . I
31may be used to italicize a whole line, or
32.BR . SM
8510b0c0 33may be
a5468a26
KM
34followed by
35.BR . B
36to make small bold letters.
37.PP
38A prevailing indent distance is remembered between
39successive indented paragraphs,
40and is reset to default value upon reaching a non-indented paragraph.
41Default units for indents
42.I i
43are ens.
44.PP
45Type font and size are reset to default values
46before each paragraph, and after processing
47font and size setting macros.
48.PP
49These strings are predefined by
50.BR \-man :
51.IP \e*R
52.if t `\*R', `(Reg)' in
53.if t .I nroff.
54.if n `(Reg)', trademark symbol in
55.if n .I troff.
56.IP \e*S
57Change to default type size.
58.SH FILES
59/usr/lib/tmac/tmac.an
60.br
61/usr/man/man0/xx
62.SH SEE ALSO
63troff(1), man(1)
64.SH BUGS
65Relative indents don't nest.
66.SH REQUESTS
d2418787 67.ta \w'.TH n c x v m'u +\w'Cause 'u +\w'Argument\ 'u
a5468a26
KM
68.di xx
69 \ka
70.br
71.di
72.in \nau
73.ti0
74Request Cause If no Explanation
75.ti0
76 Break Argument
77.ti0
0b3b654e
KM
78.tr ~.
79~B \fIt\fR no \fIt\fR=n.t.l.* Text
a5468a26
KM
80.I t
81is bold.
82.ti0
0b3b654e 83~BI \fIt\fR no \fIt\fR=n.t.l. Join
a5468a26
KM
84words of
85.I t
86alternating bold and italic.
87.ti0
0b3b654e 88~BR \fIt\fR no \fIt\fR=n.t.l. Join
a5468a26
KM
89words of
90.I t
91alternating bold and Roman.
92.ti0
0b3b654e 93~DT no .5i 1i... Restore default tabs.
a5468a26 94.ti0
0b3b654e 95~HP \fIi\fR yes \fIi\fR=p.i.* Set prevailing indent to
a5468a26
KM
96.I i.
97Begin paragraph with hanging indent.
98.ti0
0b3b654e 99~I \fIt\fR no \fIt\fR=n.t.l. Text
a5468a26
KM
100.I t
101is italic.
102.ti0
0b3b654e 103~IB \fIt\fR no \fIt\fR=n.t.l. Join
a5468a26
KM
104words of
105.I t
106alternating italic and bold.
107.ti0
0b3b654e 108~IP \fIx i\fR yes \fIx\fR="" Same as .TP with tag
a5468a26
KM
109.I x.
110.ti0
0b3b654e 111~IR \fIt\fR no \fIt\fR=n.t.l. Join
a5468a26
KM
112words of
113.I t
114alternating italic and Roman.
115.ti0
0b3b654e 116~LP yes - Same as .PP.
a5468a26 117.ti0
0b3b654e 118~PD \fId\fR no \fId\fR=.4v Interparagraph distance is
a5468a26
KM
119.I d.
120.ti0
0b3b654e 121~PP yes - Begin paragraph.
a5468a26
KM
122Set prevailing indent to .5i.
123.ti0
0b3b654e 124~RE yes - End of relative indent.
a5468a26
KM
125Set prevailing indent to amount of starting .RS.
126.ti0
0b3b654e 127~RB \fIt\fR no \fIt\fR=n.t.l. Join
a5468a26
KM
128words of
129.I t
130alternating Roman and bold.
131.ti0
0b3b654e 132~RI \fIt\fR no \fIt\fR=n.t.l. Join
a5468a26
KM
133words of
134.I t
135alternating Roman and italic.
136.ti0
0b3b654e 137~RS \fIi\fR yes \fIi\fR=p.i. Start relative indent,
a5468a26
KM
138move left margin in distance
139.I i.
140Set prevailing indent to .5i for nested indents.
141.ti0
0b3b654e 142~SH \fIt\fR yes \fIt\fR=n.t.l. Subhead.
a5468a26 143.ti0
0b3b654e 144~SM \fIt\fR no \fIt\fR=n.t.l. Text
a5468a26
KM
145.I t
146is small.
147.ti0
0b3b654e 148~TH \fIn c x v m\fR yes - Begin page named
a5468a26
KM
149.I n
150of chapter
151.IR c;
152.I x
d2418787
KM
153is extra commentary, e.g. `local', for page foot center;
154.I v
155alters page foot left, e.g. `4th Berkeley Distribution';
156.I m
157alters page head center, e.g. `Brand X Programmer's Manual'.
a5468a26
KM
158Set prevailing indent and tabs to .5i.
159.ti0
0b3b654e 160~TP \fIi\fR yes \fIi\fR=p.i. Set prevailing indent to
a5468a26
KM
161.I i.
162Begin indented paragraph
163with hanging tag given by next text line.
164If tag doesn't fit, place it on separate line.
165.PP
166.ti0
167* n.t.l. = next text line; p.i. = prevailing indent