2 .\"@ Common strings, definitions, stuff related typographic output.
3 .\"@ See doc.tmac for more on the mdoc semantic markup language.
5 .\" Copyright (c) 1991, 1993
6 .\" The Regents of the University of California. All rights reserved.
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\" notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\" notice, this list of conditions and the following disclaimer in the
15 .\" documentation and/or other materials provided with the distribution.
17 .\" ftp://ftp.cs.berkeley.edu/pub/4bsd/README.Impt.License.Change]
18 .\" 4. Neither the name of the University nor the names of its contributors
19 .\" may be used to endorse or promote products derived from this software
20 .\" without specific prior written permission.
22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 .\" @(#)doc-common 8.1 (Berkeley) 06/08/93
35 .\" Adapted to S-roff by Steffen (Daode) Nurpmeso <sdaoden@users.sf.net>.
40 .\" Macro Identifiers. For each user macro a corresponding register with
41 .\" the same name must exist. Its value must not be zero.
84 .nr Ds 6n\" many manpages still use this as a -width value
158 .\" macros which must be processed after the closing delimiter of `Op'
174 .nr doc-display-indent 6n
179 .ds doc-soft-space " \"
180 .ds doc-hard-space \~
187 .\" punctuation values (suffix=3, prefix=4)
201 .\" header assembly macros
203 .\" NS doc-document-title global string
204 .\" NS the title of the manual page
206 .ds doc-document-title UNTITLED
209 .\" NS doc-volume global string
210 .\" NS the volume where the manual page belongs to
215 .\" NS doc-section global string
216 .\" NS the manual section
221 .\" NS Dt user macro (not parsed, not callable)
222 .\" NS document title
225 .\" NS doc-document-title
228 .\" NS doc-command-name
230 .\" NS local variables:
231 .\" NS doc-volume-as-XXX
232 .\" NS doc-volume-ds-XXX
234 .\" NS width register `Dt' set above
236 .\" an alternative, more detailed scheme for naming the manual sections
238 .ds doc-volume-operating-system BSD
239 .nr doc-volume-operating-system-ateol 0
240 .ds doc-volume-ds-1 General Commands Manual
241 .ds doc-volume-ds-2 System Calls Manual
242 .ds doc-volume-ds-3 Library Functions Manual
243 .ds doc-volume-ds-4 Kernel Interfaces Manual
244 .ds doc-volume-ds-5 File Formats Manual
245 .ds doc-volume-ds-6 Games Manual
246 .ds doc-volume-ds-7 Miscellaneous Information Manual
247 .ds doc-volume-ds-8 System Manager's Manual
248 .ds doc-volume-ds-9 Kernel Developer's Manual
250 .ds doc-volume-ds-USD User's Supplementary Documents
251 .ds doc-volume-ds-PS1 Programmer's Supplementary Documents
252 .ds doc-volume-ds-AMD Ancestral Manual Documents
253 .ds doc-volume-ds-SMM System Manager's Manual
254 .ds doc-volume-ds-URM User's Reference Manual
255 .ds doc-volume-ds-PRM Programmer's Manual
256 .ds doc-volume-ds-KM Kernel Manual
257 .ds doc-volume-ds-IND Manual Master Index
258 .ds doc-volume-ds-LOCAL Local Manual
259 .ds doc-volume-ds-CON Contributed Software Manual
261 .als doc-volume-ds-MMI doc-volume-ds-IND
262 .als doc-volume-ds-LOC doc-volume-ds-LOCAL
264 .ds doc-volume-as-alpha alpha
265 .als doc-volume-as-Alpha doc-volume-as-alpha
266 .ds doc-volume-as-acorn26 acorn26
267 .ds doc-volume-as-acorn32 acorn32
268 .ds doc-volume-as-algor algor
269 .ds doc-volume-as-amd64 amd64
270 .ds doc-volume-as-amiga amiga
271 .ds doc-volume-as-arc arc
272 .ds doc-volume-as-arm26 arm26
273 .ds doc-volume-as-arm32 arm32
274 .ds doc-volume-as-atari atari
275 .ds doc-volume-as-bebox bebox
276 .ds doc-volume-as-cats cats
277 .ds doc-volume-as-cesfic cesfic
278 .ds doc-volume-as-cobalt cobalt
279 .ds doc-volume-as-dreamcast dreamcast
280 .ds doc-volume-as-evbarm evbarm
281 .ds doc-volume-as-evbmips evbmips
282 .ds doc-volume-as-evbppc evbppc
283 .ds doc-volume-as-evbsh3 evbsh3
284 .ds doc-volume-as-hp300 hp300
285 .ds doc-volume-as-hpcarm hpcarm
286 .ds doc-volume-as-hpcmips hpcmips
287 .ds doc-volume-as-hpcsh hpcsh
288 .ds doc-volume-as-hppa hppa
289 .ds doc-volume-as-i386 i386
290 .ds doc-volume-as-luna68k luna68k
291 .ds doc-volume-as-m68k m68k
292 .ds doc-volume-as-mac68k mac68k
293 .ds doc-volume-as-macppc macppc
294 .ds doc-volume-as-mips mips
295 .ds doc-volume-as-mipsco mipsco
296 .ds doc-volume-as-mmeye mmeye
297 .ds doc-volume-as-mvme68k mvme68k
298 .ds doc-volume-as-mvmeppc mvmeppc
299 .ds doc-volume-as-netwinder netwinder
300 .ds doc-volume-as-news68k news68k
301 .ds doc-volume-as-newsmips newsmips
302 .ds doc-volume-as-next68k next68k
303 .ds doc-volume-as-ofppc ofppc
304 .ds doc-volume-as-pc532 pc532
305 .ds doc-volume-as-playstation2 playstation2
306 .ds doc-volume-as-pmax pmax
307 .ds doc-volume-as-pmppc pmppc
308 .ds doc-volume-as-powerpc powerpc
309 .ds doc-volume-as-prep prep
310 .ds doc-volume-as-sandpoint sandpoint
311 .ds doc-volume-as-sbmips sbmips
312 .ds doc-volume-as-sgimips sgimips
313 .ds doc-volume-as-sh3 sh3
314 .ds doc-volume-as-shark shark
315 .ds doc-volume-as-sparc sparc
316 .ds doc-volume-as-sparc64 sparc64
317 .ds doc-volume-as-sun2 sun2
318 .ds doc-volume-as-sun3 sun3
319 .ds doc-volume-as-tahoe tahoe
320 .ds doc-volume-as-vax vax
321 .ds doc-volume-as-x68k x68k
322 .ds doc-volume-as-x86_64 x86_64
325 . \" reset default arguments
326 . ds doc-document-title UNTITLED
327 . ds doc-volume LOCAL
328 . ds doc-section Null
329 . ds doc-command-name
332 . ds doc-document-title "\$1
337 . if ((\$2 >= 1) & (\$2 <= 9)) \{\
338 . ie \n[doc-volume-operating-system-ateol] \{\
339 . ds doc-volume "\*[doc-volume-ds-\$2] \*[doc-volume-operating-system]
341 . if d doc-volume-as-\$3 \
342 . as doc-volume "/\*[doc-volume-as-\$3]
345 . ds doc-volume "\*[doc-volume-operating-system]
347 . if d doc-volume-as-\$3 \
348 . as doc-volume "/\*[doc-volume-as-\$3]
350 . as doc-volume " \*[doc-volume-ds-\$2]
354 . ds doc-volume DRAFT
355 . el \{ .ie "\$2"draft" \
356 . ds doc-volume DRAFT
357 . el .if "\$2"paper" \
358 . ds doc-volume UNTITLED
361 . if d doc-volume-ds-\$3 \
362 . ds doc-volume "\*[doc-volume-ds-\$3]
366 . if "\*[doc-volume]"LOCAL" \
377 .\" NS doc-default-operating-system global string
378 .\" NS the exact (default) version of the operating system
380 .\" NS override this in `mdoc.local', if necessary
382 .ds doc-default-operating-system BSD
385 .\" NS doc-operating-system global string
386 .\" NS the exact version of the operating system
388 .ds doc-operating-system
391 .\" NS Os user macro (not parsed, not callable)
392 .\" NS operating system
395 .\" NS doc-operating-system
396 .\" NS doc-command-name
398 .\" NS local variables:
399 .\" NS doc-operating-system-XXX-XXX
401 .\" NS width register `Os' set above
403 .ds doc-operating-system-ATT-7 7th\~Edition
404 .als doc-operating-system-ATT-7th doc-operating-system-ATT-7
405 .ds doc-operating-system-ATT-3 System\~III
406 .als doc-operating-system-ATT-III doc-operating-system-ATT-3
407 .ds doc-operating-system-ATT-V System\~V
408 .ds doc-operating-system-ATT-V.2 System\~V Release\~2
409 .ds doc-operating-system-ATT-V.3 System\~V Release\~3
410 .ds doc-operating-system-ATT-V.4 System\~V Release\~4
412 .ds doc-operating-system-BSD-3 3rd\~Berkeley Distribution
413 .ds doc-operating-system-BSD-4 4th\~Berkeley Distribution
414 .ds doc-operating-system-BSD-4.1 4.1\~Berkeley Distribution
415 .ds doc-operating-system-BSD-4.2 4.2\~Berkeley Distribution
416 .ds doc-operating-system-BSD-4.3 4.3\~Berkeley Distribution
417 .ds doc-operating-system-BSD-4.3T 4.3-Tahoe Berkeley Distribution
418 .ds doc-operating-system-BSD-4.3R 4.3-Reno Berkeley Distribution
419 .als doc-operating-system-BSD-4.3t doc-operating-system-BSD-4.3T
420 .als doc-operating-system-BSD-4.3r doc-operating-system-BSD-4.3R
421 .ds doc-operating-system-BSD-4.4 4.4BSD
423 .ds doc-operating-system-NetBSD-0.8 0.8
424 .ds doc-operating-system-NetBSD-0.8a 0.8A
425 .ds doc-operating-system-NetBSD-0.9 0.9
426 .ds doc-operating-system-NetBSD-0.9a 0.9A
427 .ds doc-operating-system-NetBSD-1.0 1.0
428 .ds doc-operating-system-NetBSD-1.0a 1.0A
429 .ds doc-operating-system-NetBSD-1.1 1.1
430 .ds doc-operating-system-NetBSD-1.2 1.2
431 .ds doc-operating-system-NetBSD-1.2a 1.2A
432 .ds doc-operating-system-NetBSD-1.2b 1.2B
433 .ds doc-operating-system-NetBSD-1.2c 1.2C
434 .ds doc-operating-system-NetBSD-1.2d 1.2D
435 .ds doc-operating-system-NetBSD-1.2e 1.2E
436 .ds doc-operating-system-NetBSD-1.3 1.3
437 .ds doc-operating-system-NetBSD-1.3a 1.3A
438 .ds doc-operating-system-NetBSD-1.4 1.4
439 .ds doc-operating-system-NetBSD-1.4.1 1.4.1
440 .ds doc-operating-system-NetBSD-1.4.2 1.4.2
441 .ds doc-operating-system-NetBSD-1.4.3 1.4.3
442 .ds doc-operating-system-NetBSD-1.5 1.5
443 .ds doc-operating-system-NetBSD-1.5.1 1.5.1
444 .ds doc-operating-system-NetBSD-1.5.2 1.5.2
445 .ds doc-operating-system-NetBSD-1.5.3 1.5.3
446 .ds doc-operating-system-NetBSD-1.6 1.6
447 .ds doc-operating-system-NetBSD-1.6.1 1.6.1
448 .ds doc-operating-system-NetBSD-1.6.2 1.6.2
449 .ds doc-operating-system-NetBSD-1.6.3 1.6.3
450 .ds doc-operating-system-NetBSD-2.0 2.0
451 .ds doc-operating-system-NetBSD-2.0.1 2.0.1
452 .ds doc-operating-system-NetBSD-2.0.2 2.0.2
453 .ds doc-operating-system-NetBSD-2.0.3 2.0.3
454 .ds doc-operating-system-NetBSD-2.1 2.1
455 .ds doc-operating-system-NetBSD-3.0 3.0
456 .ds doc-operating-system-NetBSD-3.0.1 3.0.1
457 .ds doc-operating-system-NetBSD-3.0.2 3.0.2
458 .ds doc-operating-system-NetBSD-3.1 3.1
459 .ds doc-operating-system-NetBSD-4.0 4.0
460 .ds doc-operating-system-NetBSD-4.0.1 4.0.1
462 .ds doc-operating-system-FreeBSD-1.0 1.0
463 .ds doc-operating-system-FreeBSD-1.1 1.1
464 .ds doc-operating-system-FreeBSD-1.1.5 1.1.5
465 .ds doc-operating-system-FreeBSD-1.1.5.1 1.1.5.1
466 .ds doc-operating-system-FreeBSD-2.0 2.0
467 .ds doc-operating-system-FreeBSD-2.0.5 2.0.5
468 .ds doc-operating-system-FreeBSD-2.1 2.1
469 .ds doc-operating-system-FreeBSD-2.1.5 2.1.5
470 .ds doc-operating-system-FreeBSD-2.1.6 2.1.6
471 .ds doc-operating-system-FreeBSD-2.1.7 2.1.7
472 .ds doc-operating-system-FreeBSD-2.2 2.2
473 .ds doc-operating-system-FreeBSD-2.2.1 2.2.1
474 .ds doc-operating-system-FreeBSD-2.2.2 2.2.2
475 .ds doc-operating-system-FreeBSD-2.2.5 2.2.5
476 .ds doc-operating-system-FreeBSD-2.2.6 2.2.6
477 .ds doc-operating-system-FreeBSD-2.2.7 2.2.7
478 .ds doc-operating-system-FreeBSD-2.2.8 2.2.8
479 .ds doc-operating-system-FreeBSD-3.0 3.0
480 .ds doc-operating-system-FreeBSD-3.1 3.1
481 .ds doc-operating-system-FreeBSD-3.2 3.2
482 .ds doc-operating-system-FreeBSD-3.3 3.3
483 .ds doc-operating-system-FreeBSD-3.4 3.4
484 .ds doc-operating-system-FreeBSD-3.5 3.5
485 .ds doc-operating-system-FreeBSD-4.0 4.0
486 .ds doc-operating-system-FreeBSD-4.1 4.1
487 .ds doc-operating-system-FreeBSD-4.1.1 4.1.1
488 .ds doc-operating-system-FreeBSD-4.2 4.2
489 .ds doc-operating-system-FreeBSD-4.3 4.3
490 .ds doc-operating-system-FreeBSD-4.4 4.4
491 .ds doc-operating-system-FreeBSD-4.5 4.5
492 .ds doc-operating-system-FreeBSD-4.6 4.6
493 .ds doc-operating-system-FreeBSD-4.6.2 4.6.2
494 .ds doc-operating-system-FreeBSD-4.7 4.7
495 .ds doc-operating-system-FreeBSD-4.8 4.8
496 .ds doc-operating-system-FreeBSD-4.9 4.9
497 .ds doc-operating-system-FreeBSD-4.10 4.10
498 .ds doc-operating-system-FreeBSD-4.11 4.11
499 .ds doc-operating-system-FreeBSD-5.0 5.0
500 .ds doc-operating-system-FreeBSD-5.1 5.1
501 .ds doc-operating-system-FreeBSD-5.2 5.2
502 .ds doc-operating-system-FreeBSD-5.2.1 5.2.1
503 .ds doc-operating-system-FreeBSD-5.3 5.3
504 .ds doc-operating-system-FreeBSD-5.4 5.4
505 .ds doc-operating-system-FreeBSD-5.5 5.5
506 .ds doc-operating-system-FreeBSD-6.0 6.0
507 .ds doc-operating-system-FreeBSD-6.1 6.1
508 .ds doc-operating-system-FreeBSD-6.2 6.2
509 .ds doc-operating-system-FreeBSD-6.3 6.3
510 .ds doc-operating-system-FreeBSD-6.4 6.4
511 .ds doc-operating-system-FreeBSD-7.0 7.0
512 .ds doc-operating-system-FreeBSD-7.1 7.1
514 .ds doc-operating-system-Darwin-8.0.0 8.0.0
515 .ds doc-operating-system-Darwin-8.1.0 8.1.0
516 .ds doc-operating-system-Darwin-8.2.0 8.2.0
517 .ds doc-operating-system-Darwin-8.3.0 8.3.0
518 .ds doc-operating-system-Darwin-8.4.0 8.4.0
519 .ds doc-operating-system-Darwin-8.5.0 8.5.0
520 .ds doc-operating-system-Darwin-8.6.0 8.6.0
521 .ds doc-operating-system-Darwin-8.7.0 8.7.0
522 .ds doc-operating-system-Darwin-8.8.0 8.8.0
523 .ds doc-operating-system-Darwin-8.9.0 8.9.0
524 .ds doc-operating-system-Darwin-8.10.0 8.10.0
525 .ds doc-operating-system-Darwin-8.11.0 8.11.0
526 .ds doc-operating-system-Darwin-9.0.0 9.0.0
527 .ds doc-operating-system-Darwin-9.1.0 9.1.0
528 .ds doc-operating-system-Darwin-9.2.0 9.2.0
529 .ds doc-operating-system-Darwin-9.3.0 9.3.0
530 .ds doc-operating-system-Darwin-9.4.0 9.4.0
531 .ds doc-operating-system-Darwin-9.5.0 9.5.0
532 .ds doc-operating-system-Darwin-9.6.0 9.6.0
534 .ds doc-operating-system-DragonFly-1.0 1.0
535 .ds doc-operating-system-DragonFly-1.1 1.1
536 .ds doc-operating-system-DragonFly-1.2 1.2
537 .ds doc-operating-system-DragonFly-1.3 1.3
538 .ds doc-operating-system-DragonFly-1.4 1.4
539 .ds doc-operating-system-DragonFly-1.5 1.5
540 .ds doc-operating-system-DragonFly-1.6 1.6
541 .ds doc-operating-system-DragonFly-1.8 1.8
542 .ds doc-operating-system-DragonFly-1.8.1 1.8.1
543 .ds doc-operating-system-DragonFly-1.10 1.10
544 .ds doc-operating-system-DragonFly-1.12 1.12
545 .ds doc-operating-system-DragonFly-1.12.2 1.12.2
546 .ds doc-operating-system-DragonFly-2.0 2.0
549 . ds doc-command-name
552 . ds doc-operating-system "\*[doc-default-operating-system]
553 . el \{ .ie "\$1"ATT" \{\
554 . ds doc-operating-system AT&T
556 . ie d doc-operating-system-ATT-\$2 \
557 . as doc-operating-system " \*[doc-operating-system-ATT-\$2]
559 . as doc-operating-system " UNIX
561 . el \{ .ie "\$1"BSD" \{\
563 . ie d doc-operating-system-BSD-\$2 \
564 . ds doc-operating-system "\*[doc-operating-system-BSD-\$2]
566 . tm mdoc warning: .Os: Unknown BSD version `\$2' (#\n[.c])
568 . el \{ .ie "\$1"FreeBSD" \{\
569 . ds doc-operating-system FreeBSD
571 . ie d doc-operating-system-FreeBSD-\$2 \
572 . as doc-operating-system \~\*[doc-operating-system-FreeBSD-\$2]
574 . tm mdoc warning: .Os: Unknown FreeBSD version `\$2' (#\n[.c])
576 . el \{ .ie "\$1"NetBSD" \{\
577 . ds doc-operating-system NetBSD
579 . ie d doc-operating-system-NetBSD-\$2 \
580 . as doc-operating-system \~\*[doc-operating-system-NetBSD-\$2]
582 . tm mdoc warning: .Os: Unknown NetBSD version `\$2' (#\n[.c])
584 . el \{ .ie "\$1"Darwin" \{\
585 . ds doc-operating-system Darwin
587 . ie d doc-operating-system-Darwin-\$2 \
588 . as doc-operating-system \~\*[doc-operating-system-Darwin-\$2]
590 . tm mdoc warning: .Os: Unknown Darwin version `\$2' (#\n[.c])
593 . ds doc-operating-system \$1
595 . as doc-operating-system " \$2
600 .\" NS doc-date-string global string
601 .\" NS the manual page date as set by `Dd'
606 .\" NS Dd user macro (not parsed, not callable)
607 .\" NS set document date
610 .\" NS doc-date-string
611 .\" NS doc-command-name
613 .\" NS local variables:
616 .\" NS width register `Dd' set above
618 .ds doc-date-1 January
619 .ds doc-date-2 February
625 .ds doc-date-8 August
626 .ds doc-date-9 September
627 .ds doc-date-10 October
628 .ds doc-date-11 November
629 .ds doc-date-12 December
632 . ds doc-command-name
636 . ds doc-date-string \$1\~\$2 \$3
638 . ds doc-date-string "\*[doc-date-\n[mo]]
639 . as doc-date-string \~\n[dy], \n[year]
643 . ds doc-date-string Epoch
647 .\" NS doc-hyphen-flags global register
648 .\" NS the parameter for the `.hy' request
650 .\" NS override this in `mdoc.local', if necessary.
652 .nr doc-hyphen-flags 12
655 .\" NS doc-header macro
656 .\" NS print page header
658 .\" NS local variables:
664 . doc-setup-page-layout
666 . sp \n[doc-header-space]u
667 . nr doc-reg-dh \w'\*[doc-caption-font]\*[doc-header-string]\f[]'
668 . nr doc-reg-dh1 \w'\*[doc-caption-font2]\*[doc-volume]\f[]'
669 . if (\n[doc-reg-dh] + \n[doc-reg-dh1] + \n[doc-reg-dh] >= \n[.lt]) \{\
670 . while (\n[doc-reg-dh] + \n[doc-reg-dh1] + \n[doc-reg-dh] >= \n[.lt]) \{\
671 . substring doc-header-string 0 -2
672 . nr doc-reg-dh \w'\*[doc-caption-font]\*[doc-header-string]\|.\|.\|.\f[]'
674 . as doc-header-string "\|.\|.\|.
676 . 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
678 . sp \n[doc-header-space]u
686 .\" NS doc-footer macro
687 .\" NS print page footer
693 . ev doc-caption-enviroment
694 . doc-setup-page-layout
695 . sp \n[doc-footer-space]u
698 . tl
\a%
\a\*[doc-caption-font2]\*[doc-date-string]\f[]
\a\*[doc-caption-font]\*[doc-operating-system]\f[]
\a
700 . tl
\a\*[doc-caption-font]\*[doc-operating-system]\f[]
\a\*[doc-caption-font2]\*[doc-date-string]\f[]
\a%
\a
703 . tl
\a\*[doc-caption-font]\*[doc-operating-system]\f[]
\a\*[doc-caption-font2]\*[doc-date-string]\f[]
\a%
\a
710 .\" NS doc-check-depth macro
711 .\" NS check paired macros
714 . if \n[doc-list-depth] \{\
715 . tm mdoc warning: A .Bl directive has no matching .El (#\n[.c])
716 . nr doc-list-depth 0
718 . if \n[doc-display-depth] \{\
719 . tm mdoc warning: A .Bd directive has no matching .Ed (#\n[.c])
720 . nr doc-display-depth 0
722 . if \n[doc-fontmode-depth] \{\
723 . tm mdoc warning: A .Bf directive has no matching .Ef (#\n[.c])
724 . nr doc-fontmode-depth 0
729 .\" NS doc-end-macro macro
733 . \" We may still have a partial line in the environment. If this is the
734 . \" case, and we happen to be on the last line of the page, the `.fl'
735 . \" request will cause the page to be ejected and troff will immediately
736 . \" exit. If we are in nroff mode, this would be unfortunate, since we
737 . \" would never get a chance to output the footer. So we fudge the page
738 . \" length to make sure that the last page is never ejected until we want
749 . 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
750 . \" suppress empty lines after the footer
756 .\" NS doc-paragraph macro
757 .\" NS insert a paragraph
760 . sp \n[doc-paragraph-space]u
767 .\" NS Pp user macro (not parsed, not callable)
770 .\" NS width register `Pp' set above
772 .als Pp doc-paragraph
775 .\" NS Lp user macro (not parsed, not callable)
778 .\" NS width register `Lp' set above
780 .als Lp doc-paragraph
784 . tm Not a \-mdoc command: .LP (#\n[.c])
789 . tm Not a \-mdoc command: .PP (#\n[.c])
794 . tm Not a \-mdoc command: .pp (#\n[.c])
799 . tm Not a \-mdoc command: .SH (#\n[.c])
803 .\" NS Nd user macro (not parsed, not callable)
804 .\" NS print name description
806 .\" NS width register `Nd' set above
813 .\" NS doc-in-synopsis-section global register (bool)
814 .\" NS whether we are in the `synopsis' section
816 .nr doc-in-synopsis-section 0
819 .\" NS doc-in-library-section global register (bool)
820 .\" NS whether we are in the `library' section
822 .nr doc-in-library-section 0
825 .\" NS doc-in-see-also-section global register (bool)
826 .\" NS whether we are in the `see also' section
828 .nr doc-in-see-also-section 0
831 .\" NS doc-in-files-section global register (bool)
832 .\" NS whether we are in the `files' section
834 .nr doc-in-files-section 0
837 .\" NS doc-in-authors-section global register (bool)
838 .\" NS whether we are in the `authors' section
840 .nr doc-in-authors-section 0
843 .\" NS doc-first-parameter macro
844 .\" NS return first parameter
846 .\" NS local variables:
849 .de doc-first-parameter
850 . ds doc-str-dfp "\$1
854 .\" NS Sh user macro (not callable)
855 .\" NS section headers
858 .\" NS doc-func-args-processed
859 .\" NS doc-func-count
860 .\" NS doc-in-authors-section
861 .\" NS doc-in-files-section
862 .\" NS doc-in-library-section
863 .\" NS doc-in-see-also-section
864 .\" NS doc-in-synopsis-section
865 .\" NS doc-indent-synopsis
866 .\" NS doc-indent-synopsis-active
868 .\" NS doc-num-func-args
870 .\" NS local variables:
873 .\" NS doc-section-XXX
875 .\" NS width register `Sh' set in doc-common
877 .ds doc-section-name NAME
878 .ds doc-section-synopsis SYNOPSIS
879 .ds doc-section-library LIBRARY
880 .ds doc-section-description DESCRIPTION
881 .ds doc-section-see-also SEE
882 .ds doc-section-files FILES
883 .ds doc-section-authors AUTHORS
886 . ie \n[doc-arg-limit] \{\
887 . \" we only allow `Sh' within `Sh'; it will change the font back to
889 . ie "\*[doc-macro-name]"Sh" \{\
891 . ie (\n[doc-arg-limit] >= \n[doc-arg-ptr]) \{\
892 . nr doc-curr-font \n[.f]
893 . nr doc-curr-size \n[.ps]
894 . nop \*[doc-Sh-font]\c
895 . doc-print-recursive
898 . tm Usage: .Sh section_name ... (#\n[.c])
902 . tm Usage: .Sh not callable by other macros (#\n[.c])
907 . tm Usage: .Sh section_name ... (#\n[.c])
911 . ds doc-macro-name Sh
917 . \" this resolves e.g. `.Sh "SEE ALSO"'
918 . doc-first-parameter \$*
920 . ie "\*[doc-str-dfp]"\*[doc-section-name]" \{\
925 . nr doc-in-synopsis-section 0
926 . nr doc-in-library-section 0
927 . nr doc-in-see-also-section 0
928 . nr doc-in-files-section 0
929 . nr doc-in-authors-section 0
931 . ie "\*[doc-str-dfp]"\*[doc-section-synopsis]" \{\
934 . nr doc-in-synopsis-section 1
935 . nr doc-indent-synopsis 0
936 . nr doc-indent-synopsis-active 0
938 . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-library]" \{\
939 . nr doc-in-library-section 1
941 . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-description]" \{\
943 . nr doc-func-count 0
944 . nr doc-func-args-processed 0
945 . nr doc-num-func-args 0
947 . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-see-also]" \{\
950 . nr doc-in-see-also-section 1
952 . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-files]" \
953 . nr doc-in-files-section 1
954 . el .if "\*[doc-str-dfp]"\*[doc-section-authors]" \
955 . nr doc-in-authors-section 1
959 . nr doc-have-author 0
962 . doc-setup-page-layout
971 . nr doc-reg-Sh \n[.ss]
972 . nr doc-reg-Sh1 \n[.sss]
973 . ss (\n[.ss] * 5 / 3) (\n[.sss] * 5 / 3)
977 . nr doc-curr-font \n[.f]
978 . nr doc-curr-size \n[.ps]
979 . nop \*[doc-Sh-font]\c
980 . doc-print-recursive
983 . ss \n[doc-reg-Sh] \n[doc-reg-Sh1]
985 . in +\n[doc-subheader-indent]u
993 .\" NS Ss user macro (not callable)
996 .\" NS local variable:
1000 .\" NS width register `Ss' set above
1003 . ie \n[doc-arg-limit] \{\
1004 . \" we only allow `Ss' within `Ss'; it will change the font back to
1006 . ie "\*[doc-macro-name]"Ss" \{\
1008 . ie (\n[doc-arg-limit] >= \n[doc-arg-ptr]) \{\
1009 . nr doc-curr-font \n[.f]
1010 . nr doc-curr-size \n[.ps]
1011 . nop \*[doc-Sh-font]\c
1012 . doc-print-recursive
1015 . tm Usage: .Ss subsection_name ... (#\n[.c])
1019 . tm Usage: .Ss not callable by other macros (#\n[.c])
1024 . tm Usage: .Ss subsection_name ... (#\n[.c])
1028 . ds doc-macro-name Ss
1029 . doc-parse-args \$@
1036 . nr doc-reg-Ss \n[.ss]
1037 . nr doc-reg-Ss1 \n[.sss]
1038 . ss (\n[.ss] * 5 / 4) (\n[.sss] * 5 / 4)
1041 . nr doc-curr-font \n[.f]
1042 . nr doc-curr-size \n[.ps]
1043 . nop \*[doc-Sh-font]\c
1044 . doc-print-recursive
1046 . ss \n[doc-reg-Ss] \n[doc-reg-Ss1]
1059 .\" NS Rd macro (not parsed, not callable)
1060 .\" NS print global register dump to stderr
1062 .\" NS local variables:
1066 . tm MDOC GLOBAL REGISTER DUMP
1067 . tm doc-macro-name == `\*[doc-macro-name]'
1068 . tm doc-arg-limit == \n[doc-arg-limit]
1069 . tm doc-num-args == \n[doc-num-args]
1070 . tm doc-arg-ptr == \n[doc-arg-ptr]
1073 . while (\n[doc-reg-Rd] <= \n[doc-arg-limit]) \{\
1074 . tm doc-arg\n[doc-reg-Rd] == `\*[doc-arg\n[doc-reg-Rd]]'
1075 . tm doc-type\n[doc-reg-Rd] == \n[doc-type\n[doc-reg-Rd]]
1076 . tm doc-space\n[doc-reg-Rd] == `\*[doc-space\n[doc-reg-Rd]]'
1080 . tm doc-curr-font == \n[doc-curr-font]
1081 . tm doc-curr-size == \n[doc-curr-size]
1082 . tm doc-indent-synopsis == \n[doc-indent-synopsis]
1083 . tm doc-indent-synopsis-active == \n[doc-indent-synopsis-active]
1084 . tm doc-have-decl == \n[doc-have-decl]
1085 . tm doc-have-var == \n[doc-have-var]
1086 . tm doc-command-name == `\*[doc-command-name]'
1087 . tm doc-quote-left == `\*[doc-quote-left]'
1088 . tm doc-quote-right == `\*[doc-quote-right]'
1089 . tm doc-nesting-level == \n[doc-nesting-level]
1090 . tm doc-in-list == \n[doc-in-list]
1091 . tm doc-space == `\*[doc-space]'
1092 . tm doc-saved-space == `\*[doc-saved-space]'
1093 . tm doc-space-mode == \n[doc-space-mode]
1094 . tm doc-have-space == \n[doc-have-space]
1095 . tm doc-have-slot == \n[doc-have-slot]
1096 . tm doc-keep-type == \n[doc-keep-type]
1097 . tm doc-display-depth == \n[doc-display-depth]
1098 . tm doc-is-compact == \n[doc-is-compact]
1101 . while (\n[doc-reg-Rd] <= \n[doc-display-depth]) \{\
1102 . tm doc-display-type-stack\n[doc-reg-Rd] == `\*[doc-display-type-stack\n[doc-reg-Rd]]'
1103 . tm doc-display-indent-stack\n[doc-reg-Rd] == \n[doc-display-indent-stack\n[doc-reg-Rd]]
1104 . tm doc-display-ad-stack\n[doc-reg-Rd] == \n[doc-display-ad-stack\n[doc-reg-Rd]]
1105 . tm doc-display-fi-stack\n[doc-reg-Rd] == \n[doc-display-fi-stack\n[doc-reg-Rd]]
1106 . tm doc-display-ft-stack\n[doc-reg-Rd] == \n[doc-display-ft-stack\n[doc-reg-Rd]]
1107 . tm doc-display-ps-stack\n[doc-reg-Rd] == \n[doc-display-ps-stack\n[doc-reg-Rd]]
1111 . tm doc-fontmode-depth == \n[doc-fontmode-depth]
1114 . while (\n[doc-reg-Rd] <= \n[doc-fontmode-depth]) \{\
1115 . tm doc-fontmode-font-stack\n[doc-reg-Rd] == `\n[doc-fontmode-font-stack\n[doc-reg-Rd]]'
1116 . tm doc-fontmode-size-stack\n[doc-reg-Rd] == `\n[doc-fontmode-size-stack\n[doc-reg-Rd]]'
1120 . tm doc-list-depth == \n[doc-list-depth]
1123 . while (\n[doc-reg-Rd] <= \n[doc-list-depth]) \{\
1124 . tm doc-list-type-stack\n[doc-reg-Rd] == `\*[doc-list-type-stack\n[doc-reg-Rd]]'
1125 . tm doc-list-have-indent-stack\n[doc-reg-Rd] == \n[doc-list-have-indent-stack\n[doc-reg-Rd]]
1126 . tm doc-list-indent-stack\n[doc-reg-Rd] == \n[doc-list-indent-stack\n[doc-reg-Rd]]
1127 . tm doc-compact-list-stack\n[doc-reg-Rd] == \n[doc-compact-list-stack\n[doc-reg-Rd]]
1128 . tm doc-tag-prefix-stack\n[doc-reg-Rd] == `\*[doc-tag-prefix-stack\n[doc-reg-Rd]]'
1129 . tm doc-tag-width-stack\n[doc-reg-Rd] == `\*[doc-tag-width-stack\n[doc-reg-Rd]]'
1130 . tm doc-list-offset-stack\n[doc-reg-Rd] == \n[doc-list-offset-stack\n[doc-reg-Rd]]
1131 . tm doc-enum-list-count-stack\n[doc-reg-Rd] == \n[doc-enum-list-count-stack\n[doc-reg-Rd]]
1135 . tm doc-saved-Pa-font == `\*[doc-saved-Pa-font]'
1136 . tm doc-curr-type == \n[doc-curr-type]
1137 . tm doc-curr-arg == `\*[doc-curr-arg]'
1138 . tm doc-diag-list-input-line-count == \n[doc-diag-list-input-line-count]
1139 . tm doc-num-columns == \n[doc-num-columns]
1140 . tm doc-column-indent-width == \n[doc-column-indent-width]
1141 . tm doc-is-func == \n[doc-is-func]
1142 . tm doc-have-old-func == \n[doc-have-old-func]
1143 . tm doc-func-arg-count == \n[doc-func-arg-count]
1144 . tm doc-func-arg == `\*[doc-func-arg]'
1145 . tm doc-num-func-args == \n[doc-num-func-args]
1146 . tm doc-func-args-processed == \n[doc-func-args-processed]
1147 . tm doc-have-func == \n[doc-have-func]
1148 . tm doc-is-reference == \n[doc-is-reference]
1149 . tm doc-reference-count == \n[doc-reference-count]
1150 . tm doc-author-count == \n[doc-author-count]
1153 . while (\n[doc-reg-Rd] <= \n[doc-author-count]) \{\
1154 . tm doc-author-name\n[doc-reg-Rd] == `\*[doc-author-name\n[doc-reg-Rd]]'
1158 . tm doc-book-count == \n[doc-book-count]
1159 . tm doc-book-name == `\*[doc-book-name]'
1160 . tm doc-date-count == \n[doc-date-count]
1161 . tm doc-date == `\*[doc-date]'
1162 . tm doc-publisher-count == \n[doc-publisher-count]
1163 . tm doc-publisher-name == `\*[doc-publisher-name]'
1164 . tm doc-journal-count == \n[doc-journal-count]
1165 . tm doc-journal-name == `\*[doc-journal-name]'
1166 . tm doc-issue-count == \n[doc-issue-count]
1167 . tm doc-issue-name == `\*[doc-issue-name]'
1168 . tm doc-optional-count == \n[doc-optional-count]
1169 . tm doc-optional-string == `\*[doc-optional-string]'
1170 . tm doc-page-number-count == \n[doc-page-number-count]
1171 . tm doc-page-number-string == `\*[doc-page-number-string]'
1172 . tm doc-corporate-count == \n[doc-corporate-count]
1173 . tm doc-corporate-name == `\*[doc-corporate-name]'
1174 . tm doc-report-count == \n[doc-report-count]
1175 . tm doc-report-name == `\*[doc-report-name]'
1176 . tm doc-reference-title-count == \n[doc-reference-title-count]
1177 . tm doc-reference-title-name == `\*[doc-reference-title-name]'
1178 . tm doc-reference-title-name-for-book == `\*[doc-reference-title-name-for-book]'
1179 . tm doc-url-count == \n[doc-url-count]
1180 . tm doc-url-name == `\*[doc-url-name]'
1181 . tm doc-volume-count == \n[doc-volume-count]
1182 . tm doc-volume-name == `\*[doc-volume-name]'
1183 . tm doc-have-author == \n[doc-have-author]
1185 . tm doc-document-title == `\*[doc-document-title]'
1186 . tm doc-volume == `\*[doc-volume]'
1187 . tm doc-section == `\*[doc-section]'
1188 . tm doc-operating-system == `\*[doc-operating-system]'
1189 . tm doc-date-string == `\*[doc-date-string]'
1190 . tm doc-header-space == \n[doc-header-space]
1191 . tm doc-footer-space == \n[doc-footer-space]
1192 . tm doc-display-vertical == \n[doc-display-vertical]
1193 . tm doc-header-string == `\*[doc-header-string]'
1194 . tm doc-in-synopsis-section == \n[doc-in-synopsis-section]
1195 . tm doc-in-library-section == \n[doc-in-library-section]
1196 . tm doc-in-see-also-section == \n[doc-in-see-also-section]
1197 . tm doc-in-files-section == \n[doc-in-files-section]
1198 . tm doc-in-authors-section == \n[doc-in-authors-section]
1200 . tm END OF GLOBAL REGISTER DUMP