3 man \- macros to typeset manual
11 These macros are used to format pages of this manual.
17 requests, any text argument denoted
19 in the request summary may be zero to six words.
22 may be used to include blanks in a `word'.
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,
30 may be used to italicize a line of more than 6 words, or
34 to make small letters in `bold' font.
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
46 roman, the main font, preferred for diagnostics
50 italic, preferred for parameters, short names of commands,
51 names of manual pages,
52 and naked function names
55 `bold', actually the constant width font,
56 preferred for examples, file names, declarations, keywords, names of
59 (numbers are rarely literals)
62 also the constant width font.
68 arguments of the macros
73 are printed in quotes;
74 preferred only where quotes really help (e.g. lower-case literals and
78 Type font and size are reset to default values
79 before each paragraph, and after processing
80 font- or size-setting macros.
84 macros admit equations and tables in the style of
88 but do not support arguments on
94 These strings are predefined by
98 .if t `\*R', `(Reg)' in
100 .if n `(Reg)', trademark symbol in
106 Change to default type size.
109 The root directory of the Plan 9 installation.
113 .B \*9/tmac/tmac.antimes
118 .ta \w'.TH n c x 'u +\w'Cause 'u +\w'Argument\ 'u
125 Request Cause If no Explanation
129 \&\fL.B\fR \fIt\fR no \fIt\fR=n.t.l.* Text
133 \&\fL.BI\fR \fIt\fR no \fIt\fR=n.t.l. Join
136 alternating bold and italic.
138 \&\fL.BR\fR \fIt\fR no \fIt\fR=n.t.l. Join
141 alternating bold and Roman.
143 \&\fL.DT\fR no Restore default tabs.
145 \&\fL.EE\fR yes End displayed example
147 \&\fL.EX\fR yes Begin displayed example
149 \&\fL.HP\fR \fIi\fR yes \fIi\fR=p.i.* Set prevailing indent to
151 Begin paragraph with hanging indent.
153 \&\fL.I\fR \fIt\fR no \fIt\fR=n.t.l. Text
157 \&\fL.IB\fR \fIt\fR no \fIt\fR=n.t.l. Join
160 alternating italic and bold.
162 \&\fL.IP\fR \fIx i\fR yes \fIx\fR="" Same as \fL.TP\fP with tag
165 \&\fL.IR\fR \fIt\fR no \fIt\fR=n.t.l. Join
168 alternating italic and Roman.
170 \&\fL.L\fR \fIt\fR no \fIt\fR=n.t.l. Text
174 \&\fL.LP\fR yes Same as \fL.PP\fP.
176 \&\fL.LR\fR \fIt\fR no Join 2
179 alternating literal and Roman.
181 \&\fL.PD\fR \fId\fR no \fId\fR=\fL.4v\fP Interparagraph distance is
184 \&\fL.PP\fR yes Begin paragraph.
185 Set prevailing indent to default.
187 \&\fL.RE\fR yes End of relative indent.
188 Set prevailing indent to amount of starting \fL.RS\fP.
190 \&\fL.RI\fR \fIt\fR no \fIt\fR=n.t.l. Join
193 alternating Roman and italic.
195 \&\fL.RL\fR \fIt\fR no Join 2 or 3
198 alternating Roman and literal.
200 \&\fL.RS\fR \fIi\fR yes \fIi\fR=p.i. Start relative indent,
201 move left margin in distance
203 Set prevailing indent to default for nested indents.
205 \&\fL.SH\fR \fIt\fR yes \fIt\fR="" Subhead; reset paragraph distance.
207 \&\fL.SM\fR \fIt\fR no \fIt\fR=n.t.l. Text
211 \&\fL.SS\fR \fIt\fR no \fIt\fR="" Secondary subhead.
213 \&\fL.TF\fR \fIs\fR yes Prevailing indent is wide as
218 paragraph distance is 0.
220 \&\fL.TH\fR \fIn c x\fR yes Begin page named
225 is extra commentary, e.g. `local', for page head.
226 Set prevailing indent and tabs to default.
228 \&\fL.TP\fR \fIi\fR yes \fIi\fR=p.i. Set prevailing indent to
230 Restore default indent if
232 Begin indented paragraph
233 with hanging tag given by next text line.
234 If tag doesn't fit, place it on separate line.
236 \&\fL.1C\fR yes Equalize columns and return to 1-column output
238 \&\fL.2C\fR yes Start 2-column nofill output
241 * n.t.l. = next text line; p.i. = prevailing indent
243 There's no way to fool
245 into handling literal double quote marks
247 in font-alternation macros, such as
250 There is no direct way to suppress column widows in 2-column
251 output; the column lengths may be adjusted by inserting
253 requests before the closing