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.
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.
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
32 .\" @(#)doc-common 8.1 (Berkeley) 06/08/93
37 .\" Macro Identifiers. For each user macro a corresponding register with
38 .\" the same name must exist. Its value must not be zero.
80 .nr Ds 6n\" many manpages still use this as a -width value
154 .\" macros which must be processed after the closing delimiter of `Op'
170 .nr doc-display-indent 6n
175 .ds doc-soft-space " \"
176 .ds doc-hard-space \~
183 .\" punctuation values (suffix=3, prefix=4)
197 .\" header assembly macros
199 .\" NS doc-document-title global string
200 .\" NS the title of the manual page
202 .ds doc-document-title UNTITLED
205 .\" NS doc-volume global string
206 .\" NS the volume where the manual page belongs to
211 .\" NS doc-section global string
212 .\" NS the manual section
217 .\" NS Dt user macro (not parsed, not callable)
218 .\" NS document title
221 .\" NS doc-document-title
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
326 . ds doc-document-title "\$1
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]
339 . ds doc-volume "\*[doc-volume-operating-system]
341 . if d doc-volume-as-\$3 \
342 . as doc-volume "/\*[doc-volume-as-\$3]
344 . as doc-volume " \*[doc-volume-ds-\$2]
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
355 . if d doc-volume-ds-\$3 \
356 . ds doc-volume "\*[doc-volume-ds-\$3]
360 . if "\*[doc-volume]"LOCAL" \
365 .\" NS doc-default-operating-system global string
366 .\" NS the exact (default) version of the operating system
368 .\" NS override this in `mdoc.local', if necessary
370 .ds doc-default-operating-system BSD
373 .\" NS doc-operating-system global string
374 .\" NS the exact version of the operating system
376 .ds doc-operating-system
379 .\" NS Os user macro (not parsed, not callable)
380 .\" NS operating system
383 .\" NS doc-operating-system
385 .\" NS local variables:
386 .\" NS doc-operating-system-XXX-XXX
388 .\" NS width register `Os' set above
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
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
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
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
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]
490 . as doc-operating-system " UNIX
492 . el \{ .ie "\$1"BSD" \{\
494 . ie d doc-operating-system-BSD-\$2 \
495 . ds doc-operating-system "\*[doc-operating-system-BSD-\$2]
497 . tm mdoc warning: .Os: Unknown BSD version `\$2' (#\n[.c])
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]
505 . tm mdoc warning: .Os: Unknown FreeBSD version `\$2' (#\n[.c])
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]
513 . tm mdoc warning: .Os: Unknown NetBSD version `\$2' (#\n[.c])
516 . ds doc-operating-system \$1
518 . as doc-operating-system " \$2
523 .\" NS doc-date-string global string
524 .\" NS the manual page date as set by `Dd'
529 .\" NS Dd user macro (not parsed, not callable)
530 .\" NS set document date
533 .\" NS doc-date-string
535 .\" NS local variables:
538 .\" NS width register `Dd' set above
540 .ds doc-date-1 January
541 .ds doc-date-2 February
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
556 . ds doc-date-string \$1\~\$2 \$3
558 . ds doc-date-string "\*[doc-date-\n[mo]]
559 . as doc-date-string \~\n[dy], \n[year]
563 . ds doc-date-string Epoch
567 .\" NS doc-hyphen-flags global register
568 .\" NS the parameter for the `.hy' request
570 .\" NS override this in `mdoc.local', if necessary.
572 .nr doc-hyphen-flags 12
575 .\" NS doc-header macro
576 .\" NS print page header
578 .\" NS local variables:
584 . doc-setup-page-layout
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[]'
594 . as doc-header-string "\|.\|.\|.
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
598 . sp \n[doc-header-space]u
606 .\" NS doc-footer macro
607 .\" NS print page footer
613 . ev doc-caption-enviroment
614 . doc-setup-page-layout
615 . sp \n[doc-footer-space]u
618 . tl
\a%
\a\*[doc-caption-font2]\*[doc-date-string]\f[]
\a\*[doc-caption-font]\*[doc-operating-system]\f[]
\a
620 . tl
\a\*[doc-caption-font]\*[doc-operating-system]\f[]
\a\*[doc-caption-font2]\*[doc-date-string]\f[]
\a%
\a
623 . tl
\a\*[doc-caption-font]\*[doc-operating-system]\f[]
\a\*[doc-caption-font2]\*[doc-date-string]\f[]
\a%
\a
630 .\" NS doc-check-depth macro
631 .\" NS check paired macros
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
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
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
649 .\" NS doc-end-macro 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
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
676 .\" NS doc-paragraph macro
677 .\" NS insert a paragraph
680 . sp \n[doc-paragraph-space]u
687 .\" NS Pp user macro (not parsed, not callable)
690 .\" NS width register `Pp' set above
692 .als Pp doc-paragraph
695 .\" NS Lp user macro (not parsed, not callable)
698 .\" NS width register `Lp' set above
700 .als Lp doc-paragraph
704 . tm Not a \-mdoc command: .LP (#\n[.c])
709 . tm Not a \-mdoc command: .PP (#\n[.c])
714 . tm Not a \-mdoc command: .pp (#\n[.c])
719 . tm Not a \-mdoc command: .SH (#\n[.c])
723 .\" NS Nd user macro (not parsed, not callable)
724 .\" NS print name description
726 .\" NS width register `Nd' set above
733 .\" NS doc-in-synopsis-section global register (bool)
734 .\" NS whether we are in the `synopsis' section
736 .nr doc-in-synopsis-section 0
739 .\" NS doc-in-library-section global register (bool)
740 .\" NS whether we are in the `library' section
742 .nr doc-in-library-section 0
745 .\" NS doc-in-see-also-section global register (bool)
746 .\" NS whether we are in the `see also' section
748 .nr doc-in-see-also-section 0
751 .\" NS doc-in-files-section global register (bool)
752 .\" NS whether we are in the `files' section
754 .nr doc-in-files-section 0
757 .\" NS doc-in-authors-section global register (bool)
758 .\" NS whether we are in the `authors' section
760 .nr doc-in-authors-section 0
763 .\" NS doc-first-parameter macro
764 .\" NS return first parameter
766 .\" NS local variables:
769 .de doc-first-parameter
770 . ds doc-str-dfp "\$1
774 .\" NS Sh user macro (not callable)
775 .\" NS section headers
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
788 .\" NS doc-num-func-args
790 .\" NS local variables:
793 .\" NS doc-section-XXX
795 .\" NS width register `Sh' set in doc-common
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
806 . ie \n[doc-arg-limit] \{\
807 . \" we only allow `Sh' within `Sh'; it will change the font back to
809 . ie "\*[doc-macro-name]"Sh" \{\
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
818 . tm Usage: .Sh section_name ... (#\n[.c])
822 . tm Usage: .Sh not callable by other macros (#\n[.c])
827 . tm Usage: .Sh section_name ... (#\n[.c])
831 . ds doc-macro-name Sh
837 . \" this resolves e.g. `.Sh "SEE ALSO"'
838 . doc-first-parameter \$*
840 . ie "\*[doc-str-dfp]"\*[doc-section-name]" \{\
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
851 . ie "\*[doc-str-dfp]"\*[doc-section-synopsis]" \{\
854 . nr doc-in-synopsis-section 1
855 . nr doc-indent-synopsis 0
856 . nr doc-indent-synopsis-active 0
858 . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-library]" \{\
859 . nr doc-in-library-section 1
861 . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-description]" \{\
863 . nr doc-func-count 0
864 . nr doc-func-args-processed 0
865 . nr doc-num-func-args 0
867 . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-see-also]" \{\
870 . nr doc-in-see-also-section 1
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
879 . nr doc-have-author 0
882 . doc-setup-page-layout
891 . nr doc-reg-Sh \n[.ss]
892 . nr doc-reg-Sh1 \n[.sss]
893 . ss (\n[.ss] * 5 / 3) (\n[.sss] * 5 / 3)
897 . nr doc-curr-font \n[.f]
898 . nr doc-curr-size \n[.ps]
899 . nop \*[doc-Sh-font]\c
900 . doc-print-recursive
903 . ss \n[doc-reg-Sh] \n[doc-reg-Sh1]
905 . in +\n[doc-subheader-indent]u
913 .\" NS Ss user macro (not callable)
916 .\" NS local variable:
920 .\" NS width register `Ss' set above
923 . ie \n[doc-arg-limit] \{\
924 . \" we only allow `Ss' within `Ss'; it will change the font back to
926 . ie "\*[doc-macro-name]"Ss" \{\
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
935 . tm Usage: .Ss subsection_name ... (#\n[.c])
939 . tm Usage: .Ss not callable by other macros (#\n[.c])
944 . tm Usage: .Ss subsection_name ... (#\n[.c])
948 . ds doc-macro-name Ss
956 . nr doc-reg-Ss \n[.ss]
957 . nr doc-reg-Ss1 \n[.sss]
958 . ss (\n[.ss] * 5 / 4) (\n[.sss] * 5 / 4)
961 . nr doc-curr-font \n[.f]
962 . nr doc-curr-size \n[.ps]
963 . nop \*[doc-Sh-font]\c
964 . doc-print-recursive
966 . ss \n[doc-reg-Ss] \n[doc-reg-Ss1]
979 .\" NS Rd macro (not parsed, not callable)
980 .\" NS print global register dump to stderr
982 .\" NS local variables:
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]
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]]'
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]
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]]
1031 . tm doc-fontmode-depth == \n[doc-fontmode-depth]
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]]'
1040 . tm doc-list-depth == \n[doc-list-depth]
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]]
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]
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]]'
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]
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]
1118 . tm END OF GLOBAL REGISTER DUMP