tmac/mdoc-common

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