1 .TH MAN 7
2 .SH NAME
3 man \- macros to typeset manual
4 .SH SYNOPSIS
5 .B nroff  -man
6 .I file ...
7 .PP
8 .B troff  -man
9 .I file ...
10 .SH DESCRIPTION
11 These macros are used to format pages of this manual.
12 .PP
13 Except in
14 .L .LR
15 and
16 .L .RL
17 requests, any text argument denoted
18 .I t
19 in the request summary may be zero to six words.
20 Quotes
21 \fL"\fP ... \fL"\fP
22 may be used to include blanks in a `word'.
23 If
24 .I t
25 is empty,
26 the special treatment is applied to
27 the next text input line (the next line that doesn't begin with dot).
28 In this way, for example,
29 .B .I
30 may be used to italicize a line of more than 6 words, or
31 .B .SM
32 followed by
33 .B .B
34 to make small letters in `bold' font.
35 .PP
36 A prevailing indent distance is remembered between
37 successive indented paragraphs,
38 and is reset to default value upon reaching a non-indented paragraph.
39 Default units for indents
40 .I i
41 are ens.
42 .PP
43 The fonts are
44 .TP
45 .B R
46 roman, the main font, preferred for diagnostics
47 .PD 0
48 .TP
49 .B I
50 italic, preferred for parameters, short names of commands,
51 names of manual pages,
52 and naked function names
53 .TP
54 .L B
55 `bold', actually the constant width font,
56 preferred for examples, file names, declarations, keywords, names of
57 .B struct
58 members, and literals
59 (numbers are rarely literals)
60 .TP
61 .B L
62 also the constant width font.
63 In
64 .I troff
65 .BR L = B ;
66 in
67 .I nroff
68 arguments of the macros
69 .BR .L ,
70 .BR .LR ,
71 and
72 .B .RL
73 are printed in quotes;
74 preferred only where quotes really help (e.g. lower-case literals and
75 punctuation).
76 .PD
77 .LP
78 Type font and size are reset to default values
79 before each paragraph, and after processing
80 font- or size-setting macros.
81 .PP
82 The
83 .B -man
84 macros admit equations and tables in the style of
85 .MR eqn (1)
86 and
87 .MR tbl (1) ,
88 but do not support arguments on
89 .B .EQ
90 and
91 .B .TS
92 macros.
93 .PP
94 These strings are predefined by
95 .BR -man :
96 .TP
97 .B \e*R
98 .if t `\*R', `(Reg)' in
99 .if t .IR nroff .
100 .if n `(Reg)', trademark symbol in
101 .if n .IR troff .
102 .br
103 .ns
104 .TP
105 .B \e*S
106 Change to default type size.
107 .Tp
108 .B \e*9
109 The root directory of the Plan 9 installation.
110 .SH FILES
111 .B \*9/tmac/tmac.an
112 .PP
113 .B \*9/tmac/tmac.antimes
114 .SH SEE ALSO
115 .IR troff (1), 
116 .MR man (1)
117 .SH REQUESTS
118 .ta \w'.TH n c x 'u +\w'Cause 'u +\w'Argument\ 'u
119 .di xx
120 			\ka
121 .br
122 .di
123 .in \nau
124 .ti0
125 Request	Cause	If no	Explanation
126 .ti0
127 	Break	Argument
128 .ti0
129 \&\fL.B\fR \fIt\fR	no	\fIt\fR=n.t.l.*	Text
130 .I t
131 is `bold'.
132 .ti0
133 \&\fL.BI\fR \fIt\fR	no	\fIt\fR=n.t.l.	Join
134 words of
135 .I t
136 alternating bold and italic.
137 .ti0
138 \&\fL.BR\fR \fIt\fR	no	\fIt\fR=n.t.l.	Join
139 words of
140 .I t
141 alternating bold and Roman.
142 .ti0
143 \&\fL.DT\fR	no		Restore default tabs.
144 .ti0
145 \&\fL.EE\fR	yes		End displayed example
146 .ti0
147 \&\fL.EX\fR	yes		Begin displayed example
148 .ti0
149 \&\fL.HP\fR \fIi\fR	yes	\fIi\fR=p.i.*	Set prevailing indent to
150 .IR i .
151 Begin paragraph with hanging indent.
152 .ti0
153 \&\fL.I\fR \fIt\fR	no	\fIt\fR=n.t.l.	Text
154 .I t
155 is italic.
156 .ti0
157 \&\fL.IB\fR \fIt\fR	no	\fIt\fR=n.t.l.	Join
158 words of
159 .I t
160 alternating italic and bold.
161 .ti0
162 \&\fL.IP\fR \fIx i\fR	yes	\fIx\fR=""	Same as \fL.TP\fP with tag
163 .IR x .
164 .ti0
165 \&\fL.IR\fR \fIt\fR	no	\fIt\fR=n.t.l.	Join
166 words of
167 .I t
168 alternating italic and Roman.
169 .ti0
170 \&\fL.L\fR \fIt\fR	no	\fIt\fR=n.t.l.	Text
171 .I t
172 is literal.
173 .ti0
174 \&\fL.LP\fR	yes		Same as \fL.PP\fP.
175 .ti0
176 \&\fL.LR\fR \fIt\fR	no		Join 2
177 words of
178 .I t
179 alternating literal and Roman.
180 .ti0
181 \&\fL.PD\fR \fId\fR	no	\fId\fR=\fL.4v\fP	Interparagraph distance is
182 .IR d .
183 .ti0
184 \&\fL.PP\fR	yes		Begin paragraph.
185 Set prevailing indent to default.
186 .ti0
187 \&\fL.RE\fR	yes		End of relative indent.
188 Set prevailing indent to amount of starting \fL.RS\fP.
189 .ti0
190 \&\fL.RI\fR \fIt\fR	no	\fIt\fR=n.t.l.	Join
191 words of
192 .I t
193 alternating Roman and italic.
194 .ti0
195 \&\fL.RL\fR \fIt\fR	no		Join 2 or 3
196 words of
197 .I t
198 alternating Roman and literal.
199 .ti0
200 \&\fL.RS\fR \fIi\fR	yes	\fIi\fR=p.i.	Start relative indent,
201 move left margin in distance
202 .IR i .
203 Set prevailing indent to default for nested indents.
204 .ti0
205 \&\fL.SH\fR \fIt\fR	yes	\fIt\fR=""	Subhead; reset paragraph distance.
206 .ti0
207 \&\fL.SM\fR \fIt\fR	no	\fIt\fR=n.t.l.	Text
208 .I t
209 is small.
210 .ti0
211 \&\fL.SS\fR \fIt\fR	no	\fIt\fR=""	Secondary subhead.
212 .ti0
213 \&\fL.TF\fR \fIs\fR	yes		Prevailing indent is wide as
214 string
215 .I s
216 in font 
217 .BR L ;
218 paragraph distance is 0.
219 .ti0
220 \&\fL.TH\fR \fIn c x\fR	yes		Begin page named
221 .I n
222 of chapter
223 .IR c;
224 .I x
225 is extra commentary, e.g. `local', for page head.
226 Set prevailing indent and tabs to default.
227 .ti0
228 \&\fL.TP\fR \fIi\fR	yes	\fIi\fR=p.i.	Set prevailing indent to
229 .IR i .
230 Restore default indent if
231 .IR i =0.
232 Begin indented paragraph
233 with hanging tag given by next text line.
234 If tag doesn't fit, place it on separate line.
235 .ti0
236 \&\fL.1C\fR	yes		Equalize columns and return to 1-column output
237 .ti0
238 \&\fL.2C\fR	yes		Start 2-column nofill output
239 .PP
240 .ti0
241 * n.t.l. = next text line; p.i. = prevailing indent
242 .SH BUGS
243 There's no way to fool
244 .I troff
245 into handling literal double quote marks
246 .B \&"
247 in font-alternation macros, such as
248 .LR .BI .
249 .PP
250 There is no direct way to suppress column widows in 2-column
251 output; the column lengths may be adjusted by inserting
252 .L .sp
253 requests before the closing
254 .LR .1C .