gnu/usr.bin/groff/tmac/doc-common

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