1 .\" Copyright (c) 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
13 .\" ftp://ftp.cs.berkeley.edu/pub/4bsd/README.Impt.License.Change]
14 .\" 4. Neither the name of the University nor the names of its contributors
15 .\" may be used to endorse or promote products derived from this software
16 .\" without specific prior written permission.
18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" @(#)doc-common 8.1 (Berkeley) 06/08/93
35 .\" Macro Identifiers. For each user macro a corresponding register with
36 .\" the same name must exist. Its value must not be zero.
78 .nr Ds 6n\" many manpages still use this as a -width value
153 .\" macros which must be processed after the closing delimiter of `Op'
169 .nr doc-display-indent 6n
174 .ds doc-soft-space " \"
175 .ds doc-hard-space \~
182 .\" punctuation values (suffix=3, prefix=4)
196 .\" header assembly macros
198 .\" NS doc-document-title global string
199 .\" NS the title of the manual page
201 .ds doc-document-title UNTITLED
204 .\" NS doc-volume global string
205 .\" NS the volume where the manual page belongs to
210 .\" NS doc-section global string
211 .\" NS the manual section
216 .\" NS Dt user macro (not parsed, not callable)
217 .\" NS document title
220 .\" NS doc-document-title
223 .\" NS doc-command-name
225 .\" NS local variables:
226 .\" NS doc-volume-as-XXX
227 .\" NS doc-volume-ds-XXX
229 .\" NS width register `Dt' set above
231 .\" an alternative, more detailed scheme for naming the manual sections
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
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
256 .als doc-volume-ds-MMI doc-volume-ds-IND
257 .als doc-volume-ds-LOC doc-volume-ds-LOCAL
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
320 . \" reset default arguments
321 . ds doc-document-title UNTITLED
322 . ds doc-volume LOCAL
323 . ds doc-section Null
324 . ds doc-command-name
327 . ds doc-document-title "\$1
332 . if ((\$2 >= 1) & (\$2 <= 9)) \{\
333 . ie \n[doc-volume-operating-system-ateol] \{\
334 . ds doc-volume "\*[doc-volume-ds-\$2] \*[doc-volume-operating-system]
336 . if d doc-volume-as-\$3 \
337 . as doc-volume "/\*[doc-volume-as-\$3]
340 . ds doc-volume "\*[doc-volume-operating-system]
342 . if d doc-volume-as-\$3 \
343 . as doc-volume "/\*[doc-volume-as-\$3]
345 . as doc-volume " \*[doc-volume-ds-\$2]
349 . ds doc-volume DRAFT
350 . el \{ .ie "\$2"draft" \
351 . ds doc-volume DRAFT
352 . el .if "\$2"paper" \
353 . ds doc-volume UNTITLED
356 . if d doc-volume-ds-\$3 \
357 . ds doc-volume "\*[doc-volume-ds-\$3]
361 . if "\*[doc-volume]"LOCAL" \
372 .\" NS doc-default-operating-system global string
373 .\" NS the exact (default) version of the operating system
375 .\" NS override this in `mdoc.local', if necessary
377 .ds doc-default-operating-system BSD
380 .\" NS doc-operating-system global string
381 .\" NS the exact version of the operating system
383 .ds doc-operating-system
386 .\" NS Os user macro (not parsed, not callable)
387 .\" NS operating system
390 .\" NS doc-operating-system
391 .\" NS doc-command-name
393 .\" NS local variables:
394 .\" NS doc-operating-system-XXX-XXX
396 .\" NS width register `Os' set above
398 .ds doc-operating-system-ATT-7 7th\~Edition
399 .als doc-operating-system-ATT-7th doc-operating-system-ATT-7
400 .ds doc-operating-system-ATT-3 System\~III
401 .als doc-operating-system-ATT-III doc-operating-system-ATT-3
402 .ds doc-operating-system-ATT-V System\~V
403 .ds doc-operating-system-ATT-V.2 System\~V Release\~2
404 .ds doc-operating-system-ATT-V.3 System\~V Release\~3
405 .ds doc-operating-system-ATT-V.4 System\~V Release\~4
407 .ds doc-operating-system-BSD-3 3rd\~Berkeley Distribution
408 .ds doc-operating-system-BSD-4 4th\~Berkeley Distribution
409 .ds doc-operating-system-BSD-4.1 4.1\~Berkeley Distribution
410 .ds doc-operating-system-BSD-4.2 4.2\~Berkeley Distribution
411 .ds doc-operating-system-BSD-4.3 4.3\~Berkeley Distribution
412 .ds doc-operating-system-BSD-4.3T 4.3-Tahoe Berkeley Distribution
413 .ds doc-operating-system-BSD-4.3R 4.3-Reno Berkeley Distribution
414 .als doc-operating-system-BSD-4.3t doc-operating-system-BSD-4.3T
415 .als doc-operating-system-BSD-4.3r doc-operating-system-BSD-4.3R
416 .ds doc-operating-system-BSD-4.4 4.4BSD
418 .ds doc-operating-system-NetBSD-0.8 0.8
419 .ds doc-operating-system-NetBSD-0.8a 0.8A
420 .ds doc-operating-system-NetBSD-0.9 0.9
421 .ds doc-operating-system-NetBSD-0.9a 0.9A
422 .ds doc-operating-system-NetBSD-1.0 1.0
423 .ds doc-operating-system-NetBSD-1.0a 1.0A
424 .ds doc-operating-system-NetBSD-1.1 1.1
425 .ds doc-operating-system-NetBSD-1.2 1.2
426 .ds doc-operating-system-NetBSD-1.2a 1.2A
427 .ds doc-operating-system-NetBSD-1.2b 1.2B
428 .ds doc-operating-system-NetBSD-1.2c 1.2C
429 .ds doc-operating-system-NetBSD-1.2d 1.2D
430 .ds doc-operating-system-NetBSD-1.2e 1.2E
431 .ds doc-operating-system-NetBSD-1.3 1.3
432 .ds doc-operating-system-NetBSD-1.3a 1.3A
433 .ds doc-operating-system-NetBSD-1.4 1.4
434 .ds doc-operating-system-NetBSD-1.4.1 1.4.1
435 .ds doc-operating-system-NetBSD-1.4.2 1.4.2
436 .ds doc-operating-system-NetBSD-1.4.3 1.4.3
437 .ds doc-operating-system-NetBSD-1.5 1.5
438 .ds doc-operating-system-NetBSD-1.5.1 1.5.1
439 .ds doc-operating-system-NetBSD-1.5.2 1.5.2
440 .ds doc-operating-system-NetBSD-1.5.3 1.5.3
441 .ds doc-operating-system-NetBSD-1.6 1.6
442 .ds doc-operating-system-NetBSD-1.6.1 1.6.1
443 .ds doc-operating-system-NetBSD-1.6.2 1.6.2
444 .ds doc-operating-system-NetBSD-1.6.3 1.6.3
445 .ds doc-operating-system-NetBSD-2.0 2.0
446 .ds doc-operating-system-NetBSD-2.0.1 2.0.1
447 .ds doc-operating-system-NetBSD-2.0.2 2.0.2
448 .ds doc-operating-system-NetBSD-2.0.3 2.0.3
449 .ds doc-operating-system-NetBSD-2.1 2.1
450 .ds doc-operating-system-NetBSD-3.0 3.0
451 .ds doc-operating-system-NetBSD-3.0.1 3.0.1
452 .ds doc-operating-system-NetBSD-3.0.2 3.0.2
453 .ds doc-operating-system-NetBSD-3.1 3.1
454 .ds doc-operating-system-NetBSD-4.0 4.0
455 .ds doc-operating-system-NetBSD-4.0.1 4.0.1
457 .ds doc-operating-system-FreeBSD-1.0 1.0
458 .ds doc-operating-system-FreeBSD-1.1 1.1
459 .ds doc-operating-system-FreeBSD-1.1.5 1.1.5
460 .ds doc-operating-system-FreeBSD-1.1.5.1 1.1.5.1
461 .ds doc-operating-system-FreeBSD-2.0 2.0
462 .ds doc-operating-system-FreeBSD-2.0.5 2.0.5
463 .ds doc-operating-system-FreeBSD-2.1 2.1
464 .ds doc-operating-system-FreeBSD-2.1.5 2.1.5
465 .ds doc-operating-system-FreeBSD-2.1.6 2.1.6
466 .ds doc-operating-system-FreeBSD-2.1.7 2.1.7
467 .ds doc-operating-system-FreeBSD-2.2 2.2
468 .ds doc-operating-system-FreeBSD-2.2.1 2.2.1
469 .ds doc-operating-system-FreeBSD-2.2.2 2.2.2
470 .ds doc-operating-system-FreeBSD-2.2.5 2.2.5
471 .ds doc-operating-system-FreeBSD-2.2.6 2.2.6
472 .ds doc-operating-system-FreeBSD-2.2.7 2.2.7
473 .ds doc-operating-system-FreeBSD-2.2.8 2.2.8
474 .ds doc-operating-system-FreeBSD-3.0 3.0
475 .ds doc-operating-system-FreeBSD-3.1 3.1
476 .ds doc-operating-system-FreeBSD-3.2 3.2
477 .ds doc-operating-system-FreeBSD-3.3 3.3
478 .ds doc-operating-system-FreeBSD-3.4 3.4
479 .ds doc-operating-system-FreeBSD-3.5 3.5
480 .ds doc-operating-system-FreeBSD-4.0 4.0
481 .ds doc-operating-system-FreeBSD-4.1 4.1
482 .ds doc-operating-system-FreeBSD-4.1.1 4.1.1
483 .ds doc-operating-system-FreeBSD-4.2 4.2
484 .ds doc-operating-system-FreeBSD-4.3 4.3
485 .ds doc-operating-system-FreeBSD-4.4 4.4
486 .ds doc-operating-system-FreeBSD-4.5 4.5
487 .ds doc-operating-system-FreeBSD-4.6 4.6
488 .ds doc-operating-system-FreeBSD-4.6.2 4.6.2
489 .ds doc-operating-system-FreeBSD-4.7 4.7
490 .ds doc-operating-system-FreeBSD-4.8 4.8
491 .ds doc-operating-system-FreeBSD-4.9 4.9
492 .ds doc-operating-system-FreeBSD-4.10 4.10
493 .ds doc-operating-system-FreeBSD-4.11 4.11
494 .ds doc-operating-system-FreeBSD-5.0 5.0
495 .ds doc-operating-system-FreeBSD-5.1 5.1
496 .ds doc-operating-system-FreeBSD-5.2 5.2
497 .ds doc-operating-system-FreeBSD-5.2.1 5.2.1
498 .ds doc-operating-system-FreeBSD-5.3 5.3
499 .ds doc-operating-system-FreeBSD-5.4 5.4
500 .ds doc-operating-system-FreeBSD-5.5 5.5
501 .ds doc-operating-system-FreeBSD-6.0 6.0
502 .ds doc-operating-system-FreeBSD-6.1 6.1
503 .ds doc-operating-system-FreeBSD-6.2 6.2
504 .ds doc-operating-system-FreeBSD-6.3 6.3
505 .ds doc-operating-system-FreeBSD-6.4 6.4
506 .ds doc-operating-system-FreeBSD-7.0 7.0
507 .ds doc-operating-system-FreeBSD-7.1 7.1
509 .ds doc-operating-system-Darwin-8.0.0 8.0.0
510 .ds doc-operating-system-Darwin-8.1.0 8.1.0
511 .ds doc-operating-system-Darwin-8.2.0 8.2.0
512 .ds doc-operating-system-Darwin-8.3.0 8.3.0
513 .ds doc-operating-system-Darwin-8.4.0 8.4.0
514 .ds doc-operating-system-Darwin-8.5.0 8.5.0
515 .ds doc-operating-system-Darwin-8.6.0 8.6.0
516 .ds doc-operating-system-Darwin-8.7.0 8.7.0
517 .ds doc-operating-system-Darwin-8.8.0 8.8.0
518 .ds doc-operating-system-Darwin-8.9.0 8.9.0
519 .ds doc-operating-system-Darwin-8.10.0 8.10.0
520 .ds doc-operating-system-Darwin-8.11.0 8.11.0
521 .ds doc-operating-system-Darwin-9.0.0 9.0.0
522 .ds doc-operating-system-Darwin-9.1.0 9.1.0
523 .ds doc-operating-system-Darwin-9.2.0 9.2.0
524 .ds doc-operating-system-Darwin-9.3.0 9.3.0
525 .ds doc-operating-system-Darwin-9.4.0 9.4.0
526 .ds doc-operating-system-Darwin-9.5.0 9.5.0
527 .ds doc-operating-system-Darwin-9.6.0 9.6.0
529 .ds doc-operating-system-DragonFly-1.0 1.0
530 .ds doc-operating-system-DragonFly-1.1 1.1
531 .ds doc-operating-system-DragonFly-1.2 1.2
532 .ds doc-operating-system-DragonFly-1.3 1.3
533 .ds doc-operating-system-DragonFly-1.4 1.4
534 .ds doc-operating-system-DragonFly-1.5 1.5
535 .ds doc-operating-system-DragonFly-1.6 1.6
536 .ds doc-operating-system-DragonFly-1.8 1.8
537 .ds doc-operating-system-DragonFly-1.8.1 1.8.1
538 .ds doc-operating-system-DragonFly-1.10 1.10
539 .ds doc-operating-system-DragonFly-1.12 1.12
540 .ds doc-operating-system-DragonFly-1.12.2 1.12.2
541 .ds doc-operating-system-DragonFly-2.0 2.0
544 . ds doc-command-name
547 . ds doc-operating-system "\*[doc-default-operating-system]
548 . el \{ .ie "\$1"ATT" \{\
549 . ds doc-operating-system AT&T
551 . ie d doc-operating-system-ATT-\$2 \
552 . as doc-operating-system " \*[doc-operating-system-ATT-\$2]
554 . as doc-operating-system " UNIX
556 . el \{ .ie "\$1"BSD" \{\
558 . ie d doc-operating-system-BSD-\$2 \
559 . ds doc-operating-system "\*[doc-operating-system-BSD-\$2]
561 . tm mdoc warning: .Os: Unknown BSD version `\$2' (#\n[.c])
563 . el \{ .ie "\$1"FreeBSD" \{\
564 . ds doc-operating-system FreeBSD
566 . ie d doc-operating-system-FreeBSD-\$2 \
567 . as doc-operating-system \~\*[doc-operating-system-FreeBSD-\$2]
569 . tm mdoc warning: .Os: Unknown FreeBSD version `\$2' (#\n[.c])
571 . el \{ .ie "\$1"NetBSD" \{\
572 . ds doc-operating-system NetBSD
574 . ie d doc-operating-system-NetBSD-\$2 \
575 . as doc-operating-system \~\*[doc-operating-system-NetBSD-\$2]
577 . tm mdoc warning: .Os: Unknown NetBSD version `\$2' (#\n[.c])
579 . el \{ .ie "\$1"Darwin" \{\
580 . ds doc-operating-system Darwin
582 . ie d doc-operating-system-Darwin-\$2 \
583 . as doc-operating-system \~\*[doc-operating-system-Darwin-\$2]
585 . tm mdoc warning: .Os: Unknown Darwin version `\$2' (#\n[.c])
588 . ds doc-operating-system \$1
590 . as doc-operating-system " \$2
595 .\" NS doc-date-string global string
596 .\" NS the manual page date as set by `Dd'
601 .\" NS Dd user macro (not parsed, not callable)
602 .\" NS set document date
605 .\" NS doc-date-string
606 .\" NS doc-command-name
608 .\" NS local variables:
611 .\" NS width register `Dd' set above
613 .ds doc-date-1 January
614 .ds doc-date-2 February
620 .ds doc-date-8 August
621 .ds doc-date-9 September
622 .ds doc-date-10 October
623 .ds doc-date-11 November
624 .ds doc-date-12 December
627 . ds doc-command-name
631 . ds doc-date-string \$1\~\$2 \$3
633 . ds doc-date-string "\*[doc-date-\n[mo]]
634 . as doc-date-string \~\n[dy], \n[year]
638 . ds doc-date-string Epoch
642 .\" NS doc-hyphen-flags global register
643 .\" NS the parameter for the `.hy' request
645 .\" NS override this in `mdoc.local', if necessary.
647 .nr doc-hyphen-flags 12
650 .\" NS doc-header macro
651 .\" NS print page header
653 .\" NS local variables:
659 . doc-setup-page-layout
661 . sp \n[doc-header-space]u
662 . nr doc-reg-dh \w'\*[doc-caption-font]\*[doc-header-string]\f[]'
663 . nr doc-reg-dh1 \w'\*[doc-caption-font2]\*[doc-volume]\f[]'
664 . if (\n[doc-reg-dh] + \n[doc-reg-dh1] + \n[doc-reg-dh] >= \n[.lt]) \{\
665 . while (\n[doc-reg-dh] + \n[doc-reg-dh1] + \n[doc-reg-dh] >= \n[.lt]) \{\
666 . substring doc-header-string 0 -2
667 . nr doc-reg-dh \w'\*[doc-caption-font]\*[doc-header-string]\|.\|.\|.\f[]'
669 . as doc-header-string "\|.\|.\|.
671 . 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
673 . sp \n[doc-header-space]u
681 .\" NS doc-footer macro
682 .\" NS print page footer
688 . ev doc-caption-enviroment
689 . doc-setup-page-layout
690 . sp \n[doc-footer-space]u
693 . tl
\a%
\a\*[doc-caption-font2]\*[doc-date-string]\f[]
\a\*[doc-caption-font]\*[doc-operating-system]\f[]
\a
695 . tl
\a\*[doc-caption-font]\*[doc-operating-system]\f[]
\a\*[doc-caption-font2]\*[doc-date-string]\f[]
\a%
\a
698 . tl
\a\*[doc-caption-font]\*[doc-operating-system]\f[]
\a\*[doc-caption-font2]\*[doc-date-string]\f[]
\a%
\a
705 .\" NS doc-check-depth macro
706 .\" NS check paired macros
709 . if \n[doc-list-depth] \{\
710 . tm mdoc warning: A .Bl directive has no matching .El (#\n[.c])
711 . nr doc-list-depth 0
713 . if \n[doc-display-depth] \{\
714 . tm mdoc warning: A .Bd directive has no matching .Ed (#\n[.c])
715 . nr doc-display-depth 0
717 . if \n[doc-fontmode-depth] \{\
718 . tm mdoc warning: A .Bf directive has no matching .Ef (#\n[.c])
719 . nr doc-fontmode-depth 0
724 .\" NS doc-end-macro macro
728 . \" We may still have a partial line in the environment. If this is the
729 . \" case, and we happen to be on the last line of the page, the `.fl'
730 . \" request will cause the page to be ejected and troff will immediately
731 . \" exit. If we are in nroff mode, this would be unfortunate, since we
732 . \" would never get a chance to output the footer. So we fudge the page
733 . \" length to make sure that the last page is never ejected until we want
744 . 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
745 . \" suppress empty lines after the footer
751 .\" NS doc-paragraph macro
752 .\" NS insert a paragraph
755 . sp \n[doc-paragraph-space]u
762 .\" NS Pp user macro (not parsed, not callable)
765 .\" NS width register `Pp' set above
767 .als Pp doc-paragraph
770 .\" NS Lp user macro (not parsed, not callable)
773 .\" NS width register `Lp' set above
775 .als Lp doc-paragraph
779 . tm Not a \-mdoc command: .LP (#\n[.c])
784 . tm Not a \-mdoc command: .PP (#\n[.c])
789 . tm Not a \-mdoc command: .pp (#\n[.c])
794 . tm Not a \-mdoc command: .SH (#\n[.c])
798 .\" NS Nd user macro (not parsed, not callable)
799 .\" NS print name description
801 .\" NS width register `Nd' set above
808 .\" NS doc-in-synopsis-section global register (bool)
809 .\" NS whether we are in the `synopsis' section
811 .nr doc-in-synopsis-section 0
814 .\" NS doc-in-library-section global register (bool)
815 .\" NS whether we are in the `library' section
817 .nr doc-in-library-section 0
820 .\" NS doc-in-see-also-section global register (bool)
821 .\" NS whether we are in the `see also' section
823 .nr doc-in-see-also-section 0
826 .\" NS doc-in-files-section global register (bool)
827 .\" NS whether we are in the `files' section
829 .nr doc-in-files-section 0
832 .\" NS doc-in-authors-section global register (bool)
833 .\" NS whether we are in the `authors' section
835 .nr doc-in-authors-section 0
838 .\" NS doc-first-parameter macro
839 .\" NS return first parameter
841 .\" NS local variables:
844 .de doc-first-parameter
845 . ds doc-str-dfp "\$1
849 .\" NS Sh user macro (not callable)
850 .\" NS section headers
853 .\" NS doc-func-args-processed
854 .\" NS doc-func-count
855 .\" NS doc-in-authors-section
856 .\" NS doc-in-files-section
857 .\" NS doc-in-library-section
858 .\" NS doc-in-see-also-section
859 .\" NS doc-in-synopsis-section
860 .\" NS doc-indent-synopsis
861 .\" NS doc-indent-synopsis-active
863 .\" NS doc-num-func-args
865 .\" NS local variables:
868 .\" NS doc-section-XXX
870 .\" NS width register `Sh' set in doc-common
872 .ds doc-section-name NAME
873 .ds doc-section-synopsis SYNOPSIS
874 .ds doc-section-library LIBRARY
875 .ds doc-section-description DESCRIPTION
876 .ds doc-section-see-also SEE
877 .ds doc-section-files FILES
878 .ds doc-section-authors AUTHORS
881 . ie \n[doc-arg-limit] \{\
882 . \" we only allow `Sh' within `Sh'; it will change the font back to
884 . ie "\*[doc-macro-name]"Sh" \{\
886 . ie (\n[doc-arg-limit] >= \n[doc-arg-ptr]) \{\
887 . nr doc-curr-font \n[.f]
888 . nr doc-curr-size \n[.ps]
889 . nop \*[doc-Sh-font]\c
890 . doc-print-recursive
893 . tm Usage: .Sh section_name ... (#\n[.c])
897 . tm Usage: .Sh not callable by other macros (#\n[.c])
902 . tm Usage: .Sh section_name ... (#\n[.c])
906 . ds doc-macro-name Sh
912 . \" this resolves e.g. `.Sh "SEE ALSO"'
913 . doc-first-parameter \$*
915 . ie "\*[doc-str-dfp]"\*[doc-section-name]" \{\
920 . nr doc-in-synopsis-section 0
921 . nr doc-in-library-section 0
922 . nr doc-in-see-also-section 0
923 . nr doc-in-files-section 0
924 . nr doc-in-authors-section 0
926 . ie "\*[doc-str-dfp]"\*[doc-section-synopsis]" \{\
929 . nr doc-in-synopsis-section 1
930 . nr doc-indent-synopsis 0
931 . nr doc-indent-synopsis-active 0
933 . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-library]" \{\
934 . nr doc-in-library-section 1
936 . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-description]" \{\
938 . nr doc-func-count 0
939 . nr doc-func-args-processed 0
940 . nr doc-num-func-args 0
942 . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-see-also]" \{\
945 . nr doc-in-see-also-section 1
947 . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-files]" \
948 . nr doc-in-files-section 1
949 . el .if "\*[doc-str-dfp]"\*[doc-section-authors]" \
950 . nr doc-in-authors-section 1
954 . nr doc-have-author 0
957 . doc-setup-page-layout
966 . nr doc-reg-Sh \n[.ss]
967 . nr doc-reg-Sh1 \n[.sss]
968 . ss (\n[.ss] * 5 / 3) (\n[.sss] * 5 / 3)
972 . nr doc-curr-font \n[.f]
973 . nr doc-curr-size \n[.ps]
974 . nop \*[doc-Sh-font]\c
975 . doc-print-recursive
978 . ss \n[doc-reg-Sh] \n[doc-reg-Sh1]
980 . in +\n[doc-subheader-indent]u
988 .\" NS Ss user macro (not callable)
991 .\" NS local variable:
995 .\" NS width register `Ss' set above
998 . ie \n[doc-arg-limit] \{\
999 . \" we only allow `Ss' within `Ss'; it will change the font back to
1001 . ie "\*[doc-macro-name]"Ss" \{\
1003 . ie (\n[doc-arg-limit] >= \n[doc-arg-ptr]) \{\
1004 . nr doc-curr-font \n[.f]
1005 . nr doc-curr-size \n[.ps]
1006 . nop \*[doc-Sh-font]\c
1007 . doc-print-recursive
1010 . tm Usage: .Ss subsection_name ... (#\n[.c])
1014 . tm Usage: .Ss not callable by other macros (#\n[.c])
1019 . tm Usage: .Ss subsection_name ... (#\n[.c])
1023 . ds doc-macro-name Ss
1024 . doc-parse-args \$@
1031 . nr doc-reg-Ss \n[.ss]
1032 . nr doc-reg-Ss1 \n[.sss]
1033 . ss (\n[.ss] * 5 / 4) (\n[.sss] * 5 / 4)
1036 . nr doc-curr-font \n[.f]
1037 . nr doc-curr-size \n[.ps]
1038 . nop \*[doc-Sh-font]\c
1039 . doc-print-recursive
1041 . ss \n[doc-reg-Ss] \n[doc-reg-Ss1]
1054 .\" NS Rd macro (not parsed, not callable)
1055 .\" NS print global register dump to stderr
1057 .\" NS local variables:
1061 . tm MDOC GLOBAL REGISTER DUMP
1062 . tm doc-macro-name == `\*[doc-macro-name]'
1063 . tm doc-arg-limit == \n[doc-arg-limit]
1064 . tm doc-num-args == \n[doc-num-args]
1065 . tm doc-arg-ptr == \n[doc-arg-ptr]
1068 . while (\n[doc-reg-Rd] <= \n[doc-arg-limit]) \{\
1069 . tm doc-arg\n[doc-reg-Rd] == `\*[doc-arg\n[doc-reg-Rd]]'
1070 . tm doc-type\n[doc-reg-Rd] == \n[doc-type\n[doc-reg-Rd]]
1071 . tm doc-space\n[doc-reg-Rd] == `\*[doc-space\n[doc-reg-Rd]]'
1075 . tm doc-curr-font == \n[doc-curr-font]
1076 . tm doc-curr-size == \n[doc-curr-size]
1077 . tm doc-indent-synopsis == \n[doc-indent-synopsis]
1078 . tm doc-indent-synopsis-active == \n[doc-indent-synopsis-active]
1079 . tm doc-have-decl == \n[doc-have-decl]
1080 . tm doc-have-var == \n[doc-have-var]
1081 . tm doc-command-name == `\*[doc-command-name]'
1082 . tm doc-quote-left == `\*[doc-quote-left]'
1083 . tm doc-quote-right == `\*[doc-quote-right]'
1084 . tm doc-nesting-level == \n[doc-nesting-level]
1085 . tm doc-in-list == \n[doc-in-list]
1086 . tm doc-space == `\*[doc-space]'
1087 . tm doc-saved-space == `\*[doc-saved-space]'
1088 . tm doc-space-mode == \n[doc-space-mode]
1089 . tm doc-have-space == \n[doc-have-space]
1090 . tm doc-have-slot == \n[doc-have-slot]
1091 . tm doc-keep-type == \n[doc-keep-type]
1092 . tm doc-display-depth == \n[doc-display-depth]
1093 . tm doc-is-compact == \n[doc-is-compact]
1096 . while (\n[doc-reg-Rd] <= \n[doc-display-depth]) \{\
1097 . tm doc-display-type-stack\n[doc-reg-Rd] == `\*[doc-display-type-stack\n[doc-reg-Rd]]'
1098 . tm doc-display-indent-stack\n[doc-reg-Rd] == \n[doc-display-indent-stack\n[doc-reg-Rd]]
1099 . tm doc-display-ad-stack\n[doc-reg-Rd] == \n[doc-display-ad-stack\n[doc-reg-Rd]]
1100 . tm doc-display-fi-stack\n[doc-reg-Rd] == \n[doc-display-fi-stack\n[doc-reg-Rd]]
1101 . tm doc-display-ft-stack\n[doc-reg-Rd] == \n[doc-display-ft-stack\n[doc-reg-Rd]]
1102 . tm doc-display-ps-stack\n[doc-reg-Rd] == \n[doc-display-ps-stack\n[doc-reg-Rd]]
1106 . tm doc-fontmode-depth == \n[doc-fontmode-depth]
1109 . while (\n[doc-reg-Rd] <= \n[doc-fontmode-depth]) \{\
1110 . tm doc-fontmode-font-stack\n[doc-reg-Rd] == `\n[doc-fontmode-font-stack\n[doc-reg-Rd]]'
1111 . tm doc-fontmode-size-stack\n[doc-reg-Rd] == `\n[doc-fontmode-size-stack\n[doc-reg-Rd]]'
1115 . tm doc-list-depth == \n[doc-list-depth]
1118 . while (\n[doc-reg-Rd] <= \n[doc-list-depth]) \{\
1119 . tm doc-list-type-stack\n[doc-reg-Rd] == `\*[doc-list-type-stack\n[doc-reg-Rd]]'
1120 . tm doc-list-have-indent-stack\n[doc-reg-Rd] == \n[doc-list-have-indent-stack\n[doc-reg-Rd]]
1121 . tm doc-list-indent-stack\n[doc-reg-Rd] == \n[doc-list-indent-stack\n[doc-reg-Rd]]
1122 . tm doc-compact-list-stack\n[doc-reg-Rd] == \n[doc-compact-list-stack\n[doc-reg-Rd]]
1123 . tm doc-tag-prefix-stack\n[doc-reg-Rd] == `\*[doc-tag-prefix-stack\n[doc-reg-Rd]]'
1124 . tm doc-tag-width-stack\n[doc-reg-Rd] == `\*[doc-tag-width-stack\n[doc-reg-Rd]]'
1125 . tm doc-list-offset-stack\n[doc-reg-Rd] == \n[doc-list-offset-stack\n[doc-reg-Rd]]
1126 . tm doc-enum-list-count-stack\n[doc-reg-Rd] == \n[doc-enum-list-count-stack\n[doc-reg-Rd]]
1130 . tm doc-saved-Pa-font == `\*[doc-saved-Pa-font]'
1131 . tm doc-curr-type == \n[doc-curr-type]
1132 . tm doc-curr-arg == `\*[doc-curr-arg]'
1133 . tm doc-diag-list-input-line-count == \n[doc-diag-list-input-line-count]
1134 . tm doc-num-columns == \n[doc-num-columns]
1135 . tm doc-column-indent-width == \n[doc-column-indent-width]
1136 . tm doc-is-func == \n[doc-is-func]
1137 . tm doc-have-old-func == \n[doc-have-old-func]
1138 . tm doc-func-arg-count == \n[doc-func-arg-count]
1139 . tm doc-func-arg == `\*[doc-func-arg]'
1140 . tm doc-num-func-args == \n[doc-num-func-args]
1141 . tm doc-func-args-processed == \n[doc-func-args-processed]
1142 . tm doc-have-func == \n[doc-have-func]
1143 . tm doc-is-reference == \n[doc-is-reference]
1144 . tm doc-reference-count == \n[doc-reference-count]
1145 . tm doc-author-count == \n[doc-author-count]
1148 . while (\n[doc-reg-Rd] <= \n[doc-author-count]) \{\
1149 . tm doc-author-name\n[doc-reg-Rd] == `\*[doc-author-name\n[doc-reg-Rd]]'
1153 . tm doc-book-count == \n[doc-book-count]
1154 . tm doc-book-name == `\*[doc-book-name]'
1155 . tm doc-date-count == \n[doc-date-count]
1156 . tm doc-date == `\*[doc-date]'
1157 . tm doc-publisher-count == \n[doc-publisher-count]
1158 . tm doc-publisher-name == `\*[doc-publisher-name]'
1159 . tm doc-journal-count == \n[doc-journal-count]
1160 . tm doc-journal-name == `\*[doc-journal-name]'
1161 . tm doc-issue-count == \n[doc-issue-count]
1162 . tm doc-issue-name == `\*[doc-issue-name]'
1163 . tm doc-optional-count == \n[doc-optional-count]
1164 . tm doc-optional-string == `\*[doc-optional-string]'
1165 . tm doc-page-number-count == \n[doc-page-number-count]
1166 . tm doc-page-number-string == `\*[doc-page-number-string]'
1167 . tm doc-corporate-count == \n[doc-corporate-count]
1168 . tm doc-corporate-name == `\*[doc-corporate-name]'
1169 . tm doc-report-count == \n[doc-report-count]
1170 . tm doc-report-name == `\*[doc-report-name]'
1171 . tm doc-reference-title-count == \n[doc-reference-title-count]
1172 . tm doc-reference-title-name == `\*[doc-reference-title-name]'
1173 . tm doc-reference-title-name-for-book == `\*[doc-reference-title-name-for-book]'
1174 . tm doc-volume-count == \n[doc-volume-count]
1175 . tm doc-volume-name == `\*[doc-volume-name]'
1176 . tm doc-have-author == \n[doc-have-author]
1178 . tm doc-document-title == `\*[doc-document-title]'
1179 . tm doc-volume == `\*[doc-volume]'
1180 . tm doc-section == `\*[doc-section]'
1181 . tm doc-operating-system == `\*[doc-operating-system]'
1182 . tm doc-date-string == `\*[doc-date-string]'
1183 . tm doc-header-space == \n[doc-header-space]
1184 . tm doc-footer-space == \n[doc-footer-space]
1185 . tm doc-display-vertical == \n[doc-display-vertical]
1186 . tm doc-header-string == `\*[doc-header-string]'
1187 . tm doc-in-synopsis-section == \n[doc-in-synopsis-section]
1188 . tm doc-in-library-section == \n[doc-in-library-section]
1189 . tm doc-in-see-also-section == \n[doc-in-see-also-section]
1190 . tm doc-in-files-section == \n[doc-in-files-section]
1191 . tm doc-in-authors-section == \n[doc-in-authors-section]
1193 . tm END OF GLOBAL REGISTER DUMP