| blob | 38f13807bf00242a7c4c1b9c2a54347444aae6c3 |
1 .\" Copyright (c) 1991, 1993
2 .\" The Regents of the University of California. 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 8.1 (Berkeley) 06/08/93
33 .\"
34 .\" %beginstrip%
35 .
36 .
37 .\" Macro Identifiers. For each user macro a corresponding register with
38 .\" the same name must exist. Its value must not be zero.
39 .
40 .nr %A 1
41 .nr %B 1
42 .nr %D 1
43 .nr %I 1
44 .nr %J 1
45 .nr %N 1
46 .nr %O 1
47 .nr %P 1
48 .nr %Q 1
49 .nr %R 1
50 .nr %T 1
51 .nr %V 1
52 .nr Ac 3
53 .nr Ad 12n
54 .nr An 12n
55 .nr Ao 12n
56 .nr Ap 2
57 .nr Aq 12n
58 .nr Ar 12n
59 .nr At 1
60 .nr Bc 3
61 .nr Bf 8n\" ?
62 .nr Bk 8n\" ?
63 .nr Bl 1
64 .nr Bo 12n
65 .nr Bq 12n
66 .nr Brc 3
67 .nr Bro 12n
68 .nr Brq 12n
69 .nr Bsx 1
70 .nr Bt 8n\" ?
71 .nr Bx 1
72 .nr Cd 12n
73 .nr Cm 10n
74 .nr D1 8n\" ?
75 .nr Dc 3
76 .nr Dl 8n\" ?
77 .nr Dt 8n\" ?
78 .nr Do 12n
79 .nr Dq 12n
80 .nr Ds 6n\" many manpages still use this as a -width value
81 .nr Dv 12n
82 .nr Ec 3
83 .nr Ef 8n\" ?
84 .nr Ek 8n\" ?
85 .nr El 1
86 .nr Em 10n
87 .nr En 12n
88 .nr Eo 12n
89 .nr Eq 12n
90 .nr Er 17n
91 .nr Es 12n
92 .nr Ev 15n
93 .nr Ex 1
94 .nr Fa 12n
95 .nr Fc 3
96 .nr Fd 12n\" ?
97 .nr Fl 10n
98 .nr Fn 16n
99 .nr Fo 16n
100 .nr Fr 12n\" ?
101 .nr Ft 8n\" ?
102 .nr Fx 1
103 .nr Ic 10n
104 .nr In 12n
105 .nr It 8n\" ?
106 .nr Lb 11n
107 .nr Li 16n
108 .nr Lk 6n\" ?
109 .nr Lp 8n\" ?
110 .nr Me 6n
111 .nr Ms 6n
112 .nr Mt 6n\" ?
113 .nr Nd 8n\" ?
114 .nr Nm 10n
115 .nr No 12n
116 .nr Ns 2
117 .nr Nx 1
118 .nr Oc 3
119 .nr Oo 10n
120 .nr Op 14n
121 .nr Os 6n\" ?
122 .nr Ox 1
123 .nr Pa 32n
124 .nr Pc 3
125 .nr Pf 12n
126 .nr Po 12n
127 .nr Pp 8n\" ?
128 .nr Pq 12n
129 .nr Qc 3
130 .nr Ql 16n
131 .nr Qo 12n
132 .nr Qq 12n
133 .nr Rv 1
134 .nr Sc 3
135 .nr Sh 8n
136 .nr Sm 8n\" ?
137 .nr So 12n
138 .nr Sq 12n
139 .nr Ss 8n
140 .nr St 8n\" ?
141 .nr Sx 16n
142 .nr Sy 6n
143 .nr Ta 2
144 .nr Tn 10n
145 .nr Ud 8n\" ?
146 .nr Ux 1
147 .nr Va 12n
148 .nr Vt 8n\" ?
149 .nr Xc 3
150 .nr Xo 1
151 .nr Xr 10n
152 .
153 .
154 .\" macros which must be processed after the closing delimiter of `Op'
155 .\" and friends
156 .ds doc-after-Ao
157 .ds doc-after-Bo
158 .ds doc-after-Bro
159 .ds doc-after-Do
160 .ds doc-after-Eo
161 .ds doc-after-Fo
162 .ds doc-after-Ns
163 .ds doc-after-Oo
164 .ds doc-after-Po
165 .ds doc-after-Qo
166 .ds doc-after-So
167 .ds doc-after-Xo
168 .
169 .
170 .nr doc-display-indent 6n
171 .
172 .
173 .\" space strings
174 .
175 .ds doc-soft-space " \"
176 .ds doc-hard-space \~
177 .ds doc-tab \t
178 .
179 .
180 .eo
181 .
182 .
183 .\" punctuation values (suffix=3, prefix=4)
184 .
185 .nr doc-punct. 3
186 .nr doc-punct, 3
187 .nr doc-punct: 3
188 .nr doc-punct; 3
189 .nr doc-punct( 4
190 .nr doc-punct) 3
191 .nr doc-punct[ 4
192 .nr doc-punct] 3
193 .nr doc-punct? 3
194 .nr doc-punct! 3
195 .
196 .
197 .\" header assembly macros
198 .
199 .\" NS doc-document-title global string
200 .\" NS the title of the manual page
201 .
202 .ds doc-document-title UNTITLED
203 .
204 .
205 .\" NS doc-volume global string
206 .\" NS the volume where the manual page belongs to
207 .
208 .ds doc-volume LOCAL
209 .
210 .
211 .\" NS doc-section global string
212 .\" NS the manual section
213 .
214 .ds doc-section Null
215 .
216 .
217 .\" NS Dt user macro (not parsed, not callable)
218 .\" NS document title
219 .\" NS
220 .\" NS modifies:
221 .\" NS doc-document-title
222 .\" NS doc-section
223 .\" NS doc-volume
224 .\" NS
225 .\" NS local variables:
226 .\" NS doc-volume-as-XXX
227 .\" NS doc-volume-ds-XXX
228 .\" NS
229 .\" NS width register `Dt' set above
230 .
231 .\" an alternative, more detailed scheme for naming the manual sections
232 .\"
233 .ds doc-volume-operating-system BSD
234 .nr doc-volume-operating-system-ateol 0
235 .ds doc-volume-ds-1 General Commands Manual
236 .ds doc-volume-ds-2 System Calls Manual
237 .ds doc-volume-ds-3 Library Functions Manual
238 .ds doc-volume-ds-4 Kernel Interfaces Manual
239 .ds doc-volume-ds-5 File Formats Manual
240 .ds doc-volume-ds-6 Games Manual
241 .ds doc-volume-ds-7 Miscellaneous Information Manual
242 .ds doc-volume-ds-8 System Manager's Manual
243 .ds doc-volume-ds-9 Kernel Developer's Manual
244 .
245 .ds doc-volume-ds-USD User's Supplementary Documents
246 .ds doc-volume-ds-PS1 Programmer's Supplementary Documents
247 .ds doc-volume-ds-AMD Ancestral Manual Documents
248 .ds doc-volume-ds-SMM System Manager's Manual
249 .ds doc-volume-ds-URM User's Reference Manual
250 .ds doc-volume-ds-PRM Programmer's Manual
251 .ds doc-volume-ds-KM Kernel Manual
252 .ds doc-volume-ds-IND Manual Master Index
253 .ds doc-volume-ds-LOCAL Local Manual
254 .ds doc-volume-ds-CON Contributed Software Manual
255 .
256 .als doc-volume-ds-MMI doc-volume-ds-IND
257 .als doc-volume-ds-LOC doc-volume-ds-LOCAL
258 .
259 .ds doc-volume-as-alpha alpha
260 .als doc-volume-as-Alpha doc-volume-as-alpha
261 .ds doc-volume-as-acorn26 acorn26
262 .ds doc-volume-as-acorn32 acorn32
263 .ds doc-volume-as-algor algor
264 .ds doc-volume-as-amd64 amd64
265 .ds doc-volume-as-amiga amiga
266 .ds doc-volume-as-arc arc
267 .ds doc-volume-as-arm26 arm26
268 .ds doc-volume-as-arm32 arm32
269 .ds doc-volume-as-atari atari
270 .ds doc-volume-as-bebox bebox
271 .ds doc-volume-as-cats cats
272 .ds doc-volume-as-cesfic cesfic
273 .ds doc-volume-as-cobalt cobalt
274 .ds doc-volume-as-dreamcast dreamcast
275 .ds doc-volume-as-evbarm evbarm
276 .ds doc-volume-as-evbmips evbmips
277 .ds doc-volume-as-evbppc evbppc
278 .ds doc-volume-as-evbsh3 evbsh3
279 .ds doc-volume-as-hp300 hp300
280 .ds doc-volume-as-hp700 hp700
281 .ds doc-volume-as-hpcarm hpcarm
282 .ds doc-volume-as-hpcmips hpcmips
283 .ds doc-volume-as-hpcsh hpcsh
284 .ds doc-volume-as-i386 i386
285 .ds doc-volume-as-luna68k luna68k
286 .ds doc-volume-as-m68k m68k
287 .ds doc-volume-as-mac68k mac68k
288 .ds doc-volume-as-macppc macppc
289 .ds doc-volume-as-mips mips
290 .ds doc-volume-as-mipsco mipsco
291 .ds doc-volume-as-mmeye mmeye
292 .ds doc-volume-as-mvme68k mvme68k
293 .ds doc-volume-as-mvmeppc mvmeppc
294 .ds doc-volume-as-netwinder netwinder
295 .ds doc-volume-as-news68k news68k
296 .ds doc-volume-as-newsmips newsmips
297 .ds doc-volume-as-next68k next68k
298 .ds doc-volume-as-ofppc ofppc
299 .ds doc-volume-as-pc532 pc532
300 .ds doc-volume-as-playstation2 playstation2
301 .ds doc-volume-as-pmax pmax
302 .ds doc-volume-as-pmppc pmppc
303 .ds doc-volume-as-powerpc powerpc
304 .ds doc-volume-as-prep prep
305 .ds doc-volume-as-sandpoint sandpoint
306 .ds doc-volume-as-sbmips sbmips
307 .ds doc-volume-as-sgimips sgimips
308 .ds doc-volume-as-sh3 sh3
309 .ds doc-volume-as-shark shark
310 .ds doc-volume-as-sparc sparc
311 .ds doc-volume-as-sparc64 sparc64
312 .ds doc-volume-as-sun2 sun2
313 .ds doc-volume-as-sun3 sun3
314 .ds doc-volume-as-tahoe tahoe
315 .ds doc-volume-as-vax vax
316 .ds doc-volume-as-x68k x68k
317 .ds doc-volume-as-x86_64 x86_64
318 .
319 .de Dt
320 . \" reset default arguments
321 . ds doc-document-title UNTITLED
322 . ds doc-volume LOCAL
323 . ds doc-section Null
324 .
325 . if !"\$1"" \
326 . ds doc-document-title "\$1
327 .
328 . if !"\$2"" \{\
329 . ds doc-section \$2
331 . if ((\$2 >= 1) & (\$2 <= 9)) \{\
332 . ie \n[doc-volume-operating-system-ateol] \{\
333 . ds doc-volume "\*[doc-volume-ds-\$2] \*[doc-volume-operating-system]
335 . if d doc-volume-as-\$3 \
336 . as doc-volume "/\*[doc-volume-as-\$3]
337 . \}\}
338 . el \{\
339 . ds doc-volume "\*[doc-volume-operating-system]
341 . if d doc-volume-as-\$3 \
342 . as doc-volume "/\*[doc-volume-as-\$3]
343 . \}
344 . as doc-volume " \*[doc-volume-ds-\$2]
345 . \}\}\}
346 . el \{\
347 . ie "\$2"unass" \
348 . ds doc-volume DRAFT
349 . el \{ .ie "\$2"draft" \
350 . ds doc-volume DRAFT
351 . el .if "\$2"paper" \
352 . ds doc-volume UNTITLED
353 . \}\}
355 . if d doc-volume-ds-\$3 \
356 . ds doc-volume "\*[doc-volume-ds-\$3]
357 . \}\}\}
358 .
359 . if !"\$3"" \
360 . if "\*[doc-volume]"LOCAL" \
361 . ds doc-volume \$3
362 ..
363 .
364 .
365 .\" NS doc-default-operating-system global string
366 .\" NS the exact (default) version of the operating system
367 .\" NS
368 .\" NS override this in `mdoc.local', if necessary
369 .
370 .ds doc-default-operating-system BSD
371 .
372 .
373 .\" NS doc-operating-system global string
374 .\" NS the exact version of the operating system
375 .
376 .ds doc-operating-system
377 .
378 .
379 .\" NS Os user macro (not parsed, not callable)
380 .\" NS operating system
381 .\" NS
382 .\" NS modifies:
383 .\" NS doc-operating-system
384 .\" NS
385 .\" NS local variables:
386 .\" NS doc-operating-system-XXX-XXX
387 .\" NS
388 .\" NS width register `Os' set above
389 .
390 .ds doc-operating-system-ATT-7 7th\~Edition
391 .als doc-operating-system-ATT-7th doc-operating-system-ATT-7
392 .ds doc-operating-system-ATT-3 System\~III
393 .als doc-operating-system-ATT-III doc-operating-system-ATT-3
394 .ds doc-operating-system-ATT-V System\~V
395 .ds doc-operating-system-ATT-V.2 System\~V Release\~2
396 .ds doc-operating-system-ATT-V.3 System\~V Release\~3
397 .ds doc-operating-system-ATT-V.4 System\~V Release\~4
398 .
399 .ds doc-operating-system-BSD-3 3rd\~Berkeley Distribution
400 .ds doc-operating-system-BSD-4 4th\~Berkeley Distribution
401 .ds doc-operating-system-BSD-4.1 4.1\~Berkeley Distribution
402 .ds doc-operating-system-BSD-4.2 4.2\~Berkeley Distribution
403 .ds doc-operating-system-BSD-4.3 4.3\~Berkeley Distribution
404 .ds doc-operating-system-BSD-4.3T 4.3-Tahoe Berkeley Distribution
405 .ds doc-operating-system-BSD-4.3R 4.3-Reno Berkeley Distribution
406 .als doc-operating-system-BSD-4.3t doc-operating-system-BSD-4.3T
407 .als doc-operating-system-BSD-4.3r doc-operating-system-BSD-4.3R
408 .ds doc-operating-system-BSD-4.4 4.4BSD
409 .
410 .ds doc-operating-system-NetBSD-0.8 0.8
411 .ds doc-operating-system-NetBSD-0.8a 0.8A
412 .ds doc-operating-system-NetBSD-0.9 0.9
413 .ds doc-operating-system-NetBSD-0.9a 0.9A
414 .ds doc-operating-system-NetBSD-1.0 1.0
415 .ds doc-operating-system-NetBSD-1.0a 1.0A
416 .ds doc-operating-system-NetBSD-1.1 1.1
417 .ds doc-operating-system-NetBSD-1.2 1.2
418 .ds doc-operating-system-NetBSD-1.2a 1.2A
419 .ds doc-operating-system-NetBSD-1.2b 1.2B
420 .ds doc-operating-system-NetBSD-1.2c 1.2C
421 .ds doc-operating-system-NetBSD-1.2d 1.2D
422 .ds doc-operating-system-NetBSD-1.2e 1.2E
423 .ds doc-operating-system-NetBSD-1.3 1.3
424 .ds doc-operating-system-NetBSD-1.3a 1.3A
425 .ds doc-operating-system-NetBSD-1.4 1.4
426 .ds doc-operating-system-NetBSD-1.4.1 1.4.1
427 .ds doc-operating-system-NetBSD-1.4.2 1.4.2
428 .ds doc-operating-system-NetBSD-1.4.3 1.4.3
429 .ds doc-operating-system-NetBSD-1.5 1.5
430 .ds doc-operating-system-NetBSD-1.5.1 1.5.1
431 .ds doc-operating-system-NetBSD-1.5.2 1.5.2
432 .ds doc-operating-system-NetBSD-1.5.3 1.5.3
433 .ds doc-operating-system-NetBSD-1.6 1.6
434 .ds doc-operating-system-NetBSD-1.6.1 1.6.1
435 .ds doc-operating-system-NetBSD-1.6.2 1.6.2
436 .ds doc-operating-system-NetBSD-2.0 2.0
437 .ds doc-operating-system-NetBSD-2.1 2.1
438 .
439 .ds doc-operating-system-FreeBSD-1.0 1.0
440 .ds doc-operating-system-FreeBSD-1.1 1.1
441 .ds doc-operating-system-FreeBSD-1.1.5 1.1.5
442 .ds doc-operating-system-FreeBSD-1.1.5.1 1.1.5.1
443 .ds doc-operating-system-FreeBSD-2.0 2.0
444 .ds doc-operating-system-FreeBSD-2.0.5 2.0.5
445 .ds doc-operating-system-FreeBSD-2.1 2.1
446 .ds doc-operating-system-FreeBSD-2.1.5 2.1.5
447 .ds doc-operating-system-FreeBSD-2.1.6 2.1.6
448 .ds doc-operating-system-FreeBSD-2.1.7 2.1.7
449 .ds doc-operating-system-FreeBSD-2.2 2.2
450 .ds doc-operating-system-FreeBSD-2.2.1 2.2.1
451 .ds doc-operating-system-FreeBSD-2.2.2 2.2.2
452 .ds doc-operating-system-FreeBSD-2.2.5 2.2.5
453 .ds doc-operating-system-FreeBSD-2.2.6 2.2.6
454 .ds doc-operating-system-FreeBSD-2.2.7 2.2.7
455 .ds doc-operating-system-FreeBSD-2.2.8 2.2.8
456 .ds doc-operating-system-FreeBSD-3.0 3.0
457 .ds doc-operating-system-FreeBSD-3.1 3.1
458 .ds doc-operating-system-FreeBSD-3.2 3.2
459 .ds doc-operating-system-FreeBSD-3.3 3.3
460 .ds doc-operating-system-FreeBSD-3.4 3.4
461 .ds doc-operating-system-FreeBSD-3.5 3.5
462 .ds doc-operating-system-FreeBSD-4.0 4.0
463 .ds doc-operating-system-FreeBSD-4.1 4.1
464 .ds doc-operating-system-FreeBSD-4.1.1 4.1.1
465 .ds doc-operating-system-FreeBSD-4.2 4.2
466 .ds doc-operating-system-FreeBSD-4.3 4.3
467 .ds doc-operating-system-FreeBSD-4.4 4.4
468 .ds doc-operating-system-FreeBSD-4.5 4.5
469 .ds doc-operating-system-FreeBSD-4.6 4.6
470 .ds doc-operating-system-FreeBSD-4.6.2 4.6.2
471 .ds doc-operating-system-FreeBSD-4.7 4.7
472 .ds doc-operating-system-FreeBSD-4.8 4.8
473 .ds doc-operating-system-FreeBSD-4.9 4.9
474 .ds doc-operating-system-FreeBSD-4.10 4.10
475 .ds doc-operating-system-FreeBSD-5.0 5.0
476 .ds doc-operating-system-FreeBSD-5.1 5.1
477 .ds doc-operating-system-FreeBSD-5.2 5.2
478 .ds doc-operating-system-FreeBSD-5.2.1 5.2.1
479 .ds doc-operating-system-FreeBSD-5.3 5.3
480 .
481 .de Os
482 . ie "\$1"" \
483 . ds doc-operating-system "\*[doc-default-operating-system]
484 . el \{ .ie "\$1"ATT" \{\
485 . ds doc-operating-system AT&T
487 . ie d doc-operating-system-ATT-\$2 \
488 . as doc-operating-system " \*[doc-operating-system-ATT-\$2]
489 . el \
490 . as doc-operating-system " UNIX
491 . \}\}
492 . el \{ .ie "\$1"BSD" \{\
494 . ie d doc-operating-system-BSD-\$2 \
495 . ds doc-operating-system "\*[doc-operating-system-BSD-\$2]
496 . el \
497 . tm mdoc warning: .Os: Unknown BSD version `\$2' (#\n[.c])
498 . \}\}
499 . el \{ .ie "\$1"FreeBSD" \{\
500 . ds doc-operating-system FreeBSD
502 . ie d doc-operating-system-FreeBSD-\$2 \
503 . as doc-operating-system \~\*[doc-operating-system-FreeBSD-\$2]
504 . el \
505 . tm mdoc warning: .Os: Unknown FreeBSD version `\$2' (#\n[.c])
506 . \}\}
507 . el \{ .ie "\$1"NetBSD" \{\
508 . ds doc-operating-system NetBSD
510 . ie d doc-operating-system-NetBSD-\$2 \
511 . as doc-operating-system \~\*[doc-operating-system-NetBSD-\$2]
512 . el \
513 . tm mdoc warning: .Os: Unknown NetBSD version `\$2' (#\n[.c])
514 . \}\}
515 . el \{\
516 . ds doc-operating-system \$1
517 . if !"\$2"" \
518 . as doc-operating-system " \$2
519 . \}\}\}\}\}
520 ..
521 .
522 .
523 .\" NS doc-date-string global string
524 .\" NS the manual page date as set by `Dd'
525 .
526 .ds doc-date-string
527 .
528 .
529 .\" NS Dd user macro (not parsed, not callable)
530 .\" NS set document date
531 .\" NS
532 .\" NS modifies:
533 .\" NS doc-date-string
534 .\" NS
535 .\" NS local variables:
536 .\" NS doc-date-XXX
537 .\" NS
538 .\" NS width register `Dd' set above
539 .
540 .ds doc-date-1 January
541 .ds doc-date-2 February
542 .ds doc-date-3 March
543 .ds doc-date-4 April
544 .ds doc-date-5 May
545 .ds doc-date-6 June
546 .ds doc-date-7 July
547 .ds doc-date-8 August
548 .ds doc-date-9 September
549 .ds doc-date-10 October
550 .ds doc-date-11 November
551 .ds doc-date-12 December
552 .
553 .de Dd
554 . ie \n[.$] \{\
555 . ie (\n[.$] == 3) \
556 . ds doc-date-string \$1\~\$2 \$3
557 . el \{\
558 . ds doc-date-string "\*[doc-date-\n[mo]]
559 . as doc-date-string \~\n[dy], \n[year]
560 . \}
561 . \}
562 . el \
563 . ds doc-date-string Epoch
564 ..
565 .
566 .
567 .\" NS doc-hyphen-flags global register
568 .\" NS the parameter for the `.hy' request
569 .\" NS
570 .\" NS override this in `mdoc.local', if necessary.
571 .
572 .nr doc-hyphen-flags 12
573 .
574 .
575 .\" NS doc-header macro
576 .\" NS print page header
577 .\" NS
578 .\" NS local variables:
579 .\" NS doc-reg-dh
580 .\" NS doc-reg-dh1
581 .
582 .de doc-header
583 . ev doc-env-dh
584 . doc-setup-page-layout
585 . if !\n[cR] \
586 . sp \n[doc-header-space]u
587 . nr doc-reg-dh \w'\*[doc-caption-font]\*[doc-header-string]\f[]'
588 . nr doc-reg-dh1 \w'\*[doc-caption-font2]\*[doc-volume]\f[]'
589 . if (\n[doc-reg-dh] + \n[doc-reg-dh1] + \n[doc-reg-dh] >= \n[.lt]) \{\
590 . while (\n[doc-reg-dh] + \n[doc-reg-dh1] + \n[doc-reg-dh] >= \n[.lt]) \{\
591 . substring doc-header-string 0 -2
592 . nr doc-reg-dh \w'\*[doc-caption-font]\*[doc-header-string]\|.\|.\|.\f[]'
593 . \}
594 . as doc-header-string "\|.\|.\|.
595 . \}
596 . tl \a\*[doc-caption-font]\*[doc-header-string]\f[]\a\*[doc-caption-font2]\*[doc-volume]\f[]\a\*[doc-caption-font]\*[doc-header-string]\f[]\a
597 . ie !\n[cR] \
598 . sp \n[doc-header-space]u
599 . el \
600 . sp 1v
601 . ev
602 . ns
603 ..
604 .
605 .
606 .\" NS doc-footer macro
607 .\" NS print page footer
608 .
609 .de doc-footer
610 . ie \n[cR] \
611 . br
612 . el \{\
613 . ev doc-caption-enviroment
614 . doc-setup-page-layout
615 . sp \n[doc-footer-space]u
616 . ie \n[D] \{\
617 . ie o \
618 . tl \a%\a\*[doc-caption-font2]\*[doc-date-string]\f[]\a\*[doc-caption-font]\*[doc-operating-system]\f[]\a
619 . el \
620 . tl \a\*[doc-caption-font]\*[doc-operating-system]\f[]\a\*[doc-caption-font2]\*[doc-date-string]\f[]\a%\a
621 . \}
622 . el \
623 . tl \a\*[doc-caption-font]\*[doc-operating-system]\f[]\a\*[doc-caption-font2]\*[doc-date-string]\f[]\a%\a
624 . bp
625 . ev
626 . \}
627 ..
628 .
629 .
630 .\" NS doc-check-depth macro
631 .\" NS check paired macros
632 .
633 .de doc-check-depth
634 . if \n[doc-list-depth] \{\
635 . tm mdoc warning: A .Bl directive has no matching .El (#\n[.c])
636 . nr doc-list-depth 0
637 . \}
638 . if \n[doc-display-depth] \{\
639 . tm mdoc warning: A .Bd directive has no matching .Ed (#\n[.c])
640 . nr doc-display-depth 0
641 . \}
642 . if \n[doc-fontmode-depth] \{\
643 . tm mdoc warning: A .Bf directive has no matching .Ef (#\n[.c])
644 . nr doc-fontmode-depth 0
645 . \}
646 ..
647 .
648 .
649 .\" NS doc-end-macro macro
650 .\" NS finish output
651 .
652 .de doc-end-macro
653 . \" We may still have a partial line in the environment. If this is the
654 . \" case, and we happen to be on the last line of the page, the `.fl'
655 . \" request will cause the page to be ejected and troff will immediately
656 . \" exit. If we are in nroff mode, this would be unfortunate, since we
657 . \" would never get a chance to output the footer. So we fudge the page
658 . \" length to make sure that the last page is never ejected until we want
659 . \" it to be.
660 .
661 . if \n[cR] \
662 . pl +3v
663 . fl
664 .
665 . doc-check-depth
666 .
667 . if \n[cR] \{\
668 . sp
669 . tl \a\*[doc-caption-font]\*[doc-operating-system]\f[]\a\*[doc-caption-font2]\*[doc-date-string]\f[]\a\*[doc-caption-font]\*[doc-operating-system]\f[]\a
670 . \" suppress empty lines after the footer
671 . pl \n[nl]u
672 . \}
673 ..
674 .
675 .
676 .\" NS doc-paragraph macro
677 .\" NS insert a paragraph
678 .
679 .de doc-paragraph
680 . sp \n[doc-paragraph-space]u
681 . if !\n[cR] \
682 . ne 2
683 . ns
684 ..
685 .
686 .
687 .\" NS Pp user macro (not parsed, not callable)
688 .\" NS new paragraph
689 .\" NS
690 .\" NS width register `Pp' set above
691 .
692 .als Pp doc-paragraph
693 .
694 .
695 .\" NS Lp user macro (not parsed, not callable)
696 .\" NS same as .Pp
697 .\" NS
698 .\" NS width register `Lp' set above
699 .
700 .als Lp doc-paragraph
701 .
702 .
703 .de LP
704 . tm Not a \-mdoc command: .LP (#\n[.c])
705 ..
706 .
707 .
708 .de PP
709 . tm Not a \-mdoc command: .PP (#\n[.c])
710 ..
711 .
712 .
713 .de pp
714 . tm Not a \-mdoc command: .pp (#\n[.c])
715 ..
716 .
717 .
718 .de SH
719 . tm Not a \-mdoc command: .SH (#\n[.c])
720 ..
721 .
722 .
723 .\" NS Nd user macro (not parsed, not callable)
724 .\" NS print name description
725 .\" NS
726 .\" NS width register `Nd' set above
727 .
728 .de Nd
729 . nop \[em] \$*
730 ..
731 .
732 .
733 .\" NS doc-in-synopsis-section global register (bool)
734 .\" NS whether we are in the `synopsis' section
735 .
736 .nr doc-in-synopsis-section 0
737 .
738 .
739 .\" NS doc-in-library-section global register (bool)
740 .\" NS whether we are in the `library' section
741 .
742 .nr doc-in-library-section 0
743 .
744 .
745 .\" NS doc-in-see-also-section global register (bool)
746 .\" NS whether we are in the `see also' section
747 .
748 .nr doc-in-see-also-section 0
749 .
750 .
751 .\" NS doc-in-files-section global register (bool)
752 .\" NS whether we are in the `files' section
753 .
754 .nr doc-in-files-section 0
755 .
756 .
757 .\" NS doc-in-authors-section global register (bool)
758 .\" NS whether we are in the `authors' section
759 .
760 .nr doc-in-authors-section 0
761 .
762 .
763 .\" NS doc-first-parameter macro
764 .\" NS return first parameter
765 .\" NS
766 .\" NS local variables:
767 .\" NS doc-str-dfp
768 .
769 .de doc-first-parameter
770 . ds doc-str-dfp "\$1
771 ..
772 .
773 .
774 .\" NS Sh user macro (not callable)
775 .\" NS section headers
776 .\" NS
777 .\" NS modifies:
778 .\" NS doc-func-args-processed
779 .\" NS doc-func-count
780 .\" NS doc-in-authors-section
781 .\" NS doc-in-files-section
782 .\" NS doc-in-library-section
783 .\" NS doc-in-see-also-section
784 .\" NS doc-in-synopsis-section
785 .\" NS doc-indent-synopsis
786 .\" NS doc-indent-synopsis-active
787 .\" NS doc-is-func
788 .\" NS doc-num-func-args
789 .\" NS
790 .\" NS local variables:
791 .\" NS doc-reg-Sh
792 .\" NS doc-reg-Sh1
793 .\" NS doc-section-XXX
794 .\" NS
795 .\" NS width register `Sh' set in doc-common
796 .
797 .ds doc-section-name NAME
798 .ds doc-section-synopsis SYNOPSIS
799 .ds doc-section-library LIBRARY
800 .ds doc-section-description DESCRIPTION
801 .ds doc-section-see-also SEE
802 .ds doc-section-files FILES
803 .ds doc-section-authors AUTHORS
804 .
805 .de Sh
806 . ie \n[doc-arg-limit] \{\
807 . \" we only allow `Sh' within `Sh'; it will change the font back to
808 . \" `doc-Sh-font'
809 . ie "\*[doc-macro-name]"Sh" \{\
810 . nr doc-arg-ptr +1
811 . ie (\n[doc-arg-limit] >= \n[doc-arg-ptr]) \{\
812 . nr doc-curr-font \n[.f]
813 . nr doc-curr-size \n[.ps]
814 . nop \*[doc-Sh-font]\c
815 . doc-print-recursive
816 . \}
817 . el \{\
818 . tm Usage: .Sh section_name ... (#\n[.c])
819 . doc-reset-args
820 . \}\}
821 . el \{\
822 . tm Usage: .Sh not callable by other macros (#\n[.c])
823 . doc-reset-args
824 . \}\}
825 . el \{\
826 . if !\n[.$] \{\
827 . tm Usage: .Sh section_name ... (#\n[.c])
828 . return
829 . \}
830 .
831 . ds doc-macro-name Sh
832 . doc-parse-args \$@
833 .
834 . if t \
835 . ad
836 .
837 . \" this resolves e.g. `.Sh "SEE ALSO"'
838 . doc-first-parameter \$*
839 .
840 . ie "\*[doc-str-dfp]"\*[doc-section-name]" \{\
841 . doc-setup-header
842 . in 0
843 . \}
844 . el \{\
845 . nr doc-in-synopsis-section 0
846 . nr doc-in-library-section 0
847 . nr doc-in-see-also-section 0
848 . nr doc-in-files-section 0
849 . nr doc-in-authors-section 0
850 .
851 . ie "\*[doc-str-dfp]"\*[doc-section-synopsis]" \{\
852 . if t \
853 . na
854 . nr doc-in-synopsis-section 1
855 . nr doc-indent-synopsis 0
856 . nr doc-indent-synopsis-active 0
857 . \}
858 . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-library]" \{\
859 . nr doc-in-library-section 1
860 . \}
861 . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-description]" \{\
862 . nr doc-is-func 0
863 . nr doc-func-count 0
864 . nr doc-func-args-processed 0
865 . nr doc-num-func-args 0
866 . \}
867 . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-see-also]" \{\
868 . if t \
869 . na
870 . nr doc-in-see-also-section 1
871 . \}
872 . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-files]" \
873 . nr doc-in-files-section 1
874 . el .if "\*[doc-str-dfp]"\*[doc-section-authors]" \
875 . nr doc-in-authors-section 1
876 . \}\}\}\}
877 .
878 . in 0
879 . nr doc-have-author 0
880 . \}
881 .
882 . doc-setup-page-layout
883 . sp
884 . ns
885 . ta T .5i
886 . if !\n[cR] \
887 . ne 3
888 . fi
889 .
890 . if t \{\
891 . nr doc-reg-Sh \n[.ss]
892 . nr doc-reg-Sh1 \n[.sss]
893 . ss (\n[.ss] * 5 / 3) (\n[.sss] * 5 / 3)
894 . \}
895 .
896 . nr doc-arg-ptr +1
897 . nr doc-curr-font \n[.f]
898 . nr doc-curr-size \n[.ps]
899 . nop \*[doc-Sh-font]\c
900 . doc-print-recursive
901 .
902 . if t \
903 . ss \n[doc-reg-Sh] \n[doc-reg-Sh1]
904 .
905 . in +\n[doc-subheader-indent]u
906 . ns
907 .
908 . doc-check-depth
909 . \}
910 ..
911 .
912 .
913 .\" NS Ss user macro (not callable)
914 .\" NS subsection
915 .\" NS
916 .\" NS local variable:
917 .\" NS doc-reg-Ss
918 .\" NS doc-reg-Ss1
919 .\" NS
920 .\" NS width register `Ss' set above
921 .
922 .de Ss
923 . ie \n[doc-arg-limit] \{\
924 . \" we only allow `Ss' within `Ss'; it will change the font back to
925 . \" `doc-Sh-font'
926 . ie "\*[doc-macro-name]"Ss" \{\
927 . nr doc-arg-ptr +1
928 . ie (\n[doc-arg-limit] >= \n[doc-arg-ptr]) \{\
929 . nr doc-curr-font \n[.f]
930 . nr doc-curr-size \n[.ps]
931 . nop \*[doc-Sh-font]\c
932 . doc-print-recursive
933 . \}
934 . el \{\
935 . tm Usage: .Ss subsection_name ... (#\n[.c])
936 . doc-reset-args
937 . \}\}
938 . el \{\
939 . tm Usage: .Ss not callable by other macros (#\n[.c])
940 . doc-reset-args
941 . \}\}
942 . el \{\
943 . if !\n[.$] \{\
944 . tm Usage: .Ss subsection_name ... (#\n[.c])
945 . return
946 . \}
947 .
948 . ds doc-macro-name Ss
949 . doc-parse-args \$@
950 .
951 . sp
952 . if !\n[cR] \
953 . ne 3
954 . ti -.25i
955 .
956 . nr doc-reg-Ss \n[.ss]
957 . nr doc-reg-Ss1 \n[.sss]
958 . ss (\n[.ss] * 5 / 4) (\n[.sss] * 5 / 4)
959 .
960 . nr doc-arg-ptr +1
961 . nr doc-curr-font \n[.f]
962 . nr doc-curr-size \n[.ps]
963 . nop \*[doc-Sh-font]\c
964 . doc-print-recursive
965 .
966 . ss \n[doc-reg-Ss] \n[doc-reg-Ss1]
967 .
968 . ta T .5i
969 . if !\n[cR] \
970 . ne 2
971 . br
972 . ns
973 .
974 . doc-check-depth
975 . \}
976 ..
977 .
978 .
979 .\" NS Rd macro (not parsed, not callable)
980 .\" NS print global register dump to stderr
981 .\" NS
982 .\" NS local variables:
983 .\" NS doc-reg-Rd
984 .
985 .de Rd
986 . tm MDOC GLOBAL REGISTER DUMP
987 . tm doc-macro-name == `\*[doc-macro-name]'
988 . tm doc-arg-limit == \n[doc-arg-limit]
989 . tm doc-num-args == \n[doc-num-args]
990 . tm doc-arg-ptr == \n[doc-arg-ptr]
991 .
992 . nr doc-reg-Rd 1
993 . while (\n[doc-reg-Rd] <= \n[doc-arg-limit]) \{\
994 . tm doc-arg\n[doc-reg-Rd] == `\*[doc-arg\n[doc-reg-Rd]]'
995 . tm doc-type\n[doc-reg-Rd] == \n[doc-type\n[doc-reg-Rd]]
996 . tm doc-space\n[doc-reg-Rd] == `\*[doc-space\n[doc-reg-Rd]]'
997 . nr doc-reg-Rd +1
998 . \}
999 .
1000 . tm doc-curr-font == \n[doc-curr-font]
1001 . tm doc-curr-size == \n[doc-curr-size]
1002 . tm doc-indent-synopsis == \n[doc-indent-synopsis]
1003 . tm doc-indent-synopsis-active == \n[doc-indent-synopsis-active]
1004 . tm doc-have-decl == \n[doc-have-decl]
1005 . tm doc-have-var == \n[doc-have-var]
1006 . tm doc-command-name == `\*[doc-command-name]'
1007 . tm doc-quote-left == `\*[doc-quote-left]'
1008 . tm doc-quote-right == `\*[doc-quote-right]'
1009 . tm doc-nesting-level == \n[doc-nesting-level]
1010 . tm doc-in-list == \n[doc-in-list]
1011 . tm doc-space == `\*[doc-space]'
1012 . tm doc-saved-space == `\*[doc-saved-space]'
1013 . tm doc-space-mode == \n[doc-space-mode]
1014 . tm doc-have-space == \n[doc-have-space]
1015 . tm doc-have-slot == \n[doc-have-slot]
1016 . tm doc-keep-type == \n[doc-keep-type]
1017 . tm doc-display-depth == \n[doc-display-depth]
1018 . tm doc-is-compact == \n[doc-is-compact]
1019 .
1020 . nr doc-reg-Rd 0
1021 . while (\n[doc-reg-Rd] <= \n[doc-display-depth]) \{\
1022 . tm doc-display-type-stack\n[doc-reg-Rd] == `\*[doc-display-type-stack\n[doc-reg-Rd]]'
1023 . tm doc-display-indent-stack\n[doc-reg-Rd] == \n[doc-display-indent-stack\n[doc-reg-Rd]]
1024 . tm doc-display-ad-stack\n[doc-reg-Rd] == \n[doc-display-ad-stack\n[doc-reg-Rd]]
1025 . tm doc-display-fi-stack\n[doc-reg-Rd] == \n[doc-display-fi-stack\n[doc-reg-Rd]]
1026 . tm doc-display-ft-stack\n[doc-reg-Rd] == \n[doc-display-ft-stack\n[doc-reg-Rd]]
1027 . tm doc-display-ps-stack\n[doc-reg-Rd] == \n[doc-display-ps-stack\n[doc-reg-Rd]]
1028 . nr doc-reg-Rd +1
1029 . \}
1030 .
1031 . tm doc-fontmode-depth == \n[doc-fontmode-depth]
1032 .
1033 . nr doc-reg-Rd 1
1034 . while (\n[doc-reg-Rd] <= \n[doc-fontmode-depth]) \{\
1035 . tm doc-fontmode-font-stack\n[doc-reg-Rd] == `\n[doc-fontmode-font-stack\n[doc-reg-Rd]]'
1036 . tm doc-fontmode-size-stack\n[doc-reg-Rd] == `\n[doc-fontmode-size-stack\n[doc-reg-Rd]]'
1037 . nr doc-reg-Rd +1
1038 . \}
1039 .
1040 . tm doc-list-depth == \n[doc-list-depth]
1041 .
1042 . nr doc-reg-Rd 1
1043 . while (\n[doc-reg-Rd] <= \n[doc-list-depth]) \{\
1044 . tm doc-list-type-stack\n[doc-reg-Rd] == `\*[doc-list-type-stack\n[doc-reg-Rd]]'
1045 . tm doc-list-have-indent-stack\n[doc-reg-Rd] == \n[doc-list-have-indent-stack\n[doc-reg-Rd]]
1046 . tm doc-list-indent-stack\n[doc-reg-Rd] == \n[doc-list-indent-stack\n[doc-reg-Rd]]
1047 . tm doc-compact-list-stack\n[doc-reg-Rd] == \n[doc-compact-list-stack\n[doc-reg-Rd]]
1048 . tm doc-tag-prefix-stack\n[doc-reg-Rd] == `\*[doc-tag-prefix-stack\n[doc-reg-Rd]]'
1049 . tm doc-tag-width-stack\n[doc-reg-Rd] == `\*[doc-tag-width-stack\n[doc-reg-Rd]]'
1050 . tm doc-list-offset-stack\n[doc-reg-Rd] == \n[doc-list-offset-stack\n[doc-reg-Rd]]
1051 . tm doc-enum-list-count-stack\n[doc-reg-Rd] == \n[doc-enum-list-count-stack\n[doc-reg-Rd]]
1052 . nr doc-reg-Rd +1
1053 . \}
1054 .
1055 . tm doc-saved-Pa-font == `\*[doc-saved-Pa-font]'
1056 . tm doc-curr-type == \n[doc-curr-type]
1057 . tm doc-curr-arg == `\*[doc-curr-arg]'
1058 . tm doc-diag-list-input-line-count == \n[doc-diag-list-input-line-count]
1059 . tm doc-num-columns == \n[doc-num-columns]
1060 . tm doc-column-indent-width == \n[doc-column-indent-width]
1061 . tm doc-is-func == \n[doc-is-func]
1062 . tm doc-have-old-func == \n[doc-have-old-func]
1063 . tm doc-func-arg-count == \n[doc-func-arg-count]
1064 . tm doc-func-arg == `\*[doc-func-arg]'
1065 . tm doc-num-func-args == \n[doc-num-func-args]
1066 . tm doc-func-args-processed == \n[doc-func-args-processed]
1067 . tm doc-have-func == \n[doc-have-func]
1068 . tm doc-is-reference == \n[doc-is-reference]
1069 . tm doc-reference-count == \n[doc-reference-count]
1070 . tm doc-author-count == \n[doc-author-count]
1071 .
1072 . nr doc-reg-Rd 0
1073 . while (\n[doc-reg-Rd] <= \n[doc-author-count]) \{\
1074 . tm doc-author-name\n[doc-reg-Rd] == `\*[doc-author-name\n[doc-reg-Rd]]'
1075 . nr doc-reg-Rd +1
1076 . \}
1077 .
1078 . tm doc-book-count == \n[doc-book-count]
1079 . tm doc-book-name == `\*[doc-book-name]'
1080 . tm doc-date-count == \n[doc-date-count]
1081 . tm doc-date == `\*[doc-date]'
1082 . tm doc-publisher-count == \n[doc-publisher-count]
1083 . tm doc-publisher-name == `\*[doc-publisher-name]'
1084 . tm doc-journal-count == \n[doc-journal-count]
1085 . tm doc-journal-name == `\*[doc-journal-name]'
1086 . tm doc-issue-count == \n[doc-issue-count]
1087 . tm doc-issue-name == `\*[doc-issue-name]'
1088 . tm doc-optional-count == \n[doc-optional-count]
1089 . tm doc-optional-string == `\*[doc-optional-string]'
1090 . tm doc-page-number-count == \n[doc-page-number-count]
1091 . tm doc-page-number-string == `\*[doc-page-number-string]'
1092 . tm doc-corporate-count == \n[doc-corporate-count]
1093 . tm doc-corporate-name == `\*[doc-corporate-name]'
1094 . tm doc-report-count == \n[doc-report-count]
1095 . tm doc-report-name == `\*[doc-report-name]'
1096 . tm doc-reference-title-count == \n[doc-reference-title-count]
1097 . tm doc-reference-title-name == `\*[doc-reference-title-name]'
1098 . tm doc-reference-title-name-for-book == `\*[doc-reference-title-name-for-book]'
1099 . tm doc-volume-count == \n[doc-volume-count]
1100 . tm doc-volume-name == `\*[doc-volume-name]'
1101 . tm doc-have-author == \n[doc-have-author]
1102 .
1103 . tm doc-document-title == `\*[doc-document-title]'
1104 . tm doc-volume == `\*[doc-volume]'
1105 . tm doc-section == `\*[doc-section]'
1106 . tm doc-operating-system == `\*[doc-operating-system]'
1107 . tm doc-date-string == `\*[doc-date-string]'
1108 . tm doc-header-space == \n[doc-header-space]
1109 . tm doc-footer-space == \n[doc-footer-space]
1110 . tm doc-display-vertical == \n[doc-display-vertical]
1111 . tm doc-header-string == `\*[doc-header-string]'
1112 . tm doc-in-synopsis-section == \n[doc-in-synopsis-section]
1113 . tm doc-in-library-section == \n[doc-in-library-section]
1114 . tm doc-in-see-also-section == \n[doc-in-see-also-section]
1115 . tm doc-in-files-section == \n[doc-in-files-section]
1116 . tm doc-in-authors-section == \n[doc-in-authors-section]
1117 .
1118 . tm END OF GLOBAL REGISTER DUMP
1119 ..
1120 .
1121 .
1122 .ec
1123 .
1124 .\" EOF