contrib/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. [Deleted.  See
  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.
  17 .\"
  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
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)doc-common  8.1 (Berkeley) 06/08/93
  31 .\"
  32 .\"     %beginstrip%
  33 .
  34 .
  35 .\" Macro Identifiers.  For each user macro a corresponding register with
  36 .\" the same name must exist.  Its value must not be zero.
  37 .
  38 .nr %A 1
  39 .nr %B 1
  40 .nr %D 1
  41 .nr %I 1
  42 .nr %J 1
  43 .nr %N 1
  44 .nr %O 1
  45 .nr %P 1
  46 .nr %Q 1
  47 .nr %R 1
  48 .nr %T 1
  49 .nr %U 1
  50 .nr %V 1
  51 .nr Ac 3
  52 .nr Ad 12n
  53 .nr An 12n
  54 .nr Ao 12n
  55 .nr Ap 2
  56 .nr Aq 12n
  57 .nr Ar 12n
  58 .nr At 1
  59 .nr Bc 3
  60 .nr Bf 8n\" ?
  61 .nr Bk 8n\" ?
  62 .nr Bl 1
  63 .nr Bo 12n
  64 .nr Bq 12n
  65 .nr Brc 3
  66 .nr Bro 12n
  67 .nr Brq 12n
  68 .nr Bsx 1
  69 .nr Bt 8n\" ?
  70 .nr Bx 1
  71 .nr Cd 12n
  72 .nr Cm 10n
  73 .nr D1 8n\" ?
  74 .nr Dc 3
  75 .nr Dl 8n\" ?
  76 .nr Dt 8n\" ?
  77 .nr Do 12n
  78 .nr Dq 12n
  79 .nr Ds 6n\" many manpages still use this as a -width value
  80 .nr Dv 12n
  81 .nr Dx 1
  82 .nr Ec 3
  83 .nr Ef 8n\" ?
  84 .nr Ek 8n\" ?
  85 .nr El 1
  86 .nr Em 10n
  87 .nr En 12n
  88 .nr Eo 12n
  89 .nr Eq 12n
  90 .nr Er 17n
  91 .nr Es 12n
  92 .nr Ev 15n
  93 .nr Ex 1
  94 .nr Fa 12n
  95 .nr Fc 3
  96 .nr Fd 12n\" ?
  97 .nr Fl 10n
  98 .nr Fn 16n
  99 .nr Fo 16n
 100 .nr Fr 12n\" ?
 101 .nr Ft 8n\" ?
 102 .nr Fx 1
 103 .nr Ic 10n
 104 .nr In 12n
 105 .nr It 8n\" ?
 106 .nr Lb 11n
 107 .nr Li 16n
 108 .nr Lk 6n\" ?
 109 .nr Lp 8n\" ?
 110 .nr Me 6n
 111 .nr Ms 6n
 112 .nr Mt 6n\" ?
 113 .nr Nd 8n\" ?
 114 .nr Nm 10n
 115 .nr No 12n
 116 .nr Ns 2
 117 .nr Nx 1
 118 .nr Oc 3
 119 .nr Oo 10n
 120 .nr Op 14n
 121 .nr Os 6n\" ?
 122 .nr Ox 1
 123 .nr Pa 32n
 124 .nr Pc 3
 125 .nr Pf 12n
 126 .nr Po 12n
 127 .nr Pp 8n\" ?
 128 .nr Pq 12n
 129 .nr Qc 3
 130 .nr Ql 16n
 131 .nr Qo 12n
 132 .nr Qq 12n
 133 .nr Rv 1
 134 .nr Sc 3
 135 .nr Sh 8n
 136 .nr Sm 8n\" ?
 137 .nr So 12n
 138 .nr Sq 12n
 139 .nr Ss 8n
 140 .nr St 8n\" ?
 141 .nr Sx 16n
 142 .nr Sy 6n
 143 .nr Ta 2
 144 .nr Tn 10n
 145 .nr Ud 8n\" ?
 146 .nr Ux 1
 147 .nr Va 12n
 148 .nr Vt 8n\" ?
 149 .nr Xc 3
 150 .nr Xo 1
 151 .nr Xr 10n
 152 .
 153 .
 154 .\" macros which must be processed after the closing delimiter of `Op'
 155 .\" and friends
 156 .ds doc-after-Ao
 157 .ds doc-after-Bo
 158 .ds doc-after-Bro
 159 .ds doc-after-Do
 160 .ds doc-after-Eo
 161 .ds doc-after-Fo
 162 .ds doc-after-Ns
 163 .ds doc-after-Oo
 164 .ds doc-after-Po
 165 .ds doc-after-Qo
 166 .ds doc-after-So
 167 .ds doc-after-Xo
 168 .
 169 .
 170 .nr doc-display-indent 6n
 171 .
 172 .
 173 .\" space strings
 174 .
 175 .ds doc-soft-space " \"
 176 .ds doc-hard-space \~
 177 .ds doc-tab \t
 178 .
 179 .
 180 .eo
 181 .
 182 .
 183 .\" punctuation values (suffix=3, prefix=4)
 184 .
 185 .nr doc-punct. 3
 186 .nr doc-punct, 3
 187 .nr doc-punct: 3
 188 .nr doc-punct; 3
 189 .nr doc-punct( 4
 190 .nr doc-punct) 3
 191 .nr doc-punct[ 4
 192 .nr doc-punct] 3
 193 .nr doc-punct? 3
 194 .nr doc-punct! 3
 195 .
 196 .
 197 .\" header assembly macros
 198 .
 199 .\" NS doc-document-title global string
 200 .\" NS   the title of the manual page
 201 .
 202 .ds doc-document-title UNTITLED
 203 .
 204 .
 205 .\" NS doc-volume global string
 206 .\" NS   the volume where the manual page belongs to
 207 .
 208 .ds doc-volume LOCAL
 209 .
 210 .
 211 .\" NS doc-section global string
 212 .\" NS   the manual section
 213 .
 214 .ds doc-section Null
 215 .
 216 .
 217 .\" NS Dt user macro (not parsed, not callable)
 218 .\" NS   document title
 219 .\" NS
 220 .\" NS modifies:
 221 .\" NS   doc-document-title
 222 .\" NS   doc-section
 223 .\" NS   doc-volume
 224 .\" NS   doc-command-name
 225 .\" NS
 226 .\" NS local variables:
 227 .\" NS   doc-volume-as-XXX
 228 .\" NS   doc-volume-ds-XXX
 229 .\" NS
 230 .\" NS width register `Dt' set above
 231 .
 232 .\" an alternative, more detailed scheme for naming the manual sections
 233 .\"
 234 .ds doc-volume-operating-system BSD
 235 .nr doc-volume-operating-system-ateol 0
 236 .ds doc-volume-ds-1 General Commands Manual
 237 .ds doc-volume-ds-2 System Calls Manual
 238 .ds doc-volume-ds-3 Library Functions Manual
 239 .ds doc-volume-ds-4 Kernel Interfaces Manual
 240 .ds doc-volume-ds-5 File Formats Manual
 241 .ds doc-volume-ds-6 Games Manual
 242 .ds doc-volume-ds-7 Miscellaneous Information Manual
 243 .ds doc-volume-ds-8 System Manager's Manual
 244 .ds doc-volume-ds-9 Kernel Developer's Manual
 245 .
 246 .ds doc-volume-ds-USD   User's Supplementary Documents
 247 .ds doc-volume-ds-PS1   Programmer's Supplementary Documents
 248 .ds doc-volume-ds-AMD   Ancestral Manual Documents
 249 .ds doc-volume-ds-SMM   System Manager's Manual
 250 .ds doc-volume-ds-URM   User's Reference Manual
 251 .ds doc-volume-ds-PRM   Programmer's Manual
 252 .ds doc-volume-ds-KM    Kernel Manual
 253 .ds doc-volume-ds-IND   Manual Master Index
 254 .ds doc-volume-ds-LOCAL Local Manual
 255 .ds doc-volume-ds-CON   Contributed Software Manual
 256 .
 257 .als doc-volume-ds-MMI doc-volume-ds-IND
 258 .als doc-volume-ds-LOC doc-volume-ds-LOCAL
 259 .
 260 .ds doc-volume-as-alpha        alpha
 261 .als doc-volume-as-Alpha doc-volume-as-alpha
 262 .ds doc-volume-as-acorn26      acorn26
 263 .ds doc-volume-as-acorn32      acorn32
 264 .ds doc-volume-as-algor        algor
 265 .ds doc-volume-as-amd64        amd64
 266 .ds doc-volume-as-amiga        amiga
 267 .ds doc-volume-as-arc          arc
 268 .ds doc-volume-as-arm26        arm26
 269 .ds doc-volume-as-arm32        arm32
 270 .ds doc-volume-as-atari        atari
 271 .ds doc-volume-as-bebox        bebox
 272 .ds doc-volume-as-cats         cats
 273 .ds doc-volume-as-cesfic       cesfic
 274 .ds doc-volume-as-cobalt       cobalt
 275 .ds doc-volume-as-dreamcast    dreamcast
 276 .ds doc-volume-as-evbarm       evbarm
 277 .ds doc-volume-as-evbmips      evbmips
 278 .ds doc-volume-as-evbppc       evbppc
 279 .ds doc-volume-as-evbsh3       evbsh3
 280 .ds doc-volume-as-hp300        hp300
 281 .ds doc-volume-as-hp700        hp700
 282 .ds doc-volume-as-hpcarm       hpcarm
 283 .ds doc-volume-as-hpcmips      hpcmips
 284 .ds doc-volume-as-hpcsh        hpcsh
 285 .ds doc-volume-as-i386         i386
 286 .ds doc-volume-as-luna68k      luna68k
 287 .ds doc-volume-as-m68k         m68k
 288 .ds doc-volume-as-mac68k       mac68k
 289 .ds doc-volume-as-macppc       macppc
 290 .ds doc-volume-as-mips         mips
 291 .ds doc-volume-as-mipsco       mipsco
 292 .ds doc-volume-as-mmeye        mmeye
 293 .ds doc-volume-as-mvme68k      mvme68k
 294 .ds doc-volume-as-mvmeppc      mvmeppc
 295 .ds doc-volume-as-netwinder    netwinder
 296 .ds doc-volume-as-news68k      news68k
 297 .ds doc-volume-as-newsmips     newsmips
 298 .ds doc-volume-as-next68k      next68k
 299 .ds doc-volume-as-ofppc        ofppc
 300 .ds doc-volume-as-pc532        pc532
 301 .ds doc-volume-as-playstation2 playstation2
 302 .ds doc-volume-as-pmax         pmax
 303 .ds doc-volume-as-pmppc        pmppc
 304 .ds doc-volume-as-powerpc      powerpc
 305 .ds doc-volume-as-prep         prep
 306 .ds doc-volume-as-sandpoint    sandpoint
 307 .ds doc-volume-as-sbmips       sbmips
 308 .ds doc-volume-as-sgimips      sgimips
 309 .ds doc-volume-as-sh3          sh3
 310 .ds doc-volume-as-shark        shark
 311 .ds doc-volume-as-sparc        sparc
 312 .ds doc-volume-as-sparc64      sparc64
 313 .ds doc-volume-as-sun2         sun2
 314 .ds doc-volume-as-sun3         sun3
 315 .ds doc-volume-as-tahoe        tahoe
 316 .ds doc-volume-as-vax          vax
 317 .ds doc-volume-as-x68k         x68k
 318 .ds doc-volume-as-x86_64       x86_64
 319 .
 320 .de Dt
 321 .  \" reset default arguments
 322 .  ds doc-document-title UNTITLED
 323 .  ds doc-volume LOCAL
 324 .  ds doc-section Null
 325 .  ds doc-command-name
 326 .
 327 .  if !"\$1"" \
 328 .    ds doc-document-title "\$1
 329 .
 330 .  if !"\$2"" \{\
 331 .    ds doc-section \$2
 332 .    ie \B\a\$2\a \{\
 333 .      if ((\$2 >= 1) & (\$2 <= 9)) \{\
 334 .        ie \n[doc-volume-operating-system-ateol] \{\
 335 .          ds doc-volume "\*[doc-volume-ds-\$2] \*[doc-volume-operating-system]
 336 .          if \A\a\$3\a \{\
 337 .            if d doc-volume-as-\$3 \
 338 .              as doc-volume "/\*[doc-volume-as-\$3]
 339 .        \}\}
 340 .        el \{\
 341 .          ds doc-volume "\*[doc-volume-operating-system]
 342 .          if \A\a\$3\a \{\
 343 .            if d doc-volume-as-\$3 \
 344 .              as doc-volume "/\*[doc-volume-as-\$3]
 345 .          \}
 346 .          as doc-volume " \*[doc-volume-ds-\$2]
 347 .    \}\}\}
 348 .    el \{\
 349 .      ie "\$2"unass" \
 350 .        ds doc-volume DRAFT
 351 .      el \{ .ie "\$2"draft" \
 352 .        ds doc-volume DRAFT
 353 .      el .if "\$2"paper" \
 354 .        ds doc-volume UNTITLED
 355 .      \}\}
 356 .      if \A\a\$3\a \{\
 357 .        if d doc-volume-ds-\$3 \
 358 .          ds doc-volume "\*[doc-volume-ds-\$3]
 359 .  \}\}\}
 360 .
 361 .  if !"\$3"" \
 362 .    if "\*[doc-volume]"LOCAL" \
 363 .      ds doc-volume \$3
 364 .
 365 .  if !\n[cR] \
 366 .    if \n[nl] \{\
 367   .    doc-setup-header
 368 .      bp
 369 .    \}
 370 ..
 371 .
 372 .
 373 .\" NS doc-default-operating-system global string
 374 .\" NS   the exact (default) version of the operating system
 375 .\" NS
 376 .\" NS override this in `mdoc.local', if necessary
 377 .
 378 .ds doc-default-operating-system BSD
 379 .
 380 .
 381 .\" NS doc-operating-system global string
 382 .\" NS   the exact version of the operating system
 383 .
 384 .ds doc-operating-system
 385 .
 386 .
 387 .\" NS Os user macro (not parsed, not callable)
 388 .\" NS   operating system
 389 .\" NS
 390 .\" NS modifies:
 391 .\" NS   doc-operating-system
 392 .\" NS   doc-command-name
 393 .\" NS
 394 .\" NS local variables:
 395 .\" NS   doc-operating-system-XXX-XXX
 396 .\" NS
 397 .\" NS width register `Os' set above
 398 .
 399 .ds doc-operating-system-ATT-7   7th\~Edition
 400 .als doc-operating-system-ATT-7th doc-operating-system-ATT-7
 401 .ds doc-operating-system-ATT-3   System\~III
 402 .als doc-operating-system-ATT-III doc-operating-system-ATT-3
 403 .ds doc-operating-system-ATT-V   System\~V
 404 .ds doc-operating-system-ATT-V.2 System\~V Release\~2
 405 .ds doc-operating-system-ATT-V.3 System\~V Release\~3
 406 .ds doc-operating-system-ATT-V.4 System\~V Release\~4
 407 .
 408 .ds doc-operating-system-BSD-3    3rd\~Berkeley Distribution
 409 .ds doc-operating-system-BSD-4    4th\~Berkeley Distribution
 410 .ds doc-operating-system-BSD-4.1  4.1\~Berkeley Distribution
 411 .ds doc-operating-system-BSD-4.2  4.2\~Berkeley Distribution
 412 .ds doc-operating-system-BSD-4.3  4.3\~Berkeley Distribution
 413 .ds doc-operating-system-BSD-4.3T 4.3-Tahoe Berkeley Distribution
 414 .ds doc-operating-system-BSD-4.3R 4.3-Reno Berkeley Distribution
 415 .als doc-operating-system-BSD-4.3t doc-operating-system-BSD-4.3T
 416 .als doc-operating-system-BSD-4.3r doc-operating-system-BSD-4.3R
 417 .ds doc-operating-system-BSD-4.4  4.4BSD
 418 .
 419 .ds doc-operating-system-NetBSD-0.8   0.8
 420 .ds doc-operating-system-NetBSD-0.8a  0.8A
 421 .ds doc-operating-system-NetBSD-0.9   0.9
 422 .ds doc-operating-system-NetBSD-0.9a  0.9A
 423 .ds doc-operating-system-NetBSD-1.0   1.0
 424 .ds doc-operating-system-NetBSD-1.0a  1.0A
 425 .ds doc-operating-system-NetBSD-1.1   1.1
 426 .ds doc-operating-system-NetBSD-1.2   1.2
 427 .ds doc-operating-system-NetBSD-1.2a  1.2A
 428 .ds doc-operating-system-NetBSD-1.2b  1.2B
 429 .ds doc-operating-system-NetBSD-1.2c  1.2C
 430 .ds doc-operating-system-NetBSD-1.2d  1.2D
 431 .ds doc-operating-system-NetBSD-1.2e  1.2E
 432 .ds doc-operating-system-NetBSD-1.3   1.3
 433 .ds doc-operating-system-NetBSD-1.3a  1.3A
 434 .ds doc-operating-system-NetBSD-1.4   1.4
 435 .ds doc-operating-system-NetBSD-1.4.1 1.4.1
 436 .ds doc-operating-system-NetBSD-1.4.2 1.4.2
 437 .ds doc-operating-system-NetBSD-1.4.3 1.4.3
 438 .ds doc-operating-system-NetBSD-1.5   1.5
 439 .ds doc-operating-system-NetBSD-1.5.1 1.5.1
 440 .ds doc-operating-system-NetBSD-1.5.2 1.5.2
 441 .ds doc-operating-system-NetBSD-1.5.3 1.5.3
 442 .ds doc-operating-system-NetBSD-1.6   1.6
 443 .ds doc-operating-system-NetBSD-1.6.1 1.6.1
 444 .ds doc-operating-system-NetBSD-1.6.2 1.6.2
 445 .ds doc-operating-system-NetBSD-1.6.3 1.6.3
 446 .ds doc-operating-system-NetBSD-2.0   2.0
 447 .ds doc-operating-system-NetBSD-2.0.1 2.0.1
 448 .ds doc-operating-system-NetBSD-2.0.2 2.0.2
 449 .ds doc-operating-system-NetBSD-2.0.3 2.0.3
 450 .ds doc-operating-system-NetBSD-2.1   2.1
 451 .ds doc-operating-system-NetBSD-3.0   3.0
 452 .ds doc-operating-system-NetBSD-3.0.1 3.0.1
 453 .ds doc-operating-system-NetBSD-3.0.2 3.0.2
 454 .ds doc-operating-system-NetBSD-3.1   3.1
 455 .ds doc-operating-system-NetBSD-4.0   4.0
 456 .ds doc-operating-system-NetBSD-4.0.1 4.0.1
 457 .ds doc-operating-system-NetBSD-5.0   5.0
 458 .ds doc-operating-system-NetBSD-5.0.1 5.0.1
 459 .ds doc-operating-system-NetBSD-5.0.2 5.0.2
 460 .
 461 .ds doc-operating-system-OpenBSD-2.0  2.0
 462 .ds doc-operating-system-OpenBSD-2.1  2.1
 463 .ds doc-operating-system-OpenBSD-2.2  2.2
 464 .ds doc-operating-system-OpenBSD-2.3  2.3
 465 .ds doc-operating-system-OpenBSD-2.4  2.4
 466 .ds doc-operating-system-OpenBSD-2.5  2.5
 467 .ds doc-operating-system-OpenBSD-2.6  2.6
 468 .ds doc-operating-system-OpenBSD-2.7  2.7
 469 .ds doc-operating-system-OpenBSD-2.8  2.8
 470 .ds doc-operating-system-OpenBSD-2.9  2.9
 471 .ds doc-operating-system-OpenBSD-3.0  3.0
 472 .ds doc-operating-system-OpenBSD-3.1  3.1
 473 .ds doc-operating-system-OpenBSD-3.2  3.2
 474 .ds doc-operating-system-OpenBSD-3.3  3.3
 475 .ds doc-operating-system-OpenBSD-3.4  3.4
 476 .ds doc-operating-system-OpenBSD-3.5  3.5
 477 .ds doc-operating-system-OpenBSD-3.6  3.6
 478 .ds doc-operating-system-OpenBSD-3.7  3.7
 479 .ds doc-operating-system-OpenBSD-3.8  3.8
 480 .ds doc-operating-system-OpenBSD-3.9  3.9
 481 .ds doc-operating-system-OpenBSD-4.0  4.0
 482 .ds doc-operating-system-OpenBSD-4.1  4.1
 483 .ds doc-operating-system-OpenBSD-4.2  4.2
 484 .ds doc-operating-system-OpenBSD-4.3  4.3
 485 .ds doc-operating-system-OpenBSD-4.4  4.4
 486 .ds doc-operating-system-OpenBSD-4.5  4.5
 487 .ds doc-operating-system-OpenBSD-4.6  4.6
 488 .ds doc-operating-system-OpenBSD-4.7  4.7
 489 .ds doc-operating-system-OpenBSD-4.8  4.8
 490 .
 491 .ds doc-operating-system-FreeBSD-1.0     1.0
 492 .ds doc-operating-system-FreeBSD-1.1     1.1
 493 .ds doc-operating-system-FreeBSD-1.1.5   1.1.5
 494 .ds doc-operating-system-FreeBSD-1.1.5.1 1.1.5.1
 495 .ds doc-operating-system-FreeBSD-2.0     2.0
 496 .ds doc-operating-system-FreeBSD-2.0.5   2.0.5
 497 .ds doc-operating-system-FreeBSD-2.1     2.1
 498 .ds doc-operating-system-FreeBSD-2.1.5   2.1.5
 499 .ds doc-operating-system-FreeBSD-2.1.6   2.1.6
 500 .ds doc-operating-system-FreeBSD-2.1.7   2.1.7
 501 .ds doc-operating-system-FreeBSD-2.2     2.2
 502 .ds doc-operating-system-FreeBSD-2.2.1   2.2.1
 503 .ds doc-operating-system-FreeBSD-2.2.2   2.2.2
 504 .ds doc-operating-system-FreeBSD-2.2.5   2.2.5
 505 .ds doc-operating-system-FreeBSD-2.2.6   2.2.6
 506 .ds doc-operating-system-FreeBSD-2.2.7   2.2.7
 507 .ds doc-operating-system-FreeBSD-2.2.8   2.2.8
 508 .ds doc-operating-system-FreeBSD-3.0     3.0
 509 .ds doc-operating-system-FreeBSD-3.1     3.1
 510 .ds doc-operating-system-FreeBSD-3.2     3.2
 511 .ds doc-operating-system-FreeBSD-3.3     3.3
 512 .ds doc-operating-system-FreeBSD-3.4     3.4
 513 .ds doc-operating-system-FreeBSD-3.5     3.5
 514 .ds doc-operating-system-FreeBSD-4.0     4.0
 515 .ds doc-operating-system-FreeBSD-4.1     4.1
 516 .ds doc-operating-system-FreeBSD-4.1.1   4.1.1
 517 .ds doc-operating-system-FreeBSD-4.2     4.2
 518 .ds doc-operating-system-FreeBSD-4.3     4.3
 519 .ds doc-operating-system-FreeBSD-4.4     4.4
 520 .ds doc-operating-system-FreeBSD-4.5     4.5
 521 .ds doc-operating-system-FreeBSD-4.6     4.6
 522 .ds doc-operating-system-FreeBSD-4.6.2   4.6.2
 523 .ds doc-operating-system-FreeBSD-4.7     4.7
 524 .ds doc-operating-system-FreeBSD-4.8     4.8
 525 .ds doc-operating-system-FreeBSD-4.9     4.9
 526 .ds doc-operating-system-FreeBSD-4.10    4.10
 527 .ds doc-operating-system-FreeBSD-4.11    4.11
 528 .ds doc-operating-system-FreeBSD-5.0     5.0
 529 .ds doc-operating-system-FreeBSD-5.1     5.1
 530 .ds doc-operating-system-FreeBSD-5.2     5.2
 531 .ds doc-operating-system-FreeBSD-5.2.1   5.2.1
 532 .ds doc-operating-system-FreeBSD-5.3     5.3
 533 .ds doc-operating-system-FreeBSD-5.4     5.4
 534 .ds doc-operating-system-FreeBSD-5.5     5.5
 535 .ds doc-operating-system-FreeBSD-6.0     6.0
 536 .ds doc-operating-system-FreeBSD-6.1     6.1
 537 .ds doc-operating-system-FreeBSD-6.2     6.2
 538 .ds doc-operating-system-FreeBSD-6.3     6.3
 539 .ds doc-operating-system-FreeBSD-6.4     6.4
 540 .ds doc-operating-system-FreeBSD-7.0     7.0
 541 .ds doc-operating-system-FreeBSD-7.1     7.1
 542 .ds doc-operating-system-FreeBSD-7.2     7.2
 543 .ds doc-operating-system-FreeBSD-7.3     7.3
 544 .ds doc-operating-system-FreeBSD-8.0     8.0
 545 .ds doc-operating-system-FreeBSD-8.1     8.1
 546 .ds doc-operating-system-FreeBSD-8.2     8.2
 547 .
 548 .ds doc-operating-system-Darwin-8.0.0  8.0.0
 549 .ds doc-operating-system-Darwin-8.1.0  8.1.0
 550 .ds doc-operating-system-Darwin-8.2.0  8.2.0
 551 .ds doc-operating-system-Darwin-8.3.0  8.3.0
 552 .ds doc-operating-system-Darwin-8.4.0  8.4.0
 553 .ds doc-operating-system-Darwin-8.5.0  8.5.0
 554 .ds doc-operating-system-Darwin-8.6.0  8.6.0
 555 .ds doc-operating-system-Darwin-8.7.0  8.7.0
 556 .ds doc-operating-system-Darwin-8.8.0  8.8.0
 557 .ds doc-operating-system-Darwin-8.9.0  8.9.0
 558 .ds doc-operating-system-Darwin-8.10.0 8.10.0
 559 .ds doc-operating-system-Darwin-8.11.0 8.11.0
 560 .ds doc-operating-system-Darwin-9.0.0  9.0.0
 561 .ds doc-operating-system-Darwin-9.1.0  9.1.0
 562 .ds doc-operating-system-Darwin-9.2.0  9.2.0
 563 .ds doc-operating-system-Darwin-9.3.0  9.3.0
 564 .ds doc-operating-system-Darwin-9.4.0  9.4.0
 565 .ds doc-operating-system-Darwin-9.5.0  9.5.0
 566 .ds doc-operating-system-Darwin-9.6.0  9.6.0
 567 .ds doc-operating-system-Darwin-9.7.0  9.7.0
 568 .ds doc-operating-system-Darwin-9.8.0  9.8.0
 569 .ds doc-operating-system-Darwin-10.6.0 10.6.0
 570 .ds doc-operating-system-Darwin-10.1.0 10.1.0
 571 .ds doc-operating-system-Darwin-10.2.0 10.2.0
 572 .ds doc-operating-system-Darwin-10.3.0 10.3.0
 573 .ds doc-operating-system-Darwin-10.4.0 10.4.0
 574 .ds doc-operating-system-Darwin-10.5.0 10.5.0
 575 .ds doc-operating-system-Darwin-10.6.0 10.6.0
 576 .ds doc-operating-system-Darwin-10.7.0 10.7.0
 577 .ds doc-operating-system-Darwin-11.0.0 11.0.0
 578 .
 579 .ds doc-operating-system-DragonFly-1.0    1.0
 580 .ds doc-operating-system-DragonFly-1.1    1.1
 581 .ds doc-operating-system-DragonFly-1.2    1.2
 582 .ds doc-operating-system-DragonFly-1.3    1.3
 583 .ds doc-operating-system-DragonFly-1.4    1.4
 584 .ds doc-operating-system-DragonFly-1.5    1.5
 585 .ds doc-operating-system-DragonFly-1.6    1.6
 586 .ds doc-operating-system-DragonFly-1.8    1.8
 587 .ds doc-operating-system-DragonFly-1.8.1  1.8.1
 588 .ds doc-operating-system-DragonFly-1.10   1.10
 589 .ds doc-operating-system-DragonFly-1.12   1.12
 590 .ds doc-operating-system-DragonFly-1.12.2 1.12.2
 591 .ds doc-operating-system-DragonFly-2.0    2.0
 592 .ds doc-operating-system-DragonFly-2.2    2.2
 593 .ds doc-operating-system-DragonFly-2.4    2.4
 594 .ds doc-operating-system-DragonFly-2.6    2.6
 595 .ds doc-operating-system-DragonFly-2.8    2.8
 596 .
 597 .de Os
 598 .  ds doc-command-name
 599 .
 600 .  ie "\$1"" \
 601 .    ds doc-operating-system "\*[doc-default-operating-system]
 602 .  el \{ .ie "\$1"ATT" \{\
 603 .    ds doc-operating-system AT&T
 604 .    if \A\a\$2\a \{\
 605 .      ie d doc-operating-system-ATT-\$2 \
 606 .        as doc-operating-system " \*[doc-operating-system-ATT-\$2]
 607 .      el \
 608 .        as doc-operating-system " UNIX
 609 .  \}\}
 610 .  el \{ .ie "\$1"BSD" \{\
 611 .    if \A\a\$2\a \{\
 612 .      ie d doc-operating-system-BSD-\$2 \
 613 .        ds doc-operating-system "\*[doc-operating-system-BSD-\$2]
 614 .      el \
 615 .        tm mdoc warning: .Os: Unknown BSD version `\$2' (#\n[.c])
 616 .  \}\}
 617 .  el \{ .ie "\$1"FreeBSD" \{\
 618 .    ds doc-operating-system FreeBSD
 619 .    if \A\a\$2\a \{\
 620 .      ie d doc-operating-system-FreeBSD-\$2 \
 621 .        as doc-operating-system \~\*[doc-operating-system-FreeBSD-\$2]
 622 .      el \
 623 .        tm mdoc warning: .Os: Unknown FreeBSD version `\$2' (#\n[.c])
 624 .  \}\}
 625 .  el \{ .ie "\$1"DragonFly" \{\
 626 .    ds doc-operating-system DragonFly
 627 .    if \A\a\$2\a \{\
 628 .      ie d doc-operating-system-DragonFly-\$2 \
 629 .        as doc-operating-system \~\*[doc-operating-system-DragonFly-\$2]
 630 .      el \
 631 .        tm mdoc warning: .Os: Unknown DragonFly version `\$2' (#\n[.c])
 632 .  \}\}
 633 .  el \{ .ie "\$1"NetBSD" \{\
 634 .    ds doc-operating-system NetBSD
 635 .    if \A\a\$2\a \{\
 636 .      ie d doc-operating-system-NetBSD-\$2 \
 637 .        as doc-operating-system \~\*[doc-operating-system-NetBSD-\$2]
 638 .      el \
 639 .        tm mdoc warning: .Os: Unknown NetBSD version `\$2' (#\n[.c])
 640 .  \}\}
 641 .  el \{ .ie "\$1"OpenBSD" \{\
 642 .    ds doc-operating-system OpenBSD
 643 .    if \A\a\$2\a \{\
 644 .      ie d doc-operating-system-OpenBSD-\$2 \
 645 .        as doc-operating-system \~\*[doc-operating-system-OpenBSD-\$2]
 646 .      el \
 647 .        tm mdoc warning: .Os: Unknown OpenBSD version `\$2' (#\n[.c])
 648 .  \}\}
 649 .  el \{ .ie "\$1"Darwin" \{\
 650 .    ds doc-operating-system Darwin
 651 .    if \A\a\$2\a \{\
 652 .      ie d doc-operating-system-Darwin-\$2 \
 653 .        as doc-operating-system \~\*[doc-operating-system-Darwin-\$2]
 654 .      el \
 655 .        tm mdoc warning: .Os: Unknown Darwin version `\$2' (#\n[.c])
 656 .  \}\}
 657 .  el \{\
 658 .    ds doc-operating-system \$1
 659 .    if !"\$2"" \
 660 .      as doc-operating-system " \$2
 661 .  \}\}\}\}\}\}\}\}
 662 ..
 663 .
 664 .
 665 .\" NS doc-date-string global string
 666 .\" NS   the manual page date as set by `Dd'
 667 .
 668 .ds doc-date-string
 669 .
 670 .
 671 .\" NS Dd user macro (not parsed, not callable)
 672 .\" NS   set document date
 673 .\" NS
 674 .\" NS modifies:
 675 .\" NS   doc-date-string
 676 .\" NS   doc-command-name
 677 .\" NS
 678 .\" NS local variables:
 679 .\" NS   doc-date-XXX
 680 .\" NS
 681 .\" NS width register `Dd' set above
 682 .
 683 .ds doc-date-1  January
 684 .ds doc-date-2  February
 685 .ds doc-date-3  March
 686 .ds doc-date-4  April
 687 .ds doc-date-5  May
 688 .ds doc-date-6  June
 689 .ds doc-date-7  July
 690 .ds doc-date-8  August
 691 .ds doc-date-9  September
 692 .ds doc-date-10 October
 693 .ds doc-date-11 November
 694 .ds doc-date-12 December
 695 .
 696 .de Dd
 697 .  ds doc-command-name
 698 .
 699 .  ie \n[.$] \{\
 700 .    ie (\n[.$] == 3) \
 701 .      ds doc-date-string \$1\~\$2 \$3
 702 .    el \{\
 703 .      ds doc-date-string "\*[doc-date-\n[mo]]
 704 .      as doc-date-string \~\n[dy], \n[year]
 705 .    \}
 706 .  \}
 707 .  el \
 708 .    ds doc-date-string Epoch
 709 ..
 710 .
 711 .
 712 .\" NS doc-hyphen-flags global register
 713 .\" NS   the parameter for the `.hy' request
 714 .\" NS
 715 .\" NS override this in `mdoc.local', if necessary.
 716 .
 717 .nr doc-hyphen-flags 12
 718 .
 719 .
 720 .\" NS doc-header macro
 721 .\" NS   print page header
 722 .\" NS
 723 .\" NS local variables:
 724 .\" NS   doc-reg-dh
 725 .\" NS   doc-reg-dh1
 726 .
 727 .de doc-header
 728 .  ev doc-env-dh
 729 .  doc-setup-page-layout
 730 .  if !\n[cR] \
 731 .    sp \n[doc-header-space]u
 732 .  nr doc-reg-dh \w'\*[doc-caption-font]\*[doc-header-string]\f[]'
 733 .  nr doc-reg-dh1 \w'\*[doc-caption-font2]\*[doc-volume]\f[]'
 734 .  if (\n[doc-reg-dh] + \n[doc-reg-dh1] + \n[doc-reg-dh] >= \n[.lt]) \{\
 735 .    while (\n[doc-reg-dh] + \n[doc-reg-dh1] + \n[doc-reg-dh] >= \n[.lt]) \{\
 736 .      substring doc-header-string 0 -2
 737 .      nr doc-reg-dh \w'\*[doc-caption-font]\*[doc-header-string]\|.\|.\|.\f[]'
 738 .    \}
 739 .    as doc-header-string "\|.\|.\|.
 740 .  \}
 741 .  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
 742 .  ie !\n[cR] \
 743 .    sp \n[doc-header-space]u
 744 .  el \
 745 .    sp 1v
 746 .  ev
 747 .  ns
 748 ..
 749 .
 750 .
 751 .\" NS doc-footer macro
 752 .\" NS   print page footer
 753 .
 754 .de doc-footer
 755 .  ie \n[cR] \
 756 .    br
 757 .  el \{\
 758 .    ev doc-caption-enviroment
 759 .    doc-setup-page-layout
 760 .    sp \n[doc-footer-space]u
 761 .    ie \n[D] \{\
 762 .      ie o \
 763 .        tl \a%\a\*[doc-caption-font2]\*[doc-date-string]\f[]\a\*[doc-caption-font]\*[doc-operating-system]\f[]\a
 764 .      el \
 765 .        tl \a\*[doc-caption-font]\*[doc-operating-system]\f[]\a\*[doc-caption-font2]\*[doc-date-string]\f[]\a%\a
 766 .    \}
 767 .    el \
 768 .      tl \a\*[doc-caption-font]\*[doc-operating-system]\f[]\a\*[doc-caption-font2]\*[doc-date-string]\f[]\a%\a
 769 .    bp
 770 .    ev
 771 .  \}
 772 ..
 773 .
 774 .
 775 .\" NS doc-check-depth macro
 776 .\" NS   check paired macros
 777 .
 778 .de doc-check-depth
 779 .  if \n[doc-list-depth] \{\
 780 .    tm mdoc warning: A .Bl directive has no matching .El (#\n[.c])
 781 .    nr doc-list-depth 0
 782 .  \}
 783 .  if \n[doc-display-depth] \{\
 784 .    tm mdoc warning: A .Bd directive has no matching .Ed (#\n[.c])
 785 .    nr doc-display-depth 0
 786 .  \}
 787 .  if \n[doc-fontmode-depth] \{\
 788 .    tm mdoc warning: A .Bf directive has no matching .Ef (#\n[.c])
 789 .    nr doc-fontmode-depth 0
 790 .  \}
 791 ..
 792 .
 793 .
 794 .\" NS doc-end-macro macro
 795 .\" NS   finish output
 796 .
 797 .de doc-end-macro
 798 .  \" We may still have a partial line in the environment.  If this is the
 799 .  \" case, and we happen to be on the last line of the page, the `.fl'
 800 .  \" request will cause the page to be ejected and troff will immediately
 801 .  \" exit.  If we are in nroff mode, this would be unfortunate, since we
 802 .  \" would never get a chance to output the footer.  So we fudge the page
 803 .  \" length to make sure that the last page is never ejected until we want
 804 .  \" it to be.
 805 .
 806 .  if \n[cR] \
 807 .    pl +3v
 808 .  fl
 809 .
 810 .  doc-check-depth
 811 .
 812 .  if \n[cR] \{\
 813 .    sp
 814 .    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
 815 .    \" suppress empty lines after the footer
 816 .    pl \n[nl]u
 817 .  \}
 818 ..
 819 .
 820 .
 821 .\" NS doc-paragraph macro
 822 .\" NS   insert a paragraph
 823 .
 824 .de doc-paragraph
 825 .  sp \n[doc-paragraph-space]u
 826 .  if !\n[cR] \
 827 .    ne 2
 828 .  ns
 829 ..
 830 .
 831 .
 832 .\" NS Pp user macro (not parsed, not callable)
 833 .\" NS   new paragraph
 834 .\" NS
 835 .\" NS width register `Pp' set above
 836 .
 837 .als Pp doc-paragraph
 838 .
 839 .
 840 .\" NS Lp user macro (not parsed, not callable)
 841 .\" NS   same as .Pp
 842 .\" NS
 843 .\" NS width register `Lp' set above
 844 .
 845 .als Lp doc-paragraph
 846 .
 847 .
 848 .de LP
 849 .  tm Not a \-mdoc command: .LP (#\n[.c])
 850 ..
 851 .
 852 .
 853 .de PP
 854 .  tm Not a \-mdoc command: .PP (#\n[.c])
 855 ..
 856 .
 857 .
 858 .de pp
 859 .  tm Not a \-mdoc command: .pp (#\n[.c])
 860 ..
 861 .
 862 .
 863 .de SH
 864 .  tm Not a \-mdoc command: .SH (#\n[.c])
 865 ..
 866 .
 867 .
 868 .\" NS Nd user macro (not parsed, not callable)
 869 .\" NS   print name description
 870 .\" NS
 871 .\" NS width register `Nd' set above
 872 .
 873 .de Nd
 874 .  nop \[em] \$*
 875 ..
 876 .
 877 .
 878 .\" NS doc-in-synopsis-section global register (bool)
 879 .\" NS   whether we are in the `synopsis' section
 880 .
 881 .nr doc-in-synopsis-section 0
 882 .
 883 .
 884 .\" NS doc-in-library-section global register (bool)
 885 .\" NS   whether we are in the `library' section
 886 .
 887 .nr doc-in-library-section 0
 888 .
 889 .
 890 .\" NS doc-in-see-also-section global register (bool)
 891 .\" NS   whether we are in the `see also' section
 892 .
 893 .nr doc-in-see-also-section 0
 894 .
 895 .
 896 .\" NS doc-in-files-section global register (bool)
 897 .\" NS   whether we are in the `files' section
 898 .
 899 .nr doc-in-files-section 0
 900 .
 901 .
 902 .\" NS doc-in-authors-section global register (bool)
 903 .\" NS   whether we are in the `authors' section
 904 .
 905 .nr doc-in-authors-section 0
 906 .
 907 .
 908 .\" NS doc-first-parameter macro
 909 .\" NS   return first parameter
 910 .\" NS
 911 .\" NS local variables:
 912 .\" NS   doc-str-dfp
 913 .
 914 .de doc-first-parameter
 915 .  ds doc-str-dfp "\$1
 916 ..
 917 .
 918 .
 919 .\" NS Sh user macro (not callable)
 920 .\" NS   section headers
 921 .\" NS
 922 .\" NS modifies:
 923 .\" NS   doc-func-args-processed
 924 .\" NS   doc-func-count
 925 .\" NS   doc-in-authors-section
 926 .\" NS   doc-in-files-section
 927 .\" NS   doc-in-library-section
 928 .\" NS   doc-in-see-also-section
 929 .\" NS   doc-in-synopsis-section
 930 .\" NS   doc-indent-synopsis
 931 .\" NS   doc-indent-synopsis-active
 932 .\" NS   doc-is-func
 933 .\" NS   doc-num-func-args
 934 .\" NS
 935 .\" NS local variables:
 936 .\" NS   doc-reg-Sh
 937 .\" NS   doc-reg-Sh1
 938 .\" NS   doc-section-XXX
 939 .\" NS
 940 .\" NS width register `Sh' set in doc-common
 941 .
 942 .ds doc-section-name        NAME
 943 .ds doc-section-synopsis    SYNOPSIS
 944 .ds doc-section-library     LIBRARY
 945 .ds doc-section-description DESCRIPTION
 946 .ds doc-section-see-also    SEE
 947 .ds doc-section-files       FILES
 948 .ds doc-section-authors     AUTHORS
 949 .
 950 .de Sh
 951 .  ie \n[doc-arg-limit] \{\
 952 .    \" we only allow `Sh' within `Sh'; it will change the font back to
 953 .    \" `doc-Sh-font'
 954 .    ie "\*[doc-macro-name]"Sh" \{\
 955 .      nr doc-arg-ptr +1
 956 .      ie (\n[doc-arg-limit] >= \n[doc-arg-ptr]) \{\
 957 .        nr doc-curr-font \n[.f]
 958 .        nr doc-curr-size \n[.ps]
 959 .        nop \*[doc-Sh-font]\c
 960 .        doc-print-recursive
 961 .      \}
 962 .      el \{\
 963 .        tm Usage: .Sh section_name ... (#\n[.c])
 964 .        doc-reset-args
 965 .    \}\}
 966 .    el \{\
 967 .      tm Usage: .Sh not callable by other macros (#\n[.c])
 968 .      doc-reset-args
 969 .  \}\}
 970 .  el \{\
 971 .    if !\n[.$] \{\
 972 .      tm Usage: .Sh section_name ... (#\n[.c])
 973 .      return
 974 .    \}
 975 .
 976 .    ds doc-macro-name Sh
 977 .    doc-parse-args \$@
 978 .
 979 .    if t \
 980 .      ad
 981 .
 982 .    \" this resolves e.g. `.Sh "SEE ALSO"'
 983 .    doc-first-parameter \$*
 984 .
 985 .    ie "\*[doc-str-dfp]"\*[doc-section-name]" \{\
 986 .      doc-setup-header
 987 .      in 0
 988 .    \}
 989 .    el \{\
 990 .      nr doc-in-synopsis-section 0
 991 .      nr doc-in-library-section 0
 992 .      nr doc-in-see-also-section 0
 993 .      nr doc-in-files-section 0
 994 .      nr doc-in-authors-section 0
 995 .
 996 .      ie        "\*[doc-str-dfp]"\*[doc-section-synopsis]" \{\
 997 .        if t \
 998 .          na
 999 .        nr doc-in-synopsis-section 1
1000 .        nr doc-indent-synopsis 0
1001 .        nr doc-indent-synopsis-active 0
1002 .      \}
1003 .      el \{ .ie "\*[doc-str-dfp]"\*[doc-section-library]" \{\
1004 .        nr doc-in-library-section 1
1005 .      \}
1006 .      el \{ .ie "\*[doc-str-dfp]"\*[doc-section-description]" \{\
1007 .        nr doc-is-func 0
1008 .        nr doc-func-count 0
1009 .        nr doc-func-args-processed 0
1010 .        nr doc-num-func-args 0
1011 .      \}
1012 .      el \{ .ie "\*[doc-str-dfp]"\*[doc-section-see-also]" \{\
1013 .        if t \
1014 .          na
1015 .        nr doc-in-see-also-section 1
1016 .      \}
1017 .      el \{ .ie "\*[doc-str-dfp]"\*[doc-section-files]" \
1018 .        nr doc-in-files-section 1
1019 .      el .if    "\*[doc-str-dfp]"\*[doc-section-authors]" \
1020 .        nr doc-in-authors-section 1
1021 .      \}\}\}\}
1022 .
1023 .      in 0
1024 .      nr doc-have-author 0
1025 .    \}
1026 .
1027 .    doc-setup-page-layout
1028 .    sp
1029 .    ns
1030 .    ta T .5i
1031 .    if !\n[cR] \
1032 .      ne 3
1033 .    fi
1034 .
1035 .    if t \{\
1036 .      nr doc-reg-Sh \n[.ss]
1037 .      nr doc-reg-Sh1 \n[.sss]
1038 .      ss (\n[.ss] * 5 / 3) (\n[.sss] * 5 / 3)
1039 .    \}
1040 .
1041 .    nr doc-arg-ptr +1
1042 .    nr doc-curr-font \n[.f]
1043 .    nr doc-curr-size \n[.ps]
1044 .    nop \*[doc-Sh-font]\c
1045 .    doc-print-recursive
1046 .
1047 .    if t \
1048 .      ss \n[doc-reg-Sh] \n[doc-reg-Sh1]
1049 .
1050 .    in +\n[doc-subheader-indent]u
1051 .    ns
1052 .
1053 .    doc-check-depth
1054 .  \}
1055 ..
1056 .
1057 .
1058 .\" NS Ss user macro (not callable)
1059 .\" NS   subsection
1060 .\" NS
1061 .\" NS local variable:
1062 .\" NS   doc-reg-Ss
1063 .\" NS   doc-reg-Ss1
1064 .\" NS
1065 .\" NS width register `Ss' set above
1066 .
1067 .de Ss
1068 .  ie \n[doc-arg-limit] \{\
1069 .    \" we only allow `Ss' within `Ss'; it will change the font back to
1070 .    \" `doc-Sh-font'
1071 .    ie "\*[doc-macro-name]"Ss" \{\
1072 .      nr doc-arg-ptr +1
1073 .      ie (\n[doc-arg-limit] >= \n[doc-arg-ptr]) \{\
1074 .        nr doc-curr-font \n[.f]
1075 .        nr doc-curr-size \n[.ps]
1076 .        nop \*[doc-Sh-font]\c
1077 .        doc-print-recursive
1078 .      \}
1079 .      el \{\
1080 .        tm Usage: .Ss subsection_name ... (#\n[.c])
1081 .        doc-reset-args
1082 .    \}\}
1083 .    el \{\
1084 .      tm Usage: .Ss not callable by other macros (#\n[.c])
1085 .      doc-reset-args
1086 .  \}\}
1087 .  el \{\
1088 .    if !\n[.$] \{\
1089 .      tm Usage: .Ss subsection_name ... (#\n[.c])
1090 .      return
1091 .    \}
1092 .
1093 .    ds doc-macro-name Ss
1094 .    doc-parse-args \$@
1095 .
1096 .    sp
1097 .    if !\n[cR] \
1098 .      ne 3
1099 .    ti -.25i
1100 .
1101 .    nr doc-reg-Ss \n[.ss]
1102 .    nr doc-reg-Ss1 \n[.sss]
1103 .    ss (\n[.ss] * 5 / 4) (\n[.sss] * 5 / 4)
1104 .
1105 .    nr doc-arg-ptr +1
1106 .    nr doc-curr-font \n[.f]
1107 .    nr doc-curr-size \n[.ps]
1108 .    nop \*[doc-Sh-font]\c
1109 .    doc-print-recursive
1110 .
1111 .    ss \n[doc-reg-Ss] \n[doc-reg-Ss1]
1112 .
1113 .    ta T .5i
1114 .    if !\n[cR] \
1115 .      ne 2
1116 .    br
1117 .    ns
1118 .
1119 .    doc-check-depth
1120 .  \}
1121 ..
1122 .
1123 .
1124 .\" NS Rd macro (not parsed, not callable)
1125 .\" NS   print global register dump to stderr
1126 .\" NS
1127 .\" NS local variables:
1128 .\" NS   doc-reg-Rd
1129 .
1130 .de Rd
1131 .  tm MDOC GLOBAL REGISTER DUMP
1132 .  tm doc-macro-name == `\*[doc-macro-name]'
1133 .  tm doc-arg-limit == \n[doc-arg-limit]
1134 .  tm doc-num-args == \n[doc-num-args]
1135 .  tm doc-arg-ptr == \n[doc-arg-ptr]
1136 .
1137 .  nr doc-reg-Rd 1
1138 .  while (\n[doc-reg-Rd] <= \n[doc-arg-limit]) \{\
1139 .    tm doc-arg\n[doc-reg-Rd] == `\*[doc-arg\n[doc-reg-Rd]]'
1140 .    tm doc-type\n[doc-reg-Rd] == \n[doc-type\n[doc-reg-Rd]]
1141 .    tm doc-space\n[doc-reg-Rd] == `\*[doc-space\n[doc-reg-Rd]]'
1142 .    nr doc-reg-Rd +1
1143 .  \}
1144 .
1145 .  tm doc-curr-font == \n[doc-curr-font]
1146 .  tm doc-curr-size == \n[doc-curr-size]
1147 .  tm doc-indent-synopsis == \n[doc-indent-synopsis]
1148 .  tm doc-indent-synopsis-active == \n[doc-indent-synopsis-active]
1149 .  tm doc-have-decl == \n[doc-have-decl]
1150 .  tm doc-have-var == \n[doc-have-var]
1151 .  tm doc-command-name == `\*[doc-command-name]'
1152 .  tm doc-quote-left == `\*[doc-quote-left]'
1153 .  tm doc-quote-right == `\*[doc-quote-right]'
1154 .  tm doc-nesting-level == \n[doc-nesting-level]
1155 .  tm doc-in-list == \n[doc-in-list]
1156 .  tm doc-space == `\*[doc-space]'
1157 .  tm doc-saved-space == `\*[doc-saved-space]'
1158 .  tm doc-space-mode == \n[doc-space-mode]
1159 .  tm doc-have-space == \n[doc-have-space]
1160 .  tm doc-have-slot == \n[doc-have-slot]
1161 .  tm doc-keep-type == \n[doc-keep-type]
1162 .  tm doc-display-depth == \n[doc-display-depth]
1163 .  tm doc-is-compact == \n[doc-is-compact]
1164 .
1165 .  nr doc-reg-Rd 0
1166 .  while (\n[doc-reg-Rd] <= \n[doc-display-depth]) \{\
1167 .    tm doc-display-type-stack\n[doc-reg-Rd] == `\*[doc-display-type-stack\n[doc-reg-Rd]]'
1168 .    tm doc-display-indent-stack\n[doc-reg-Rd] == \n[doc-display-indent-stack\n[doc-reg-Rd]]
1169 .    tm doc-display-ad-stack\n[doc-reg-Rd] == \n[doc-display-ad-stack\n[doc-reg-Rd]]
1170 .    tm doc-display-fi-stack\n[doc-reg-Rd] == \n[doc-display-fi-stack\n[doc-reg-Rd]]
1171 .    tm doc-display-ft-stack\n[doc-reg-Rd] == \n[doc-display-ft-stack\n[doc-reg-Rd]]
1172 .    tm doc-display-ps-stack\n[doc-reg-Rd] == \n[doc-display-ps-stack\n[doc-reg-Rd]]
1173 .    nr doc-reg-Rd +1
1174 .  \}
1175 .
1176 .  tm doc-fontmode-depth == \n[doc-fontmode-depth]
1177 .
1178 .  nr doc-reg-Rd 1
1179 .  while (\n[doc-reg-Rd] <= \n[doc-fontmode-depth]) \{\
1180 .    tm doc-fontmode-font-stack\n[doc-reg-Rd] == `\n[doc-fontmode-font-stack\n[doc-reg-Rd]]'
1181 .    tm doc-fontmode-size-stack\n[doc-reg-Rd] == `\n[doc-fontmode-size-stack\n[doc-reg-Rd]]'
1182 .    nr doc-reg-Rd +1
1183 .  \}
1184 .
1185 .  tm doc-list-depth == \n[doc-list-depth]
1186 .
1187 .  nr doc-reg-Rd 1
1188 .  while (\n[doc-reg-Rd] <= \n[doc-list-depth]) \{\
1189 .    tm doc-list-type-stack\n[doc-reg-Rd] == `\*[doc-list-type-stack\n[doc-reg-Rd]]'
1190 .    tm doc-list-have-indent-stack\n[doc-reg-Rd] == \n[doc-list-have-indent-stack\n[doc-reg-Rd]]
1191 .    tm doc-list-indent-stack\n[doc-reg-Rd] == \n[doc-list-indent-stack\n[doc-reg-Rd]]
1192 .    tm doc-compact-list-stack\n[doc-reg-Rd] == \n[doc-compact-list-stack\n[doc-reg-Rd]]
1193 .    tm doc-tag-prefix-stack\n[doc-reg-Rd] == `\*[doc-tag-prefix-stack\n[doc-reg-Rd]]'
1194 .    tm doc-tag-width-stack\n[doc-reg-Rd] == `\*[doc-tag-width-stack\n[doc-reg-Rd]]'
1195 .    tm doc-list-offset-stack\n[doc-reg-Rd] == \n[doc-list-offset-stack\n[doc-reg-Rd]]
1196 .    tm doc-enum-list-count-stack\n[doc-reg-Rd] == \n[doc-enum-list-count-stack\n[doc-reg-Rd]]
1197 .    nr doc-reg-Rd +1
1198 .  \}
1199 .
1200 .  tm doc-saved-Pa-font == `\*[doc-saved-Pa-font]'
1201 .  tm doc-curr-type == \n[doc-curr-type]
1202 .  tm doc-curr-arg == `\*[doc-curr-arg]'
1203 .  tm doc-diag-list-input-line-count == \n[doc-diag-list-input-line-count]
1204 .  tm doc-num-columns == \n[doc-num-columns]
1205 .  tm doc-column-indent-width == \n[doc-column-indent-width]
1206 .  tm doc-is-func == \n[doc-is-func]
1207 .  tm doc-have-old-func == \n[doc-have-old-func]
1208 .  tm doc-func-arg-count == \n[doc-func-arg-count]
1209 .  tm doc-func-arg == `\*[doc-func-arg]'
1210 .  tm doc-num-func-args == \n[doc-num-func-args]
1211 .  tm doc-func-args-processed == \n[doc-func-args-processed]
1212 .  tm doc-have-func == \n[doc-have-func]
1213 .  tm doc-is-reference == \n[doc-is-reference]
1214 .  tm doc-reference-count == \n[doc-reference-count]
1215 .  tm doc-author-count == \n[doc-author-count]
1216 .
1217 .  nr doc-reg-Rd 0
1218 .  while (\n[doc-reg-Rd] <= \n[doc-author-count]) \{\
1219 .    tm doc-author-name\n[doc-reg-Rd] == `\*[doc-author-name\n[doc-reg-Rd]]'
1220 .    nr doc-reg-Rd +1
1221 .  \}
1222 .
1223 .  tm doc-book-count == \n[doc-book-count]
1224 .  tm doc-book-name == `\*[doc-book-name]'
1225 .  tm doc-date-count == \n[doc-date-count]
1226 .  tm doc-date == `\*[doc-date]'
1227 .  tm doc-publisher-count == \n[doc-publisher-count]
1228 .  tm doc-publisher-name == `\*[doc-publisher-name]'
1229 .  tm doc-journal-count == \n[doc-journal-count]
1230 .  tm doc-journal-name == `\*[doc-journal-name]'
1231 .  tm doc-issue-count == \n[doc-issue-count]
1232 .  tm doc-issue-name == `\*[doc-issue-name]'
1233 .  tm doc-optional-count == \n[doc-optional-count]
1234 .  tm doc-optional-string == `\*[doc-optional-string]'
1235 .  tm doc-page-number-count == \n[doc-page-number-count]
1236 .  tm doc-page-number-string == `\*[doc-page-number-string]'
1237 .  tm doc-corporate-count == \n[doc-corporate-count]
1238 .  tm doc-corporate-name == `\*[doc-corporate-name]'
1239 .  tm doc-report-count == \n[doc-report-count]
1240 .  tm doc-report-name == `\*[doc-report-name]'
1241 .  tm doc-reference-title-count == \n[doc-reference-title-count]
1242 .  tm doc-reference-title-name == `\*[doc-reference-title-name]'
1243 .  tm doc-reference-title-name-for-book == `\*[doc-reference-title-name-for-book]'
1244 .  tm doc-url-count == \n[doc-url-count]
1245 .  tm doc-url-name == `\*[doc-url-name]'
1246 .  tm doc-volume-count == \n[doc-volume-count]
1247 .  tm doc-volume-name == `\*[doc-volume-name]'
1248 .  tm doc-have-author == \n[doc-have-author]
1249 .
1250 .  tm doc-document-title == `\*[doc-document-title]'
1251 .  tm doc-volume == `\*[doc-volume]'
1252 .  tm doc-section == `\*[doc-section]'
1253 .  tm doc-operating-system == `\*[doc-operating-system]'
1254 .  tm doc-date-string == `\*[doc-date-string]'
1255 .  tm doc-header-space == \n[doc-header-space]
1256 .  tm doc-footer-space == \n[doc-footer-space]
1257 .  tm doc-display-vertical == \n[doc-display-vertical]
1258 .  tm doc-header-string == `\*[doc-header-string]'
1259 .  tm doc-in-synopsis-section == \n[doc-in-synopsis-section]
1260 .  tm doc-in-library-section == \n[doc-in-library-section]
1261 .  tm doc-in-see-also-section == \n[doc-in-see-also-section]
1262 .  tm doc-in-files-section == \n[doc-in-files-section]
1263 .  tm doc-in-authors-section == \n[doc-in-authors-section]
1264 .
1265 .  tm END OF GLOBAL REGISTER DUMP
1266 ..
1267 .
1268 .
1269 .ec
1270 .
1271 .\" EOF