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 .IR eqn (1)
86 and
87 .IR 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 .SH FILES
108 .B /sys/lib/tmac/tmac.an
109 .SH SEE ALSO
110 .IR troff (1), 
111 .IR man (1)
112 .SH REQUESTS
113 .ta \w'.TH n c x 'u +\w'Cause 'u +\w'Argument\ 'u
114 .di xx
115 			\ka
116 .br
117 .di
118 .in \nau
119 .ti0
120 Request	Cause	If no	Explanation
121 .ti0
122 	Break	Argument
123 .ti0
124 \&\fL.B\fR \fIt\fR	no	\fIt\fR=n.t.l.*	Text
125 .I t
126 is `bold'.
127 .ti0
128 \&\fL.BI\fR \fIt\fR	no	\fIt\fR=n.t.l.	Join
129 words of
130 .I t
131 alternating bold and italic.
132 .ti0
133 \&\fL.BR\fR \fIt\fR	no	\fIt\fR=n.t.l.	Join
134 words of
135 .I t
136 alternating bold and Roman.
137 .ti0
138 \&\fL.DT\fR	no		Restore default tabs.
139 .ti0
140 \&\fL.EE\fR	yes		End displayed example
141 .ti0
142 \&\fL.EX\fR	yes		Begin displayed example
143 .ti0
144 \&\fL.HP\fR \fIi\fR	yes	\fIi\fR=p.i.*	Set prevailing indent to
145 .IR i .
146 Begin paragraph with hanging indent.
147 .ti0
148 \&\fL.I\fR \fIt\fR	no	\fIt\fR=n.t.l.	Text
149 .I t
150 is italic.
151 .ti0
152 \&\fL.IB\fR \fIt\fR	no	\fIt\fR=n.t.l.	Join
153 words of
154 .I t
155 alternating italic and bold.
156 .ti0
157 \&\fL.IP\fR \fIx i\fR	yes	\fIx\fR=""	Same as \fL.TP\fP with tag
158 .IR x .
159 .ti0
160 \&\fL.IR\fR \fIt\fR	no	\fIt\fR=n.t.l.	Join
161 words of
162 .I t
163 alternating italic and Roman.
164 .ti0
165 \&\fL.L\fR \fIt\fR	no	\fIt\fR=n.t.l.	Text
166 .I t
167 is literal.
168 .ti0
169 \&\fL.LP\fR	yes		Same as \fL.PP\fP.
170 .ti0
171 \&\fL.LR\fR \fIt\fR	no		Join 2
172 words of
173 .I t
174 alternating literal and Roman.
175 .ti0
176 \&\fL.PD\fR \fId\fR	no	\fId\fR=\fL.4v\fP	Interparagraph distance is
177 .IR d .
178 .ti0
179 \&\fL.PP\fR	yes		Begin paragraph.
180 Set prevailing indent to default.
181 .ti0
182 \&\fL.RE\fR	yes		End of relative indent.
183 Set prevailing indent to amount of starting \fL.RS\fP.
184 .ti0
185 \&\fL.RI\fR \fIt\fR	no	\fIt\fR=n.t.l.	Join
186 words of
187 .I t
188 alternating Roman and italic.
189 .ti0
190 \&\fL.RL\fR \fIt\fR	no		Join 2 or 3
191 words of
192 .I t
193 alternating Roman and literal.
194 .ti0
195 \&\fL.RS\fR \fIi\fR	yes	\fIi\fR=p.i.	Start relative indent,
196 move left margin in distance
197 .IR i .
198 Set prevailing indent to default for nested indents.
199 .ti0
200 \&\fL.SH\fR \fIt\fR	yes	\fIt\fR=""	Subhead; reset paragraph distance.
201 .ti0
202 \&\fL.SM\fR \fIt\fR	no	\fIt\fR=n.t.l.	Text
203 .I t
204 is small.
205 .ti0
206 \&\fL.SS\fR \fIt\fR	no	\fIt\fR=""	Secondary subhead.
207 .ti0
208 \&\fL.TF\fR \fIs\fR	yes		Prevailing indent is wide as
209 string
210 .I s
211 in font 
212 .BR L ;
213 paragraph distance is 0.
214 .ti0
215 \&\fL.TH\fR \fIn c x\fR	yes		Begin page named
216 .I n
217 of chapter
218 .IR c;
219 .I x
220 is extra commentary, e.g. `local', for page head.
221 Set prevailing indent and tabs to default.
222 .ti0
223 \&\fL.TP\fR \fIi\fR	yes	\fIi\fR=p.i.	Set prevailing indent to
224 .IR i .
225 Restore default indent if
226 .IR i =0.
227 Begin indented paragraph
228 with hanging tag given by next text line.
229 If tag doesn't fit, place it on separate line.
230 .ti0
231 \&\fL.1C\fR	yes		Equalize columns and return to 1-column output
232 .ti0
233 \&\fL.2C\fR	yes		Start 2-column nofill output
234 .PP
235 .ti0
236 * n.t.l. = next text line; p.i. = prevailing indent
237 .SH BUGS
238 There's no way to fool
239 .I troff
240 into handling literal double quote marks
241 .B \&"
242 in font-alternation macros, such as
243 .LR .BI .
244 .br
245 There is no direct way to suppress column widows in 2-column
246 output; the column lengths may be adjusted by inserting
247 .L .sp
248 requests before the closing
249 .LR .1C .