* doc/groff.texinfo: Further checking/updating. Adding more index entries.
[s-roff.git] / tmac / doc-common
blob1be195979fa0c07524834453cbd03d0e314afc55
1 .\" Copyright (c) 1991 The Regents of the University of California.
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)doc-common  5.7 (Berkeley) 8/5/91
33 .\"
34 .\"     %beginstrip%
35 .nr %A 1
36 .nr %J 1
37 .nr %N 1
38 .nr %O 1
39 .nr %R 1
40 .nr %T 1
41 .nr %V 1
42 .nr Ad 12n
43 .nr Ac 3
44 .nr Ao 12n
45 .nr Ap 2
46 .nr An 12n
47 .nr Aq 12n
48 .nr Ar 12n
49 .nr Bc 3
50 .nr Bl 1
51 .nr Bo 12n
52 .nr Bq 12n
53 .nr Bx 12n
54 .nr Cd 12n
55 .nr Cm 10n
56 .nr Co 15n
57 .nr Cx 20n
58 .nr Dc 3
59 .nr Do 10n
60 .nr Dq 12n
61 .nr Ds 6n
62 .nr Dq 12n
63 .nr Dv 12n
64 .nr tI \n(Dsu
65 .nr Ec 3
66 .nr El 1
67 .nr Eo 12n
68 .nr Eq 12n
69 .nr Em 10n
70 .nr Er 12n
71 .nr Ev 15n
72 .nr Ex 10n
73 .nr Fa 12n
74 .nr Fl 10n
75 .nr Fc 3
76 .nr Fo 16n
77 .nr Fn 16n
78 .nr Hl 1
79 .nr I1 6n
80 .nr I2 12n
81 .nr I3 18n
82 .nr Ic 10n
83 .nr Li 16n
84 .nr Ms 6n
85 .nr Nm 10n
86 .nr No 12n
87 .nr Ns 2
88 .nr Oo 10n
89 .nr Oc 3
90 .nr Op 14n
91 .nr Pa 32n
92 .nr Pf 12n
93 .nr Pc 3
94 .nr Po 12n
95 .nr Pq 12n
96 .nr Ql 16n
97 .nr Qc 3
98 .nr Qo 12n
99 .nr Qq 12n
100 .nr Sc 3
101 .nr So 12n
102 .nr Sq 12n
103 .nr Sy 6n
104 .nr Sx 16n
105 .nr Ra 1
106 .nr Rj 1
107 .nr Rn 1
108 .nr Ro 1
109 .nr Rr 1
110 .nr Rt 1
111 .nr Rv 1
112 .nr Tn 10n
113 .nr Ta 1
114 .nr Tv 1
115 .nr Tx 22n
116 .nr Ux 10n
117 .nr Va 12n
118 .nr Xc 3
119 .nr Xo 1
120 .nr Xr 10n
121 .nr Yr \n(yr+1900
122 .ds sV \& \&
123 .ds hV \&\ \&
124 .ds iV \& \&
125 .ds tV \&\\t\&
126 .\" Punctuation values (3 = closing punctuation, 4 = opening)
127 .nr z. 3
128 .nr z, 3
129 .nr z: 3
130 .nr z; 3
131 .nr z( 4
132 .nr z) 3
133 .nr z[ 4
134 .nr z] 3
135 .\" Matching pairs
136 .ds z( z)
137 .ds z[ z]
138 .ds z< z>
139 .\" This is disgusting, troff not parse ``if'' stmt properly
140 .nr z0 0
141 .nr z1 0
142 .nr z2 0
143 .nr z3 0
144 .nr z4 0
145 .nr z5 0
146 .nr z6 0
147 .nr z7 0
148 .nr z8 0
149 .nr z9 0
150 .nr z# 0
151 .\" Header assembly macros
152 .de Dt
153 .ds dT UNTITLED
154 .ds vT LOCAL
155 .ds cH Null
156 .if !"\\$1"" .ds dT \\$1
157 .if !"\\$2"" \{\
158 .       ds cH \\$2
159 .\" .   if "\\$3"" \{\
160 .               if \\$2>=1 .if \\$2<=8 \{\
161 .                       ds vT System Reference Manual
162 .                       if \\$2>1 .if \\$2<6 .ds vT System Programmer's Manual
163 .                       if "\\$2"8" .ds vT System Manager's Manual
164 .                       nr sN \\$2
165 .               \}
166 .               if "\\$2"unass"  .ds vT DRAFT
167 .               if "\\$2"draft"  .ds vT DRAFT
168 .               if "\\$2"paper"  .ds vT UNTITLED
169 .\" .   \}
171 .if !"\\$3"" \{\
172 .       if "\\$3"USD"   .ds vT User's Supplementary Documents
173 .       if "\\$3"PS1"   .ds vT Programmers's Supplementary Documents
174 .       if "\\$3"AMD"   .ds vT Ancestral Manual Documents
175 .       if "\\$3"SMM"   .ds vT System Manager's Manual
176 .       if "\\$3"URM"   .ds vT Reference Manual
177 .       if "\\$3"PRM"   .ds vT Programmers's Manual
178 .       if "\\$3"IND"   .ds vT Manual Master Index
179 .\" .   if "\\$3"CON"   .ds vT Contributed Software Manual
180 .\" .   if "\\$3"IMP"   .ds vT Implementation Notes
181 .\" .   if "\\$3"HOW"   .ds vT How Pocket Manual
182 .       if "\\$3"LOCAL" .ds vT Local Manual
183 .       if "\\$3"tahoe" .as vT \ (Tahoe Architecture)
184 .       if "\\$3"vax" .as vT \ (VAX Architecture)
185 .       if "\\$3"hp300" .as vT \ (HP300 Architecture)
186 .       if "\\*(vT"LOCAL" .ds vT \\$3
189 .\" NS Os macro - Operating System (behaviour changes after first call)
190 .\" .   ds vT \f(CODRAFT\fP\ \ \-\-\ \ \\*(vT\ \ \-\-\ \ \f(CODRAFT
191 .\" .   ds dD \f(CODRAFT\fP\ \ \-\-\ \ \\*(dD\ \ \-\-\ \ \f(CODRAFT
192 .\" .ds vT \s+4\f(CODRAFT\fP\s-4\ \ \-\-\ \ \\*(vT\ \ \-\-\ \ \s+4\f(CODRAFT\s-4
193 .\" .ds dD \s+4\f(CODRAFT\fP\s-4\ \ \-\-\ \ \\*(dD\ \ \-\-\ \ \s+4\f(CODRAFT\s-4
194 .de Os
195 .ds oS Null
196 .if "\\$1"" \{\
197 .       ds oS BSD Experimental
199 .if "\\$2"" \{\
200 .       ds aa Non-Null
202 .if "\\$1"ATT"   \{\
203 .       ds oS AT&T
204 .       if "\\$2""    .as oS \0UNIX
205 .       if "\\$2"7th" .as oS \07th Edition
206 .       if "\\$2"7"   .as oS \07th Edition
207 .       if "\\$2"III" .as oS \0System III
208 .       if "\\$2"3"   .as oS \0System III
209 .       if "\\$2"V"   .as oS \0System V
210 .       if "\\$2"V.2" .as oS \0System V Release 2
211 .       if "\\$2"V.3" .as oS \0System V Release 3
212 .       if "\\$2"V.4" .as oS \0System V Release 4
214 .if "\\$1"BSD" \{\
215 .       if "\\$2"3"    .ds oS 3rd Berkeley Distribution
216 .       if "\\$2"4"    .ds oS 4th Berkeley Distribution
217 .       if "\\$2"4.1"  .ds oS 4.1 Berkeley Distribution
218 .       if "\\$2"4.2"  .ds oS 4.2 Berkeley Distribution
219 .       if "\\$2"4.3"  .ds oS 4.3 Berkeley Distribution
220 .       if "\\$2"4.3T" .ds oS 4.3-Tahoe Berkeley Distribution
221 .       if "\\$2"4.3R" .ds oS 4.3-Reno Berkeley Distribution
222 .       if "\\$2"4.3t" .ds oS 4.3-Tahoe Berkeley Distribution
223 .       if "\\$2"4.3r" .ds oS 4.3-Reno Berkeley Distribution
224 .       if "\\$2"4.4"  .ds oS BSD Experimental
226 .if "\\*(oS"Null" .ds oS \0\\$1
227 .if "\\*(aa"Non-Null" .as oS \0\\$2
228 .rm aa
230 .de Dd
231 .if !"\\*(dD"" .nr gX 1
232 .ie \\n(.$>0 \{\
233 .       ie \\n(.$==3 \{\
234 .               ds dD \\$1 \\$2 \\$3
235 .       \}
236 .       el \{\
237 .               if "\\n(mo"1"  .ds dD January
238 .               if "\\n(mo"2"  .ds dD February
239 .               if "\\n(mo"3"  .ds dD March
240 .               if "\\n(mo"4"  .ds dD April
241 .               if "\\n(mo"5"  .ds dD May
242 .               if "\\n(mo"6"  .ds dD June
243 .               if "\\n(mo"7"  .ds dD July
244 .               if "\\n(mo"8"  .ds dD August
245 .               if "\\n(mo"9"  .ds dD September
246 .               if "\\n(mo"10" .ds dD October
247 .               if "\\n(mo"11" .ds dD November
248 .               if "\\n(mo"12" .ds dD December
249 .               as dD \&\ \\n(dy, \\n(Yr
250 .       \}
252 .el \{\
253 .       ds dD Epoch
256 .de hM
257 .ev 1
259 .if !\\n(cR 'sp \\n(Hmu
260 .tl @\\*(Hs\\*(hT\fP@\\*(Vs\\*(vT\fP@\\*(Hs\\*(hT\fP@
261 'sp \\n(Hmu
264 .de fM
265 .ie \\n(cR 'br
266 .el \{\
267 .       ev 1
268 .       pL
269 .       if !\\n(cR \{\
270 '               sp \\n(Fmu
271 .               tl @\\*(Hs\\*(oS\fP@\\*(Vs\\*(dD\fP@%@
272 '               bp
273 .       \}
274 .       ev
276 .\" .tm IN 444 fM .k == \\n(.k and nl == \\n(nl
278 .de lM
280 .if \\n(cR \{\
281 '       sp
282 .       tl @\\*(Hs\\*(oS\fP@\\*(Vs\\*(dD\fP@%@
283 .       pl \\n(nlu
286 .de Pp
287 .sp \\n(Ppu
288 .ne 2
291 .de Lp
294 .de LP
295 .tm Not a \-mdoc command: .LP
297 .de PP
298 .tm Not a \-mdoc command: .PP
300 .de pp
301 .tm Not a \-mdoc command: .pp
303 .de Nd
304 \&\-\& \\$1 \\$2 \\$3 \\$4 \\$5 \\$6 \\$7 \\$8 \\$9
306 .de Ss
308 .ne 2
309 .ti -.25i
310 \&\\*(sH\\$1 \|\\$2 \|\\$3 \|\\$4 \|\\$5 \|\\$6 \|\\$7 \|\\$8 \|\\$9
311 \&\fP\s0
312 .ta .5i 1i 1.5i 2i 2.5i 3i 3.5i 4i 4.5i 5i 5.5i 6i 6.5i
313 .if !\\n(cR .ne 2
316 .de Rd
317 .tm MDOC REGISTER DUMP
318 .tm Db==\\n(Db register DEBUG MODE
319 .tm L[0-9] registers - stack of list types
320 .tm L0==\\n(L0
321 .tm L1==\\n(L1
322 .tm L2==\\n(L2
323 .tm L3==\\n(L3
324 .tm L4==\\n(L4
325 .tm L5==\\n(L5
326 .tm L6==\\n(L6
327 .tm L7==\\n(L7
328 .tm L8==\\n(L8
329 .tm L9==\\n(L9
330 .tm O[0-9] registers - stack of indent
331 .tm O0==\\n(O0
332 .tm O1==\\n(O1
333 .tm O2==\\n(O2
334 .tm O3==\\n(O3
335 .tm O4==\\n(O4
336 .tm O5==\\n(O5
337 .tm O6==\\n(O6
338 .tm O7==\\n(O7
339 .tm O8==\\n(O8
340 .tm O9==\\n(O9
341 .tm aC==\\n(aC register argument counter (aV/fV)
342 .tm aJ==\\n(aJ register (for vR)
343 .tm aN==\\n(aN register
344 .tm aP==\\n(aP register argument pointer (aV)
345 .tm aT==\\n(aT register argument type
346 .tm aa==\\n(aa local register
347 .tm bK==\\n(bK register - Book Name flag
348 .tm cF==\\n(cF register save current font
349 .tm cI==\\n(cI register - column indent width
350 .tm cZ==\\n(cZ register save current font size
351 .tm dK==\\n(dK register - Date flag
352 .tm d[0-9] registers - display-type stack
353 .tm d0==\\n(d0
354 .tm d1==\\n(d1
355 .tm d2==\\n(d2
356 .tm d3==\\n(d3
357 .tm d4==\\n(d4
358 .tm d5==\\n(d5
359 .tm d6==\\n(d6
360 .tm d7==\\n(d7
361 .tm d8==\\n(d8
362 .tm d9==\\n(d9
363 .tm dZ==\\n(dZ register diversion count
364 .tm fD==\\n(fD register subroutine test (in synopsis only)
365 .tm fV==\\n(fV register argument counter (must set to \\n(.$ prior to
366 .tm fY==\\n(fY register - dick with old style function declarations (fortran)
367 .tm fZ==\\n(fZ register also subroutine count (in synopsis only)
368 .tm h[0-9] register horizontal tag stack (continuous if 1, break if
369 .tm h0==\\n(h0
370 .tm h1==\\n(h1
371 .tm h2==\\n(h2
372 .tm h3==\\n(h3
373 .tm h4==\\n(h4
374 .tm h5==\\n(h5
375 .tm h6==\\n(h6
376 .tm h7==\\n(h7
377 .tm h8==\\n(h8
378 .tm h9==\\n(h9
379 .tm iD==\\n(iD local register
380 .tm iI==\\n(iI local register (indent for inline debug mode)
381 .tm iN==\\n(iN register DEBUG MODE (inline if 1, to stderr if
382 .tm iS==\\n(iS register - indent second command line in a synopsis
383 .tm jK==\\n(jK register - [reference] Journal Name flag
384 .tm jM==\\n(jM local register
385 .tm jN==\\n(jN local register
386 .tm lC==\\n(lC register - list type stack counter
387 .tm lK==\\n(lK register count of lines read from input file
388 .tm nK==\\n(nK register - [reference] issue number flag
389 .tm nU==\\n(nU register count
390 .tm oK==\\n(oK register - [reference] optional information flag
391 .tm oM==\\n(oM register (extension possible)
392 .tm o[0-9] register offset stack (nested tags)
393 .tm o0==\\n(o0
394 .tm o1==\\n(o1
395 .tm o2==\\n(o2
396 .tm o3==\\n(o3
397 .tm o4==\\n(o4
398 .tm o5==\\n(o5
399 .tm o6==\\n(o6
400 .tm o7==\\n(o7
401 .tm o8==\\n(o8
402 .tm o9==\\n(o9
403 .tm oM==\\n(oM register open ended line flag
404 .tm pK==\\n(pK register - [reference] page number flag
405 .tm qK==\\n(qK register - Corporate or Foreign Author flag
406 .tm rK==\\n(rK register - [reference] report flag
407 .tm rS==\\n(rS register - Reference Start flag
408 .tm sM==\\n(sM register - default is one (space mode on)
409 .tm tK==\\n(tK register - reference title flag
410 .tm tP==\\n(tP register tag flag (for diversions)
411 .tm tX==\\n(tX register (initial class)
412 .tm tY==\\n(tY register (next possible lC value)
413 .tm t[0-9] register tag string stack (nested tags)
414 .tm t0==\\n(t0
415 .tm t1==\\n(t1
416 .tm t2==\\n(t2
417 .tm t3==\\n(t3
418 .tm t4==\\n(t4
419 .tm t5==\\n(t5
420 .tm t6==\\n(t6
421 .tm t7==\\n(t7
422 .tm t8==\\n(t8
423 .tm t9==\\n(t9
424 .tm uK==\\n(uK register - reference author(s) counter
425 .tm vK==\\n(vK register - reference volume flag
426 .tm v[0-9] register vertical tag break stack
427 .tm v0==\\n(v0
428 .tm v1==\\n(v1
429 .tm v2==\\n(v2
430 .tm v3==\\n(v3
431 .tm v4==\\n(v4
432 .tm v5==\\n(v5
433 .tm v6==\\n(v6
434 .tm v7==\\n(v7
435 .tm v8==\\n(v8
436 .tm v9==\\n(v9
437 .tm w[0-9] register tag stack (nested tags)
438 .tm w0==\\n(w0
439 .tm w1==\\n(w1
440 .tm w2==\\n(w2
441 .tm w3==\\n(w3
442 .tm w4==\\n(w4
443 .tm w5==\\n(w5
444 .tm w6==\\n(w6
445 .tm w7==\\n(w7
446 .tm w8==\\n(w8
447 .tm w9==\\n(w9
448 .tm xX==\\n(xX local register
449 .tm END OF REGISTER DUMP