aboutsummaryrefslogtreecommitdiff
path: root/man/man7/man.html
blob: 4087e795fb9e63cb5820bf4a9e5c640ac38b0d6b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
<head>
<title>man(7) - Plan 9 from User Space</title>
<meta content="text/html; charset=utf-8" http-equiv=Content-Type>
</head>
<body bgcolor=#ffffff>
<table border=0 cellpadding=0 cellspacing=0 width=100%>
<tr height=10><td>
<tr><td width=20><td>
<tr><td width=20><td><b>MAN(7)</b><td align=right><b>MAN(7)</b>
<tr><td width=20><td colspan=2>
    <br>
<p><font size=+1><b>NAME     </b></font><br>

<table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>

    man &ndash; macros to typeset manual<br>
    
</table>
<p><font size=+1><b>SYNOPSIS     </b></font><br>

<table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>

    <tt><font size=+1>nroff &#8722;man</font></tt> <i>file ... 
    <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
    </i>
    <tt><font size=+1>troff &#8722;man</font></tt> <i>file ...<br>
    </i>
</table>
<p><font size=+1><b>DESCRIPTION     </b></font><br>

<table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>

    These macros are used to format pages of this manual. 
    <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
    
    Except in <tt><font size=+1>.LR</font></tt> and <tt><font size=+1>.RL</font></tt> requests, any text argument denoted <i>t</i> in
    the request summary may be zero to six words. Quotes <tt><font size=+1>&quot;</font></tt> ... <tt><font size=+1>&quot;</font></tt> may
    be used to include blanks in a &#8216;word&#8217;. If <i>t</i> is empty, the special
    treatment is applied to the next text input line (the next line
    that doesn&#8217;t begin with dot). In this way, for example, <tt><font size=+1>.I
    </font></tt>may be used to italicize a line of more than 6 words, or <tt><font size=+1>.SM</font></tt> followed
    by <tt><font size=+1>.B</font></tt> to make small letters in &#8216;bold&#8217; font. 
    <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
    
    A prevailing indent distance is remembered between successive
    indented paragraphs, and is reset to default value upon reaching
    a non-indented paragraph. Default units for indents <i>i</i> are ens.
    
    <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
    
    The fonts are<br>
    <tt><font size=+1>R</font></tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;roman, the main font, preferred for diagnostics<br>
    <tt><font size=+1>I</font></tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;italic, preferred for parameters, short names of commands, names
    of manual pages, and naked function names<br>
    <tt><font size=+1>B</font></tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8216;bold&#8217;, actually the constant width font, preferred for examples,
    file names, declarations, keywords, names of <tt><font size=+1>struct</font></tt> members, and
    literals (numbers are rarely literals)<br>
    <tt><font size=+1>L</font></tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;also the constant width font. In <i>troff</i> <tt><font size=+1>L</font></tt>=<tt><font size=+1>B</font></tt>; in <i>nroff</i> arguments
    of the macros <tt><font size=+1>.L</font></tt>, <tt><font size=+1>.LR</font></tt>, and <tt><font size=+1>.RL</font></tt> are printed in quotes; preferred
    only where quotes really help (e.g. lower-case literals and punctuation).
    
    <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
    
    Type font and size are reset to default values before each paragraph,
    and after processing font- or size-setting macros. 
    <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
    
    The <tt><font size=+1>&#8722;man</font></tt> macros admit equations and tables in the style of <a href="../man1/eqn.html"><i>eqn</i>(1)</a>
    and <a href="../man1/tbl.html"><i>tbl</i>(1)</a>, but do not support arguments on <tt><font size=+1>.EQ</font></tt> and <tt><font size=+1>.TS</font></tt> macros.
    
    <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
    
    These strings are predefined by <tt><font size=+1>&#8722;man</font></tt>:<br>
    <tt><font size=+1>\*R</font></tt>&nbsp;&nbsp;&nbsp;&#8216;&reg;&#8217;, &#8216;(Reg)&#8217; in <i>nroff</i>.<br>
    <tt><font size=+1>\*S</font></tt>&nbsp;&nbsp;&nbsp;Change to default type size. <tt><font size=+1>\*9</font></tt> The root directory of the
    Plan 9 installation.<br>
    
</table>
<p><font size=+1><b>FILES     </b></font><br>

<table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>

    <tt><font size=+1>/usr/local/plan9/tmac/tmac.an 
    <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
    </font></tt>
    <tt><font size=+1>/usr/local/plan9/tmac/tmac.antimes<br>
    </font></tt>
</table>
<p><font size=+1><b>SEE ALSO    </b></font><br>

<table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>

    <a href="../man1/troff.html"><i>troff</i>(1)</a>, <a href="../man1/man.html"><i>man</i>(1)</a><br>
    
</table>
<p><font size=+1><b>REQUESTS     </b></font><br>
Request Cause If no &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Explanation<br>

<table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>

    
    <table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>

        Break Argument<br>
        
    </table>
    
</table>
<tt><font size=+1>.B</font></tt> <i>t </i>&nbsp;&nbsp;&nbsp;&nbsp;no 
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
<tt><font size=+1>&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;</font></tt><i>t</i>=n.t.l.* &nbsp;&nbsp;&nbsp;Text <i>t</i> is &#8216;bold&#8217;.<br>
<tt><font size=+1>.BI</font></tt> <i>t </i>&nbsp;&nbsp;&nbsp;no 
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
<tt><font size=+1>&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;</font></tt><i>t</i>=n.t.l. &nbsp;&nbsp;&nbsp;Join words of <i>t</i> alternating bold and italic.<br>
<tt><font size=+1>.BR</font></tt> <i>t </i>&nbsp;&nbsp;&nbsp;no 
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
<tt><font size=+1>&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;</font></tt><i>t</i>=n.t.l. &nbsp;&nbsp;&nbsp;Join words of <i>t</i> alternating bold and Roman.<br>
<tt><font size=+1>.DT </font></tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;no  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Restore default tabs.<br>
<tt><font size=+1>.EE </font></tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;yes  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;End displayed example<br>
<tt><font size=+1>.EX </font></tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;yes  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Begin displayed example<br>
<tt><font size=+1>.HP</font></tt> <i>i </i>&nbsp;&nbsp;&nbsp;yes 
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
<tt><font size=+1>&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;</font></tt><i>i</i>=p.i.* &nbsp;&nbsp;&nbsp;&nbsp;Set prevailing indent to <i>i</i>. Begin paragraph with hanging
indent.<br>
<tt><font size=+1>.I</font></tt> <i>t </i>&nbsp;&nbsp;&nbsp;&nbsp;no 
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
<tt><font size=+1>&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;</font></tt><i>t</i>=n.t.l. &nbsp;&nbsp;&nbsp;Text <i>t</i> is italic.<br>
<tt><font size=+1>.IB</font></tt> <i>t </i>&nbsp;&nbsp;&nbsp;no 
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
<tt><font size=+1>&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;</font></tt><i>t</i>=n.t.l. &nbsp;&nbsp;&nbsp;Join words of <i>t</i> alternating italic and bold.<br>
<tt><font size=+1>.IP</font></tt> <i>x i</i> yes 
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
<tt><font size=+1>&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;</font></tt><i>x</i>=&quot;&quot; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Same as <tt><font size=+1>.TP</font></tt> with tag <i>x</i>.<br>
<tt><font size=+1>.IR</font></tt> <i>t </i>&nbsp;&nbsp;&nbsp;no 
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
<tt><font size=+1>&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;</font></tt><i>t</i>=n.t.l. &nbsp;&nbsp;&nbsp;Join words of <i>t</i> alternating italic and Roman.<br>
<tt><font size=+1>.L</font></tt> <i>t </i>&nbsp;&nbsp;&nbsp;&nbsp;no 
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
<tt><font size=+1>&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;</font></tt><i>t</i>=n.t.l. &nbsp;&nbsp;&nbsp;Text <i>t</i> is literal.<br>
<tt><font size=+1>.LP </font></tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;yes  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Same as <tt><font size=+1>.PP</font></tt>.<br>
<tt><font size=+1>.LR</font></tt> <i>t </i>&nbsp;&nbsp;&nbsp;no  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Join 2 words of <i>t</i> alternating literal and Roman.<br>
<tt><font size=+1>.PD</font></tt> <i>d </i>&nbsp;&nbsp;&nbsp;no 
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
<tt><font size=+1>&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;</font></tt><i>d</i>=<tt><font size=+1>.4v </font></tt>&nbsp;&nbsp;&nbsp;Interparagraph distance is <i>d</i>.<br>
<tt><font size=+1>.PP </font></tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;yes  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Begin paragraph. Set prevailing indent to default.<br>
<tt><font size=+1>.RE </font></tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;yes  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;End of relative indent. Set prevailing indent to amount
of starting <tt><font size=+1>.RS</font></tt>.<br>
<tt><font size=+1>.RI</font></tt> <i>t </i>&nbsp;&nbsp;&nbsp;no 
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
<tt><font size=+1>&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;</font></tt><i>t</i>=n.t.l. &nbsp;&nbsp;&nbsp;Join words of <i>t</i> alternating Roman and italic.<br>
<tt><font size=+1>.RL</font></tt> <i>t </i>&nbsp;&nbsp;&nbsp;no  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Join 2 or 3 words of <i>t</i> alternating Roman and literal.<br>
<tt><font size=+1>.RS</font></tt> <i>i </i>&nbsp;&nbsp;&nbsp;yes 
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
<tt><font size=+1>&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;</font></tt><i>i</i>=p.i. &nbsp;&nbsp;&nbsp;&nbsp;Start relative indent, move left margin in distance <i>i</i>.
Set prevailing indent to default for nested indents.<br>
<tt><font size=+1>.SH</font></tt> <i>t </i>&nbsp;&nbsp;&nbsp;yes 
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
<tt><font size=+1>&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;</font></tt><i>t</i>=&quot;&quot; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Subhead; reset paragraph distance.<br>
<tt><font size=+1>.SM</font></tt> <i>t </i>&nbsp;&nbsp;&nbsp;no 
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
<tt><font size=+1>&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;</font></tt><i>t</i>=n.t.l. &nbsp;&nbsp;&nbsp;Text <i>t</i> is small.<br>
<tt><font size=+1>.SS</font></tt> <i>t </i>&nbsp;&nbsp;&nbsp;no 
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
<tt><font size=+1>&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;</font></tt><i>t</i>=&quot;&quot; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Secondary subhead.<br>
<tt><font size=+1>.TF</font></tt> <i>s </i>&nbsp;&nbsp;&nbsp;yes  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Prevailing indent is wide as string <i>s</i> in font <tt><font size=+1>L</font></tt>; paragraph
distance is 0.<br>
<tt><font size=+1>.TH</font></tt> <i>n c x </i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;yes &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Begin page named <i>n</i> of chapter <i>c;</i> <i>x</i> is extra commentary,
e.g. &#8216;local&#8217;, for page head. Set prevailing indent and tabs to
default.<br>
<tt><font size=+1>.TP</font></tt> <i>i </i>&nbsp;&nbsp;&nbsp;yes 
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
<tt><font size=+1>&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
&#60094;</font></tt><i>i</i>=p.i. &nbsp;&nbsp;&nbsp;&nbsp;Set prevailing indent to <i>i</i>. Restore default indent if
<i>i</i>=0. Begin indented paragraph with hanging tag given by next text
line. If tag doesn&#8217;t fit, place it on separate line.<br>
<tt><font size=+1>.1C </font></tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;yes  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Equalize columns and return to 1-column output<br>
<tt><font size=+1>.2C </font></tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;yes  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Start 2-column nofill output 
<table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>

* n.t.l. = next text line; p.i. = prevailing indent<br>
<p><font size=+1><b>BUGS     </b></font><br>

<table border=0 cellpadding=0 cellspacing=0><tr height=2><td><tr><td width=20><td>

    There&#8217;s no way to fool <i>troff</i> into handling literal double quote
    marks <tt><font size=+1>&quot;</font></tt> in font-alternation macros, such as <tt><font size=+1>.BI</font></tt>. 
    <table border=0 cellpadding=0 cellspacing=0><tr height=5><td></table>
    
    There is no direct way to suppress column widows in 2-column output;
    the column lengths may be adjusted by inserting <tt><font size=+1>.sp</font></tt> requests before
    the closing <tt><font size=+1>.1C</font></tt>.<br>
    
</table>

<td width=20>
<tr height=20><td>
</table>
<!-- TRAILER -->
<table border=0 cellpadding=0 cellspacing=0 width=100%>
<tr height=15><td width=10><td><td width=10>
<tr><td><td>
<center>
<a href="../../"><img src="../../dist/spaceglenda100.png" alt="Space Glenda" border=1></a>
</center>
</table>
<!-- TRAILER -->
</body></html>