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
152 .\" macros which must be processed after the closing delimiter of `Op'
168 .nr doc-display-indent 6n
173 .ds doc-soft-space " \"
174 .ds doc-hard-space \~
181 .\" punctuation values (suffix=3, prefix=4)
195 .\" header assembly macros
197 .\" NS doc-document-title global string
198 .\" NS the title of the manual page
200 .ds doc-document-title UNTITLED
203 .\" NS doc-volume global string
204 .\" NS the volume where the manual page belongs to
209 .\" NS doc-section global string
210 .\" NS the manual section
215 .\" NS Dt user macro (not parsed, not callable)
216 .\" NS document title
219 .\" NS doc-document-title
223 .\" NS local variables:
224 .\" NS doc-volume-as-XXX
225 .\" NS doc-volume-ds-XXX
227 .\" NS width register `Dt' set above
229 .\" an alternative, more detailed scheme for naming the manual sections
231 .ds doc-volume-operating-system BSD
232 .nr doc-volume-operating-system-ateol 0
233 .ds doc-volume-ds-1 General Commands Manual
234 .ds doc-volume-ds-2 System Calls Manual
235 .ds doc-volume-ds-3 Library Functions Manual
236 .ds doc-volume-ds-4 Kernel Interfaces Manual
237 .ds doc-volume-ds-5 File Formats Manual
238 .ds doc-volume-ds-6 Games Manual
239 .ds doc-volume-ds-7 Miscellaneous Information Manual
240 .ds doc-volume-ds-8 System Manager's Manual
241 .ds doc-volume-ds-9 Kernel Developer's Manual
243 .ds doc-volume-ds-USD User's Supplementary Documents
244 .ds doc-volume-ds-PS1 Programmer's Supplementary Documents
245 .ds doc-volume-ds-AMD Ancestral Manual Documents
246 .ds doc-volume-ds-SMM System Manager's Manual
247 .ds doc-volume-ds-URM User's Reference Manual
248 .ds doc-volume-ds-PRM Programmer's Manual
249 .ds doc-volume-ds-KM Kernel Manual
250 .ds doc-volume-ds-IND Manual Master Index
251 .ds doc-volume-ds-LOCAL Local Manual
252 .ds doc-volume-ds-CON Contributed Software Manual
254 .als doc-volume-ds-MMI doc-volume-ds-IND
255 .als doc-volume-ds-LOC doc-volume-ds-LOCAL
257 .ds doc-volume-as-alpha alpha
258 .als doc-volume-as-Alpha doc-volume-as-alpha
259 .ds doc-volume-as-acorn26 acorn26
260 .ds doc-volume-as-acorn32 acorn32
261 .ds doc-volume-as-algor algor
262 .ds doc-volume-as-amd64 amd64
263 .ds doc-volume-as-amiga amiga
264 .ds doc-volume-as-arc arc
265 .ds doc-volume-as-arm26 arm26
266 .ds doc-volume-as-arm32 arm32
267 .ds doc-volume-as-atari atari
268 .ds doc-volume-as-bebox bebox
269 .ds doc-volume-as-cats cats
270 .ds doc-volume-as-cesfic cesfic
271 .ds doc-volume-as-cobalt cobalt
272 .ds doc-volume-as-dreamcast dreamcast
273 .ds doc-volume-as-evbarm evbarm
274 .ds doc-volume-as-evbmips evbmips
275 .ds doc-volume-as-evbppc evbppc
276 .ds doc-volume-as-evbsh3 evbsh3
277 .ds doc-volume-as-hp300 hp300
278 .ds doc-volume-as-hp700 hp700
279 .ds doc-volume-as-hpcarm hpcarm
280 .ds doc-volume-as-hpcmips hpcmips
281 .ds doc-volume-as-hpcsh hpcsh
282 .ds doc-volume-as-i386 i386
283 .ds doc-volume-as-luna68k luna68k
284 .ds doc-volume-as-m68k m68k
285 .ds doc-volume-as-mac68k mac68k
286 .ds doc-volume-as-macppc macppc
287 .ds doc-volume-as-mips mips
288 .ds doc-volume-as-mipsco mipsco
289 .ds doc-volume-as-mmeye mmeye
290 .ds doc-volume-as-mvme68k mvme68k
291 .ds doc-volume-as-mvmeppc mvmeppc
292 .ds doc-volume-as-netwinder netwinder
293 .ds doc-volume-as-news68k news68k
294 .ds doc-volume-as-newsmips newsmips
295 .ds doc-volume-as-next68k next68k
296 .ds doc-volume-as-ofppc ofppc
297 .ds doc-volume-as-pc532 pc532
298 .ds doc-volume-as-playstation2 playstation2
299 .ds doc-volume-as-pmax pmax
300 .ds doc-volume-as-pmppc pmppc
301 .ds doc-volume-as-powerpc powerpc
302 .ds doc-volume-as-prep prep
303 .ds doc-volume-as-sandpoint sandpoint
304 .ds doc-volume-as-sbmips sbmips
305 .ds doc-volume-as-sgimips sgimips
306 .ds doc-volume-as-sh3 sh3
307 .ds doc-volume-as-shark shark
308 .ds doc-volume-as-sparc sparc
309 .ds doc-volume-as-sparc64 sparc64
310 .ds doc-volume-as-sun2 sun2
311 .ds doc-volume-as-sun3 sun3
312 .ds doc-volume-as-tahoe tahoe
313 .ds doc-volume-as-vax vax
314 .ds doc-volume-as-x68k x68k
315 .ds doc-volume-as-x86_64 x86_64
318 . \" reset default arguments
319 . ds doc-document-title UNTITLED
320 . ds doc-volume LOCAL
321 . ds doc-section Null
324 . ds doc-document-title "\$1
329 . if ((\$2 >= 1) & (\$2 <= 9)) \{\
330 . ie \n[doc-volume-operating-system-ateol] \{\
331 . ds doc-volume "\*[doc-volume-ds-\$2] \*[doc-volume-operating-system]
333 . if d doc-volume-as-\$3 \
334 . as doc-volume "/\*[doc-volume-as-\$3]
337 . ds doc-volume "\*[doc-volume-operating-system]
339 . if d doc-volume-as-\$3 \
340 . as doc-volume "/\*[doc-volume-as-\$3]
342 . as doc-volume " \*[doc-volume-ds-\$2]
346 . ds doc-volume DRAFT
347 . el \{ .ie "\$2"draft" \
348 . ds doc-volume DRAFT
349 . el .if "\$2"paper" \
350 . ds doc-volume UNTITLED
353 . if d doc-volume-ds-\$3 \
354 . ds doc-volume "\*[doc-volume-ds-\$3]
358 . if "\*[doc-volume]"LOCAL" \
363 .\" NS doc-default-operating-system global string
364 .\" NS the exact (default) version of the operating system
366 .\" NS override this in `mdoc.local', if necessary
368 .ds doc-default-operating-system BSD
371 .\" NS doc-operating-system global string
372 .\" NS the exact version of the operating system
374 .ds doc-operating-system
377 .\" NS Os user macro (not parsed, not callable)
378 .\" NS operating system
381 .\" NS doc-operating-system
383 .\" NS local variables:
384 .\" NS doc-operating-system-XXX-XXX
386 .\" NS width register `Os' set above
388 .ds doc-operating-system-ATT-7 7th\~Edition
389 .als doc-operating-system-ATT-7th doc-operating-system-ATT-7
390 .ds doc-operating-system-ATT-3 System\~III
391 .als doc-operating-system-ATT-III doc-operating-system-ATT-3
392 .ds doc-operating-system-ATT-V System\~V
393 .ds doc-operating-system-ATT-V.2 System\~V Release\~2
394 .ds doc-operating-system-ATT-V.3 System\~V Release\~3
395 .ds doc-operating-system-ATT-V.4 System\~V Release\~4
397 .ds doc-operating-system-BSD-3 3rd\~Berkeley Distribution
398 .ds doc-operating-system-BSD-4 4th\~Berkeley Distribution
399 .ds doc-operating-system-BSD-4.1 4.1\~Berkeley Distribution
400 .ds doc-operating-system-BSD-4.2 4.2\~Berkeley Distribution
401 .ds doc-operating-system-BSD-4.3 4.3\~Berkeley Distribution
402 .ds doc-operating-system-BSD-4.3T 4.3-Tahoe Berkeley Distribution
403 .ds doc-operating-system-BSD-4.3R 4.3-Reno Berkeley Distribution
404 .als doc-operating-system-BSD-4.3t doc-operating-system-BSD-4.3T
405 .als doc-operating-system-BSD-4.3r doc-operating-system-BSD-4.3R
406 .ds doc-operating-system-BSD-4.4 4.4BSD
408 .ds doc-operating-system-NetBSD-0.8 0.8
409 .ds doc-operating-system-NetBSD-0.8a 0.8A
410 .ds doc-operating-system-NetBSD-0.9 0.9
411 .ds doc-operating-system-NetBSD-0.9a 0.9A
412 .ds doc-operating-system-NetBSD-1.0 1.0
413 .ds doc-operating-system-NetBSD-1.0a 1.0A
414 .ds doc-operating-system-NetBSD-1.1 1.1
415 .ds doc-operating-system-NetBSD-1.2 1.2
416 .ds doc-operating-system-NetBSD-1.2a 1.2A
417 .ds doc-operating-system-NetBSD-1.2b 1.2B
418 .ds doc-operating-system-NetBSD-1.2c 1.2C
419 .ds doc-operating-system-NetBSD-1.2d 1.2D
420 .ds doc-operating-system-NetBSD-1.2e 1.2E
421 .ds doc-operating-system-NetBSD-1.3 1.3
422 .ds doc-operating-system-NetBSD-1.3a 1.3A
423 .ds doc-operating-system-NetBSD-1.4 1.4
424 .ds doc-operating-system-NetBSD-1.4.1 1.4.1
425 .ds doc-operating-system-NetBSD-1.4.2 1.4.2
426 .ds doc-operating-system-NetBSD-1.4.3 1.4.3
427 .ds doc-operating-system-NetBSD-1.5 1.5
428 .ds doc-operating-system-NetBSD-1.5.1 1.5.1
429 .ds doc-operating-system-NetBSD-1.5.2 1.5.2
430 .ds doc-operating-system-NetBSD-1.5.3 1.5.3
431 .ds doc-operating-system-NetBSD-1.6 1.6
432 .ds doc-operating-system-NetBSD-1.6.1 1.6.1
433 .ds doc-operating-system-NetBSD-1.6.2 1.6.2
434 .ds doc-operating-system-NetBSD-2.0 2.0
435 .ds doc-operating-system-NetBSD-2.0.1 2.0.1
436 .ds doc-operating-system-NetBSD-2.0.2 2.0.2
437 .ds doc-operating-system-NetBSD-2.1 2.1
438 .ds doc-operating-system-NetBSD-3.0 3.0
440 .ds doc-operating-system-FreeBSD-1.0 1.0
441 .ds doc-operating-system-FreeBSD-1.1 1.1
442 .ds doc-operating-system-FreeBSD-1.1.5 1.1.5
443 .ds doc-operating-system-FreeBSD-1.1.5.1 1.1.5.1
444 .ds doc-operating-system-FreeBSD-2.0 2.0
445 .ds doc-operating-system-FreeBSD-2.0.5 2.0.5
446 .ds doc-operating-system-FreeBSD-2.1 2.1
447 .ds doc-operating-system-FreeBSD-2.1.5 2.1.5
448 .ds doc-operating-system-FreeBSD-2.1.6 2.1.6
449 .ds doc-operating-system-FreeBSD-2.1.7 2.1.7
450 .ds doc-operating-system-FreeBSD-2.2 2.2
451 .ds doc-operating-system-FreeBSD-2.2.1 2.2.1
452 .ds doc-operating-system-FreeBSD-2.2.2 2.2.2
453 .ds doc-operating-system-FreeBSD-2.2.5 2.2.5
454 .ds doc-operating-system-FreeBSD-2.2.6 2.2.6
455 .ds doc-operating-system-FreeBSD-2.2.7 2.2.7
456 .ds doc-operating-system-FreeBSD-2.2.8 2.2.8
457 .ds doc-operating-system-FreeBSD-3.0 3.0
458 .ds doc-operating-system-FreeBSD-3.1 3.1
459 .ds doc-operating-system-FreeBSD-3.2 3.2
460 .ds doc-operating-system-FreeBSD-3.3 3.3
461 .ds doc-operating-system-FreeBSD-3.4 3.4
462 .ds doc-operating-system-FreeBSD-3.5 3.5
463 .ds doc-operating-system-FreeBSD-4.0 4.0
464 .ds doc-operating-system-FreeBSD-4.1 4.1
465 .ds doc-operating-system-FreeBSD-4.1.1 4.1.1
466 .ds doc-operating-system-FreeBSD-4.2 4.2
467 .ds doc-operating-system-FreeBSD-4.3 4.3
468 .ds doc-operating-system-FreeBSD-4.4 4.4
469 .ds doc-operating-system-FreeBSD-4.5 4.5
470 .ds doc-operating-system-FreeBSD-4.6 4.6
471 .ds doc-operating-system-FreeBSD-4.6.2 4.6.2
472 .ds doc-operating-system-FreeBSD-4.7 4.7
473 .ds doc-operating-system-FreeBSD-4.8 4.8
474 .ds doc-operating-system-FreeBSD-4.9 4.9
475 .ds doc-operating-system-FreeBSD-4.10 4.10
476 .ds doc-operating-system-FreeBSD-4.11 4.11
477 .ds doc-operating-system-FreeBSD-5.0 5.0
478 .ds doc-operating-system-FreeBSD-5.1 5.1
479 .ds doc-operating-system-FreeBSD-5.2 5.2
480 .ds doc-operating-system-FreeBSD-5.2.1 5.2.1
481 .ds doc-operating-system-FreeBSD-5.3 5.3
482 .ds doc-operating-system-FreeBSD-5.4 5.4
483 .ds doc-operating-system-FreeBSD-6.0 6.0
484 .ds doc-operating-system-FreeBSD-6.1 6.1
486 .ds doc-operating-system-Darwin-8.0.0 8.0.0
487 .ds doc-operating-system-Darwin-8.1.0 8.1.0
488 .ds doc-operating-system-Darwin-8.2.0 8.2.0
489 .ds doc-operating-system-Darwin-8.3.0 8.3.0
493 . ds doc-operating-system "\*[doc-default-operating-system]
494 . el \{ .ie "\$1"ATT" \{\
495 . ds doc-operating-system AT&T
497 . ie d doc-operating-system-ATT-\$2 \
498 . as doc-operating-system " \*[doc-operating-system-ATT-\$2]
500 . as doc-operating-system " UNIX
502 . el \{ .ie "\$1"BSD" \{\
504 . ie d doc-operating-system-BSD-\$2 \
505 . ds doc-operating-system "\*[doc-operating-system-BSD-\$2]
507 . tm mdoc warning: .Os: Unknown BSD version `\$2' (#\n[.c])
509 . el \{ .ie "\$1"FreeBSD" \{\
510 . ds doc-operating-system FreeBSD
512 . ie d doc-operating-system-FreeBSD-\$2 \
513 . as doc-operating-system \~\*[doc-operating-system-FreeBSD-\$2]
515 . tm mdoc warning: .Os: Unknown FreeBSD version `\$2' (#\n[.c])
517 . el \{ .ie "\$1"NetBSD" \{\
518 . ds doc-operating-system NetBSD
520 . ie d doc-operating-system-NetBSD-\$2 \
521 . as doc-operating-system \~\*[doc-operating-system-NetBSD-\$2]
523 . tm mdoc warning: .Os: Unknown NetBSD version `\$2' (#\n[.c])
525 . el \{ .ie "\$1"Darwin" \{\
526 . ds doc-operating-system Darwin
528 . ie d doc-operating-system-Darwin-\$2 \
529 . as doc-operating-system \~\*[doc-operating-system-Darwin-\$2]
531 . tm mdoc warning: .Os: Unknown Darwin version `\$2' (#\n[.c])
534 . ds doc-operating-system \$1
536 . as doc-operating-system " \$2
541 .\" NS doc-date-string global string
542 .\" NS the manual page date as set by `Dd'
547 .\" NS Dd user macro (not parsed, not callable)
548 .\" NS set document date
551 .\" NS doc-date-string
553 .\" NS local variables:
556 .\" NS width register `Dd' set above
558 .ds doc-date-1 January
559 .ds doc-date-2 February
565 .ds doc-date-8 August
566 .ds doc-date-9 September
567 .ds doc-date-10 October
568 .ds doc-date-11 November
569 .ds doc-date-12 December
574 . ds doc-date-string \$1\~\$2 \$3
576 . ds doc-date-string "\*[doc-date-\n[mo]]
577 . as doc-date-string \~\n[dy], \n[year]
581 . ds doc-date-string Epoch
585 .\" NS doc-hyphen-flags global register
586 .\" NS the parameter for the `.hy' request
588 .\" NS override this in `mdoc.local', if necessary.
590 .nr doc-hyphen-flags 12
593 .\" NS doc-header macro
594 .\" NS print page header
596 .\" NS local variables:
602 . doc-setup-page-layout
604 . sp \n[doc-header-space]u
605 . nr doc-reg-dh \w'\*[doc-caption-font]\*[doc-header-string]\f[]'
606 . nr doc-reg-dh1 \w'\*[doc-caption-font2]\*[doc-volume]\f[]'
607 . if (\n[doc-reg-dh] + \n[doc-reg-dh1] + \n[doc-reg-dh] >= \n[.lt]) \{\
608 . while (\n[doc-reg-dh] + \n[doc-reg-dh1] + \n[doc-reg-dh] >= \n[.lt]) \{\
609 . substring doc-header-string 0 -2
610 . nr doc-reg-dh \w'\*[doc-caption-font]\*[doc-header-string]\|.\|.\|.\f[]'
612 . as doc-header-string "\|.\|.\|.
614 . 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
616 . sp \n[doc-header-space]u
624 .\" NS doc-footer macro
625 .\" NS print page footer
631 . ev doc-caption-enviroment
632 . doc-setup-page-layout
633 . sp \n[doc-footer-space]u
636 . tl
\a%
\a\*[doc-caption-font2]\*[doc-date-string]\f[]
\a\*[doc-caption-font]\*[doc-operating-system]\f[]
\a
638 . tl
\a\*[doc-caption-font]\*[doc-operating-system]\f[]
\a\*[doc-caption-font2]\*[doc-date-string]\f[]
\a%
\a
641 . tl
\a\*[doc-caption-font]\*[doc-operating-system]\f[]
\a\*[doc-caption-font2]\*[doc-date-string]\f[]
\a%
\a
648 .\" NS doc-check-depth macro
649 .\" NS check paired macros
652 . if \n[doc-list-depth] \{\
653 . tm mdoc warning: A .Bl directive has no matching .El (#\n[.c])
654 . nr doc-list-depth 0
656 . if \n[doc-display-depth] \{\
657 . tm mdoc warning: A .Bd directive has no matching .Ed (#\n[.c])
658 . nr doc-display-depth 0
660 . if \n[doc-fontmode-depth] \{\
661 . tm mdoc warning: A .Bf directive has no matching .Ef (#\n[.c])
662 . nr doc-fontmode-depth 0
667 .\" NS doc-end-macro macro
671 . \" We may still have a partial line in the environment. If this is the
672 . \" case, and we happen to be on the last line of the page, the `.fl'
673 . \" request will cause the page to be ejected and troff will immediately
674 . \" exit. If we are in nroff mode, this would be unfortunate, since we
675 . \" would never get a chance to output the footer. So we fudge the page
676 . \" length to make sure that the last page is never ejected until we want
687 . 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
688 . \" suppress empty lines after the footer
694 .\" NS doc-paragraph macro
695 .\" NS insert a paragraph
698 . sp \n[doc-paragraph-space]u
705 .\" NS Pp user macro (not parsed, not callable)
708 .\" NS width register `Pp' set above
710 .als Pp doc-paragraph
713 .\" NS Lp user macro (not parsed, not callable)
716 .\" NS width register `Lp' set above
718 .als Lp doc-paragraph
722 . tm Not a \-mdoc command: .LP (#\n[.c])
727 . tm Not a \-mdoc command: .PP (#\n[.c])
732 . tm Not a \-mdoc command: .pp (#\n[.c])
737 . tm Not a \-mdoc command: .SH (#\n[.c])
741 .\" NS Nd user macro (not parsed, not callable)
742 .\" NS print name description
744 .\" NS width register `Nd' set above
751 .\" NS doc-in-synopsis-section global register (bool)
752 .\" NS whether we are in the `synopsis' section
754 .nr doc-in-synopsis-section 0
757 .\" NS doc-in-library-section global register (bool)
758 .\" NS whether we are in the `library' section
760 .nr doc-in-library-section 0
763 .\" NS doc-in-see-also-section global register (bool)
764 .\" NS whether we are in the `see also' section
766 .nr doc-in-see-also-section 0
769 .\" NS doc-in-files-section global register (bool)
770 .\" NS whether we are in the `files' section
772 .nr doc-in-files-section 0
775 .\" NS doc-in-authors-section global register (bool)
776 .\" NS whether we are in the `authors' section
778 .nr doc-in-authors-section 0
781 .\" NS doc-first-parameter macro
782 .\" NS return first parameter
784 .\" NS local variables:
787 .de doc-first-parameter
788 . ds doc-str-dfp "\$1
792 .\" NS Sh user macro (not callable)
793 .\" NS section headers
796 .\" NS doc-func-args-processed
797 .\" NS doc-func-count
798 .\" NS doc-in-authors-section
799 .\" NS doc-in-files-section
800 .\" NS doc-in-library-section
801 .\" NS doc-in-see-also-section
802 .\" NS doc-in-synopsis-section
803 .\" NS doc-indent-synopsis
804 .\" NS doc-indent-synopsis-active
806 .\" NS doc-num-func-args
808 .\" NS local variables:
811 .\" NS doc-section-XXX
813 .\" NS width register `Sh' set in doc-common
815 .ds doc-section-name NAME
816 .ds doc-section-synopsis SYNOPSIS
817 .ds doc-section-library LIBRARY
818 .ds doc-section-description DESCRIPTION
819 .ds doc-section-see-also SEE
820 .ds doc-section-files FILES
821 .ds doc-section-authors AUTHORS
824 . ie \n[doc-arg-limit] \{\
825 . \" we only allow `Sh' within `Sh'; it will change the font back to
827 . ie "\*[doc-macro-name]"Sh" \{\
829 . ie (\n[doc-arg-limit] >= \n[doc-arg-ptr]) \{\
830 . nr doc-curr-font \n[.f]
831 . nr doc-curr-size \n[.ps]
832 . nop \*[doc-Sh-font]\c
833 . doc-print-recursive
836 . tm Usage: .Sh section_name ... (#\n[.c])
840 . tm Usage: .Sh not callable by other macros (#\n[.c])
845 . tm Usage: .Sh section_name ... (#\n[.c])
849 . ds doc-macro-name Sh
855 . \" this resolves e.g. `.Sh "SEE ALSO"'
856 . doc-first-parameter \$*
858 . ie "\*[doc-str-dfp]"\*[doc-section-name]" \{\
863 . nr doc-in-synopsis-section 0
864 . nr doc-in-library-section 0
865 . nr doc-in-see-also-section 0
866 . nr doc-in-files-section 0
867 . nr doc-in-authors-section 0
869 . ie "\*[doc-str-dfp]"\*[doc-section-synopsis]" \{\
872 . nr doc-in-synopsis-section 1
873 . nr doc-indent-synopsis 0
874 . nr doc-indent-synopsis-active 0
876 . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-library]" \{\
877 . nr doc-in-library-section 1
879 . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-description]" \{\
881 . nr doc-func-count 0
882 . nr doc-func-args-processed 0
883 . nr doc-num-func-args 0
885 . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-see-also]" \{\
888 . nr doc-in-see-also-section 1
890 . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-files]" \
891 . nr doc-in-files-section 1
892 . el .if "\*[doc-str-dfp]"\*[doc-section-authors]" \
893 . nr doc-in-authors-section 1
897 . nr doc-have-author 0
900 . doc-setup-page-layout
909 . nr doc-reg-Sh \n[.ss]
910 . nr doc-reg-Sh1 \n[.sss]
911 . ss (\n[.ss] * 5 / 3) (\n[.sss] * 5 / 3)
915 . nr doc-curr-font \n[.f]
916 . nr doc-curr-size \n[.ps]
917 . nop \*[doc-Sh-font]\c
918 . doc-print-recursive
921 . ss \n[doc-reg-Sh] \n[doc-reg-Sh1]
923 . in +\n[doc-subheader-indent]u
931 .\" NS Ss user macro (not callable)
934 .\" NS local variable:
938 .\" NS width register `Ss' set above
941 . ie \n[doc-arg-limit] \{\
942 . \" we only allow `Ss' within `Ss'; it will change the font back to
944 . ie "\*[doc-macro-name]"Ss" \{\
946 . ie (\n[doc-arg-limit] >= \n[doc-arg-ptr]) \{\
947 . nr doc-curr-font \n[.f]
948 . nr doc-curr-size \n[.ps]
949 . nop \*[doc-Sh-font]\c
950 . doc-print-recursive
953 . tm Usage: .Ss subsection_name ... (#\n[.c])
957 . tm Usage: .Ss not callable by other macros (#\n[.c])
962 . tm Usage: .Ss subsection_name ... (#\n[.c])
966 . ds doc-macro-name Ss
974 . nr doc-reg-Ss \n[.ss]
975 . nr doc-reg-Ss1 \n[.sss]
976 . ss (\n[.ss] * 5 / 4) (\n[.sss] * 5 / 4)
979 . nr doc-curr-font \n[.f]
980 . nr doc-curr-size \n[.ps]
981 . nop \*[doc-Sh-font]\c
982 . doc-print-recursive
984 . ss \n[doc-reg-Ss] \n[doc-reg-Ss1]
997 .\" NS Rd macro (not parsed, not callable)
998 .\" NS print global register dump to stderr
1000 .\" NS local variables:
1004 . tm MDOC GLOBAL REGISTER DUMP
1005 . tm doc-macro-name == `\*[doc-macro-name]'
1006 . tm doc-arg-limit == \n[doc-arg-limit]
1007 . tm doc-num-args == \n[doc-num-args]
1008 . tm doc-arg-ptr == \n[doc-arg-ptr]
1011 . while (\n[doc-reg-Rd] <= \n[doc-arg-limit]) \{\
1012 . tm doc-arg\n[doc-reg-Rd] == `\*[doc-arg\n[doc-reg-Rd]]'
1013 . tm doc-type\n[doc-reg-Rd] == \n[doc-type\n[doc-reg-Rd]]
1014 . tm doc-space\n[doc-reg-Rd] == `\*[doc-space\n[doc-reg-Rd]]'
1018 . tm doc-curr-font == \n[doc-curr-font]
1019 . tm doc-curr-size == \n[doc-curr-size]
1020 . tm doc-indent-synopsis == \n[doc-indent-synopsis]
1021 . tm doc-indent-synopsis-active == \n[doc-indent-synopsis-active]
1022 . tm doc-have-decl == \n[doc-have-decl]
1023 . tm doc-have-var == \n[doc-have-var]
1024 . tm doc-command-name == `\*[doc-command-name]'
1025 . tm doc-quote-left == `\*[doc-quote-left]'
1026 . tm doc-quote-right == `\*[doc-quote-right]'
1027 . tm doc-nesting-level == \n[doc-nesting-level]
1028 . tm doc-in-list == \n[doc-in-list]
1029 . tm doc-space == `\*[doc-space]'
1030 . tm doc-saved-space == `\*[doc-saved-space]'
1031 . tm doc-space-mode == \n[doc-space-mode]
1032 . tm doc-have-space == \n[doc-have-space]
1033 . tm doc-have-slot == \n[doc-have-slot]
1034 . tm doc-keep-type == \n[doc-keep-type]
1035 . tm doc-display-depth == \n[doc-display-depth]
1036 . tm doc-is-compact == \n[doc-is-compact]
1039 . while (\n[doc-reg-Rd] <= \n[doc-display-depth]) \{\
1040 . tm doc-display-type-stack\n[doc-reg-Rd] == `\*[doc-display-type-stack\n[doc-reg-Rd]]'
1041 . tm doc-display-indent-stack\n[doc-reg-Rd] == \n[doc-display-indent-stack\n[doc-reg-Rd]]
1042 . tm doc-display-ad-stack\n[doc-reg-Rd] == \n[doc-display-ad-stack\n[doc-reg-Rd]]
1043 . tm doc-display-fi-stack\n[doc-reg-Rd] == \n[doc-display-fi-stack\n[doc-reg-Rd]]
1044 . tm doc-display-ft-stack\n[doc-reg-Rd] == \n[doc-display-ft-stack\n[doc-reg-Rd]]
1045 . tm doc-display-ps-stack\n[doc-reg-Rd] == \n[doc-display-ps-stack\n[doc-reg-Rd]]
1049 . tm doc-fontmode-depth == \n[doc-fontmode-depth]
1052 . while (\n[doc-reg-Rd] <= \n[doc-fontmode-depth]) \{\
1053 . tm doc-fontmode-font-stack\n[doc-reg-Rd] == `\n[doc-fontmode-font-stack\n[doc-reg-Rd]]'
1054 . tm doc-fontmode-size-stack\n[doc-reg-Rd] == `\n[doc-fontmode-size-stack\n[doc-reg-Rd]]'
1058 . tm doc-list-depth == \n[doc-list-depth]
1061 . while (\n[doc-reg-Rd] <= \n[doc-list-depth]) \{\
1062 . tm doc-list-type-stack\n[doc-reg-Rd] == `\*[doc-list-type-stack\n[doc-reg-Rd]]'
1063 . tm doc-list-have-indent-stack\n[doc-reg-Rd] == \n[doc-list-have-indent-stack\n[doc-reg-Rd]]
1064 . tm doc-list-indent-stack\n[doc-reg-Rd] == \n[doc-list-indent-stack\n[doc-reg-Rd]]
1065 . tm doc-compact-list-stack\n[doc-reg-Rd] == \n[doc-compact-list-stack\n[doc-reg-Rd]]
1066 . tm doc-tag-prefix-stack\n[doc-reg-Rd] == `\*[doc-tag-prefix-stack\n[doc-reg-Rd]]'
1067 . tm doc-tag-width-stack\n[doc-reg-Rd] == `\*[doc-tag-width-stack\n[doc-reg-Rd]]'
1068 . tm doc-list-offset-stack\n[doc-reg-Rd] == \n[doc-list-offset-stack\n[doc-reg-Rd]]
1069 . tm doc-enum-list-count-stack\n[doc-reg-Rd] == \n[doc-enum-list-count-stack\n[doc-reg-Rd]]
1073 . tm doc-saved-Pa-font == `\*[doc-saved-Pa-font]'
1074 . tm doc-curr-type == \n[doc-curr-type]
1075 . tm doc-curr-arg == `\*[doc-curr-arg]'
1076 . tm doc-diag-list-input-line-count == \n[doc-diag-list-input-line-count]
1077 . tm doc-num-columns == \n[doc-num-columns]
1078 . tm doc-column-indent-width == \n[doc-column-indent-width]
1079 . tm doc-is-func == \n[doc-is-func]
1080 . tm doc-have-old-func == \n[doc-have-old-func]
1081 . tm doc-func-arg-count == \n[doc-func-arg-count]
1082 . tm doc-func-arg == `\*[doc-func-arg]'
1083 . tm doc-num-func-args == \n[doc-num-func-args]
1084 . tm doc-func-args-processed == \n[doc-func-args-processed]
1085 . tm doc-have-func == \n[doc-have-func]
1086 . tm doc-is-reference == \n[doc-is-reference]
1087 . tm doc-reference-count == \n[doc-reference-count]
1088 . tm doc-author-count == \n[doc-author-count]
1091 . while (\n[doc-reg-Rd] <= \n[doc-author-count]) \{\
1092 . tm doc-author-name\n[doc-reg-Rd] == `\*[doc-author-name\n[doc-reg-Rd]]'
1096 . tm doc-book-count == \n[doc-book-count]
1097 . tm doc-book-name == `\*[doc-book-name]'
1098 . tm doc-date-count == \n[doc-date-count]
1099 . tm doc-date == `\*[doc-date]'
1100 . tm doc-publisher-count == \n[doc-publisher-count]
1101 . tm doc-publisher-name == `\*[doc-publisher-name]'
1102 . tm doc-journal-count == \n[doc-journal-count]
1103 . tm doc-journal-name == `\*[doc-journal-name]'
1104 . tm doc-issue-count == \n[doc-issue-count]
1105 . tm doc-issue-name == `\*[doc-issue-name]'
1106 . tm doc-optional-count == \n[doc-optional-count]
1107 . tm doc-optional-string == `\*[doc-optional-string]'
1108 . tm doc-page-number-count == \n[doc-page-number-count]
1109 . tm doc-page-number-string == `\*[doc-page-number-string]'
1110 . tm doc-corporate-count == \n[doc-corporate-count]
1111 . tm doc-corporate-name == `\*[doc-corporate-name]'
1112 . tm doc-report-count == \n[doc-report-count]
1113 . tm doc-report-name == `\*[doc-report-name]'
1114 . tm doc-reference-title-count == \n[doc-reference-title-count]
1115 . tm doc-reference-title-name == `\*[doc-reference-title-name]'
1116 . tm doc-reference-title-name-for-book == `\*[doc-reference-title-name-for-book]'
1117 . tm doc-volume-count == \n[doc-volume-count]
1118 . tm doc-volume-name == `\*[doc-volume-name]'
1119 . tm doc-have-author == \n[doc-have-author]
1121 . tm doc-document-title == `\*[doc-document-title]'
1122 . tm doc-volume == `\*[doc-volume]'
1123 . tm doc-section == `\*[doc-section]'
1124 . tm doc-operating-system == `\*[doc-operating-system]'
1125 . tm doc-date-string == `\*[doc-date-string]'
1126 . tm doc-header-space == \n[doc-header-space]
1127 . tm doc-footer-space == \n[doc-footer-space]
1128 . tm doc-display-vertical == \n[doc-display-vertical]
1129 . tm doc-header-string == `\*[doc-header-string]'
1130 . tm doc-in-synopsis-section == \n[doc-in-synopsis-section]
1131 . tm doc-in-library-section == \n[doc-in-library-section]
1132 . tm doc-in-see-also-section == \n[doc-in-see-also-section]
1133 . tm doc-in-files-section == \n[doc-in-files-section]
1134 . tm doc-in-authors-section == \n[doc-in-authors-section]
1136 . tm END OF GLOBAL REGISTER DUMP