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