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 ...
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.
13 058b0118 2005-01-03 devnull Except in
17 058b0118 2005-01-03 devnull requests, any text argument denoted
19 058b0118 2005-01-03 devnull in the request summary may be zero to six words.
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'.
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,
30 058b0118 2005-01-03 devnull may be used to italicize a line of more than 6 words, or
32 058b0118 2005-01-03 devnull followed by
34 058b0118 2005-01-03 devnull to make small letters in `bold' font.
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
43 058b0118 2005-01-03 devnull The fonts are
46 058b0118 2005-01-03 devnull roman, the main font, preferred for diagnostics
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
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)
62 058b0118 2005-01-03 devnull also the constant width font.
65 058b0118 2005-01-03 devnull .BR L = B ;
68 058b0118 2005-01-03 devnull arguments of the macros
70 058b0118 2005-01-03 devnull .BR .LR ,
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).
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.
84 058b0118 2005-01-03 devnull macros admit equations and tables in the style of
85 058b0118 2005-01-03 devnull .IR eqn (1)
87 058b0118 2005-01-03 devnull .IR tbl (1),
88 058b0118 2005-01-03 devnull but do not support arguments on
94 058b0118 2005-01-03 devnull These strings are predefined by
95 058b0118 2005-01-03 devnull .BR -man :
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 .
106 058b0118 2005-01-03 devnull Change to default type size.
109 f6bc9149 2005-01-11 devnull The root directory of the Plan 9 installation.
110 058b0118 2005-01-03 devnull .SH FILES
111 c8b6342d 2005-01-13 devnull .B \*9/tmac/tmac.an
113 c8b6342d 2005-01-13 devnull .B \*9/tmac/tmac.antimes
114 058b0118 2005-01-03 devnull .SH SEE ALSO
115 058b0118 2005-01-03 devnull .IR troff (1),
116 058b0118 2005-01-03 devnull .IR man (1)
117 058b0118 2005-01-03 devnull .SH REQUESTS
118 058b0118 2005-01-03 devnull .ta \w'.TH n c x 'u +\w'Cause 'u +\w'Argument\ 'u
123 058b0118 2005-01-03 devnull .in \nau
125 058b0118 2005-01-03 devnull Request Cause If no Explanation
127 058b0118 2005-01-03 devnull Break Argument
129 058b0118 2005-01-03 devnull \&\fL.B\fR \fIt\fR no \fIt\fR=n.t.l.* Text
131 058b0118 2005-01-03 devnull is `bold'.
133 058b0118 2005-01-03 devnull \&\fL.BI\fR \fIt\fR no \fIt\fR=n.t.l. Join
134 058b0118 2005-01-03 devnull words of
136 058b0118 2005-01-03 devnull alternating bold and italic.
138 058b0118 2005-01-03 devnull \&\fL.BR\fR \fIt\fR no \fIt\fR=n.t.l. Join
139 058b0118 2005-01-03 devnull words of
141 058b0118 2005-01-03 devnull alternating bold and Roman.
143 058b0118 2005-01-03 devnull \&\fL.DT\fR no Restore default tabs.
145 058b0118 2005-01-03 devnull \&\fL.EE\fR yes End displayed example
147 058b0118 2005-01-03 devnull \&\fL.EX\fR yes Begin displayed example
149 058b0118 2005-01-03 devnull \&\fL.HP\fR \fIi\fR yes \fIi\fR=p.i.* Set prevailing indent to
151 058b0118 2005-01-03 devnull Begin paragraph with hanging indent.
153 058b0118 2005-01-03 devnull \&\fL.I\fR \fIt\fR no \fIt\fR=n.t.l. Text
155 058b0118 2005-01-03 devnull is italic.
157 058b0118 2005-01-03 devnull \&\fL.IB\fR \fIt\fR no \fIt\fR=n.t.l. Join
158 058b0118 2005-01-03 devnull words of
160 058b0118 2005-01-03 devnull alternating italic and bold.
162 058b0118 2005-01-03 devnull \&\fL.IP\fR \fIx i\fR yes \fIx\fR="" Same as \fL.TP\fP with tag
165 058b0118 2005-01-03 devnull \&\fL.IR\fR \fIt\fR no \fIt\fR=n.t.l. Join
166 058b0118 2005-01-03 devnull words of
168 058b0118 2005-01-03 devnull alternating italic and Roman.
170 058b0118 2005-01-03 devnull \&\fL.L\fR \fIt\fR no \fIt\fR=n.t.l. Text
172 058b0118 2005-01-03 devnull is literal.
174 058b0118 2005-01-03 devnull \&\fL.LP\fR yes Same as \fL.PP\fP.
176 058b0118 2005-01-03 devnull \&\fL.LR\fR \fIt\fR no Join 2
177 058b0118 2005-01-03 devnull words of
179 058b0118 2005-01-03 devnull alternating literal and Roman.
181 058b0118 2005-01-03 devnull \&\fL.PD\fR \fId\fR no \fId\fR=\fL.4v\fP Interparagraph distance is
184 058b0118 2005-01-03 devnull \&\fL.PP\fR yes Begin paragraph.
185 058b0118 2005-01-03 devnull Set prevailing indent to default.
187 058b0118 2005-01-03 devnull \&\fL.RE\fR yes End of relative indent.
188 058b0118 2005-01-03 devnull Set prevailing indent to amount of starting \fL.RS\fP.
190 058b0118 2005-01-03 devnull \&\fL.RI\fR \fIt\fR no \fIt\fR=n.t.l. Join
191 058b0118 2005-01-03 devnull words of
193 058b0118 2005-01-03 devnull alternating Roman and italic.
195 058b0118 2005-01-03 devnull \&\fL.RL\fR \fIt\fR no Join 2 or 3
196 058b0118 2005-01-03 devnull words of
198 058b0118 2005-01-03 devnull alternating Roman and literal.
200 058b0118 2005-01-03 devnull \&\fL.RS\fR \fIi\fR yes \fIi\fR=p.i. Start relative indent,
201 058b0118 2005-01-03 devnull move left margin in distance
203 058b0118 2005-01-03 devnull Set prevailing indent to default for nested indents.
205 058b0118 2005-01-03 devnull \&\fL.SH\fR \fIt\fR yes \fIt\fR="" Subhead; reset paragraph distance.
207 058b0118 2005-01-03 devnull \&\fL.SM\fR \fIt\fR no \fIt\fR=n.t.l. Text
209 058b0118 2005-01-03 devnull is small.
211 058b0118 2005-01-03 devnull \&\fL.SS\fR \fIt\fR no \fIt\fR="" Secondary subhead.
213 058b0118 2005-01-03 devnull \&\fL.TF\fR \fIs\fR yes Prevailing indent is wide as
218 058b0118 2005-01-03 devnull paragraph distance is 0.
220 058b0118 2005-01-03 devnull \&\fL.TH\fR \fIn c x\fR yes Begin page named
222 058b0118 2005-01-03 devnull of chapter
225 058b0118 2005-01-03 devnull is extra commentary, e.g. `local', for page head.
226 058b0118 2005-01-03 devnull Set prevailing indent and tabs to default.
228 058b0118 2005-01-03 devnull \&\fL.TP\fR \fIi\fR yes \fIi\fR=p.i. Set prevailing indent to
230 058b0118 2005-01-03 devnull Restore default indent if
231 058b0118 2005-01-03 devnull .IR i =0.
232 058b0118 2005-01-03 devnull Begin indented paragraph
233 058b0118 2005-01-03 devnull with hanging tag given by next text line.
234 058b0118 2005-01-03 devnull If tag doesn't fit, place it on separate line.
236 058b0118 2005-01-03 devnull \&\fL.1C\fR yes Equalize columns and return to 1-column output
238 058b0118 2005-01-03 devnull \&\fL.2C\fR yes Start 2-column nofill output
241 058b0118 2005-01-03 devnull * n.t.l. = next text line; p.i. = prevailing indent
242 058b0118 2005-01-03 devnull .SH BUGS
243 058b0118 2005-01-03 devnull There's no way to fool
244 058b0118 2005-01-03 devnull .I troff
245 058b0118 2005-01-03 devnull into handling literal double quote marks
247 058b0118 2005-01-03 devnull in font-alternation macros, such as
248 058b0118 2005-01-03 devnull .LR .BI .
250 058b0118 2005-01-03 devnull There is no direct way to suppress column widows in 2-column
251 058b0118 2005-01-03 devnull output; the column lengths may be adjusted by inserting
253 058b0118 2005-01-03 devnull requests before the closing
254 058b0118 2005-01-03 devnull .LR .1C .