contrib/groff/tmac/doc-common

   1 .\" Copyright (c) 1991 The Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)doc-common  5.7 (Berkeley) 8/5/91
  33 .\"     $Id$
  34 .\"
  35 .\"     %beginstrip%
  36 .nr %A 1
  37 .nr %J 1
  38 .nr %N 1
  39 .nr %O 1
  40 .nr %R 1
  41 .nr %T 1
  42 .nr %V 1
  43 .nr Ad 12n
  44 .nr Ac 3
  45 .nr Ao 12n
  46 .nr Ap 2
  47 .nr An 12n
  48 .nr Aq 12n
  49 .nr Ar 12n
  50 .nr Bc 3
  51 .nr Bl 1
  52 .nr Bo 12n
  53 .nr Bq 12n
  54 .nr Bx 12n
  55 .nr Cd 12n
  56 .nr Cm 10n
  57 .nr Co 15n
  58 .nr Cx 20n
  59 .nr Dc 3
  60 .nr Do 10n
  61 .nr Dq 12n
  62 .nr Ds 6n
  63 .nr Dq 12n
  64 .nr Dv 12n
  65 .nr tI \n(Dsu
  66 .nr Ec 3
  67 .nr El 1
  68 .nr Eo 12n
  69 .nr Eq 12n
  70 .nr Em 10n
  71 .nr Er 12n
  72 .nr Ev 15n
  73 .nr Ex 10n
  74 .nr Fa 12n
  75 .nr Fl 10n
  76 .nr Fc 3
  77 .nr Fo 16n
  78 .nr Fn 16n
  79 .nr Hl 1
  80 .nr I1 6n
  81 .nr I2 12n
  82 .nr I3 18n
  83 .nr Ic 10n
  84 .nr Li 16n
  85 .nr Ms 6n
  86 .nr Nm 10n
  87 .nr No 12n
  88 .nr Ns 2
  89 .nr Oo 10n
  90 .nr Oc 3
  91 .nr Op 14n
  92 .nr Pa 32n
  93 .nr Pf 12n
  94 .nr Pc 3
  95 .nr Po 12n
  96 .nr Pq 12n
  97 .nr Ql 16n
  98 .nr Qc 3
  99 .nr Qo 12n
 100 .nr Qq 12n
 101 .nr Sc 3
 102 .nr So 12n
 103 .nr Sq 12n
 104 .nr Sy 6n
 105 .nr Sx 16n
 106 .nr Ra 1
 107 .nr Rj 1
 108 .nr Rn 1
 109 .nr Ro 1
 110 .nr Rr 1
 111 .nr Rt 1
 112 .nr Rv 1
 113 .nr Tn 10n
 114 .nr Ta 1
 115 .nr Tv 1
 116 .nr Tx 22n
 117 .nr Ux 10n
 118 .nr Va 12n
 119 .nr Xc 3
 120 .nr Xo 1
 121 .nr Xr 10n
 122 .ds sV \& \&
 123 .ds hV \&\ \&
 124 .ds iV \& \&
 125 .ds tV \&\\t\&
 126 .\" Punctuation values (3 = closing punctuation, 4 = opening)
 127 .nr z. 3
 128 .nr z, 3
 129 .nr z: 3
 130 .nr z; 3
 131 .nr z( 4
 132 .nr z) 3
 133 .nr z[ 4
 134 .nr z] 3
 135 .\" Matching pairs
 136 .ds z( z)
 137 .ds z[ z]
 138 .ds z< z>
 139 .\" This is disgusting, troff not parse ``if'' stmt properly
 140 .nr z0 0
 141 .nr z1 0
 142 .nr z2 0
 143 .nr z3 0
 144 .nr z4 0
 145 .nr z5 0
 146 .nr z6 0
 147 .nr z7 0
 148 .nr z8 0
 149 .nr z9 0
 150 .nr z# 0
 151 .\" Header assembly macros
 152 .de Dt
 153 .ds dT UNTITLED
 154 .ds vT LOCAL
 155 .ds cH Null
 156 .if !"\\$1"" .ds dT \\$1
 157 .if !"\\$2"" \{\
 158 .       ds cH \\$2
 159 .\" .   if "\\$3"" \{\
 160 .               if \\$2>=1 .if \\$2<=9 \{\
 161 .                       ds vT FreeBSD Reference Manual
 162 .                       if "\\$2"1" .ds vT FreeBSD General Commands Manual
 163 .                       if "\\$2"2" .ds vT FreeBSD System Calls Manual
 164 .                       if "\\$2"3" .ds vT FreeBSD Library Functions Manual
 165 .                       if "\\$2"4" .ds vT FreeBSD Kernel Interfaces Manual
 166 .                       if "\\$2"5" .ds vT FreeBSD File Formats Manual
 167 .                       if "\\$2"6" .ds vT FreeBSD Games Manual
 168 .                       if "\\$2"7" .ds vT FreeBSD Miscellaneous Information Manual
 169 .                       if "\\$2"8" .ds vT FreeBSD System Manager's Manual
 170 .                       if "\\$2"9" .ds vT FreeBSD Kernel Developer's Manual
 171 .                       nr sN \\$2
 172 .               \}
 173 .               if "\\$2"unass"  .ds vT DRAFT
 174 .               if "\\$2"draft"  .ds vT DRAFT
 175 .               if "\\$2"paper"  .ds vT UNTITLED
 176 .\" .   \}
 177 .\}
 178 .if !"\\$3"" \{\
 179 .       if "\\$3"USD"   .ds vT FreeBSD User's Supplementary Documents
 180 .       if "\\$3"PS1"   .ds vT FreeBSD Programmers's Supplementary Documents
 181 .       if "\\$3"AMD"   .ds vT FreeBSD Ancestral Manual Documents
 182 .       if "\\$3"SMM"   .ds vT FreeBSD System Manager's Manual
 183 .       if "\\$3"URM"   .ds vT FreeBSD Reference Manual
 184 .       if "\\$3"PRM"   .ds vT FreeBSD Programmers's Manual
 185 .       if "\\$3"IND"   .ds vT FreeBSD Manual Master Index
 186 .\" .   if "\\$3"CON"   .ds vT FreeBSD Contributed Software Manual
 187 .\" .   if "\\$3"IMP"   .ds vT FreeBSD Implementation Notes
 188 .\" .   if "\\$3"HOW"   .ds vT FreeBSD How Pocket Manual
 189 .       if "\\$3"LOCAL" .ds vT FreeBSD Local Manual
 190 .       if "\\$3"tahoe" .as vT \ (Tahoe Architecture)
 191 .       if "\\$3"vax" .as vT \ (VAX Architecture)
 192 .       if "\\$3"hp300" .as vT \ (HP300 Architecture)
 193 .       if "\\$3"i386" .as vT \ (i386 Architecture)
 194 .       if "\\*(vT"LOCAL" .ds vT \\$3
 195 .\}
 196 ..
 197 .\" NS Os macro - Operating System (behaviour changes after first call)
 198 .\" .   ds vT \f(CODRAFT\fP\ \ \-\-\ \ \\*(vT\ \ \-\-\ \ \f(CODRAFT
 199 .\" .   ds dD \f(CODRAFT\fP\ \ \-\-\ \ \\*(dD\ \ \-\-\ \ \f(CODRAFT
 200 .\" .ds vT \s+4\f(CODRAFT\fP\s-4\ \ \-\-\ \ \\*(vT\ \ \-\-\ \ \s+4\f(CODRAFT\s-4
 201 .\" .ds dD \s+4\f(CODRAFT\fP\s-4\ \ \-\-\ \ \\*(dD\ \ \-\-\ \ \s+4\f(CODRAFT\s-4
 202 .de Os
 203 .ds oS Null
 204 .if "\\$1"" .ds oS BSD
 205 .if "\\$1"ATT"   \{\
 206 .       ds oS AT&T
 207 .       if "\\$2""    .as oS \0UNIX
 208 .       if "\\$2"7th" .as oS \07th Edition
 209 .       if "\\$2"7"   .as oS \07th Edition
 210 .       if "\\$2"III" .as oS \0System III
 211 .       if "\\$2"3"   .as oS \0System III
 212 .       if "\\$2"V"   .as oS \0System V
 213 .       if "\\$2"V.2" .as oS \0System V Release 2
 214 .       if "\\$2"V.3" .as oS \0System V Release 3
 215 .       if "\\$2"V.4" .as oS \0System V Release 4
 216 .\}
 217 .if "\\$1"BSD" \{\
 218 .       if "\\$2"3"    .ds oS 3rd Berkeley Distribution
 219 .       if "\\$2"4"    .ds oS 4th Berkeley Distribution
 220 .       if "\\$2"4.1"  .ds oS 4.1 Berkeley Distribution
 221 .       if "\\$2"4.2"  .ds oS 4.2 Berkeley Distribution
 222 .       if "\\$2"4.3"  .ds oS 4.3 Berkeley Distribution
 223 .       if "\\$2"4.3T" .ds oS 4.3-Tahoe Berkeley Distribution
 224 .       if "\\$2"4.3R" .ds oS 4.3-Reno Berkeley Distribution
 225 .       if "\\$2"4.3t" .ds oS 4.3-Tahoe Berkeley Distribution
 226 .       if "\\$2"4.3r" .ds oS 4.3-Reno Berkeley Distribution
 227 .       if "\\$2"4.4"  .ds oS 4.4BSD
 228 .       if "\\*(oS"Null" .tm Unknown BSD version ``\\$2'' at line \\n(c.
 229 .\}
 230 .if "\\$1"FreeBSD" \{\
 231 .       if "\\$2"2"      .ds oS FreeBSD 2.0
 232 .           ie \\n(.$==1        \c
 233 .       el .ie "\\$2"1.0"       \c
 234 .       el .ie "\\$2"1.1"       \c
 235 .       el .ie "\\$2"1.1.5"     \c
 236 .       el .ie "\\$2"1.1.5.1"   \c
 237 .       el .ie "\\$2"2"         \c
 238 .       el .ie "\\$2"2.0"       \c
 239 .       el .ie "\\$2"2.0.5"     \c
 240 .       el .ie "\\$2"2.1"       \c
 241 .       el .ie "\\$2"2.1.5"     \c
 242 .       el .ie "\\$2"2.1.6"     \c
 243 .       el .ie "\\$2"2.1.7"     \c
 244 .       el .ie "\\$2"2.2"       \c
 245 .       el .ie "\\$2"2.2.1"     \c
 246 .       el .ie "\\$2"2.2.2"     \c
 247 .       el .ie "\\$2"2.2.5"     \c
 248 .       el .ie "\\$2"2.2.6"     \c
 249 .       el .ie "\\$2"2.2.7"     \c
 250 .       el .ie "\\$2"2.2.8"     \c
 251 .       el .ie "\\$2"3.0"       \c
 252 .       el .ie "\\$2"3.1"       \c
 253 .       el .ie "\\$2"3.2"       \c
 254 .       el .ie "\\$2"4.0"       \c
 255 .       el .tm Unknown FreeBSD version ``\\$2'' at line \\n(c.
 256 .\}
 257 .if "\\*(oS"Null" \{\
 258 .       ds oS \&\\$1
 259 .       if !"\\$2"" .as oS \& \\$2
 260 .\}
 261 ..
 262 .de Dd
 263 .if !"\\*(dD"" .nr gX 1
 264 .ie \\n(.$>0 \{\
 265 .       ie \\n(.$==3 \{\
 266 .               ds dD \\$1 \\$2 \\$3
 267 .       \}
 268 .       el \{\
 269 .               if "\\n(mo"1"  .ds dD January
 270 .               if "\\n(mo"2"  .ds dD February
 271 .               if "\\n(mo"3"  .ds dD March
 272 .               if "\\n(mo"4"  .ds dD April
 273 .               if "\\n(mo"5"  .ds dD May
 274 .               if "\\n(mo"6"  .ds dD June
 275 .               if "\\n(mo"7"  .ds dD July
 276 .               if "\\n(mo"8"  .ds dD August
 277 .               if "\\n(mo"9"  .ds dD September
 278 .               if "\\n(mo"10" .ds dD October
 279 .               if "\\n(mo"11" .ds dD November
 280 .               if "\\n(mo"12" .ds dD December
 281 .               nr _y \\n(yr+1900
 282 .               as dD \&\ \\n(dy, \\n(_y
 283 .       \}
 284 .\}
 285 .el \{\
 286 .       ds dD Epoch
 287 .\}
 288 ..
 289 .de hM
 290 .ev 1
 291 .pL
 292 .if !\\n(cR 'sp \\n(Hmu
 293 .tl @\\*(Hs\\*(hT\fP@\\*(Vs\\*(vT\fP@\\*(Hs\\*(hT\fP@
 294 'sp \\n(Hmu
 295 .ev
 296 ..
 297 .de fM
 298 .ie \\n(cR 'br
 299 .el \{\
 300 .       ev 1
 301 .       pL
 302 .       if !\\n(cR \{\
 303 '               sp \\n(Fmu
 304 .               tl @\\*(Hs\\*(oS\fP@\\*(Vs\\*(dD\fP@%@
 305 '               bp
 306 .       \}
 307 .       ev
 308 .\}
 309 .\" .tm IN 444 fM .k == \\n(.k and nl == \\n(nl
 310 ..
 311 .de lM
 312 .fl
 313 .if \\n(cR \{\
 314 '       sp
 315 .       tl @\\*(Hs\\*(oS\fP@\\*(Vs\\*(dD\fP@%@
 316 .       pl \\n(nlu
 317 .\}
 318 ..
 319 .de Pp
 320 .sp \\n(Ppu
 321 .ne 2
 322 .ns
 323 ..
 324 .de Lp
 325 .Pp
 326 ..
 327 .de LP
 328 .tm Not a \-mdoc command: .LP
 329 ..
 330 .de PP
 331 .tm Not a \-mdoc command: .PP
 332 ..
 333 .de pp
 334 .tm Not a \-mdoc command: .pp
 335 ..
 336 .de Nd
 337 \&\-\& \\$1 \\$2 \\$3 \\$4 \\$5 \\$6 \\$7 \\$8 \\$9
 338 ..
 339 .de Ss
 340 .sp
 341 .ne 2
 342 .ti -.25i
 343 \&\\*(sH\\$1 \|\\$2 \|\\$3 \|\\$4 \|\\$5 \|\\$6 \|\\$7 \|\\$8 \|\\$9
 344 \&\fP\s0
 345 .ta .5i 1i 1.5i 2i 2.5i 3i 3.5i 4i 4.5i 5i 5.5i 6i 6.5i
 346 .if !\\n(cR .ne 2
 347 .br
 348 ..
 349 .de Rd
 350 .tm MDOC REGISTER DUMP
 351 .tm Db==\\n(Db register DEBUG MODE
 352 .tm L[0-9] registers - stack of list types
 353 .tm L0==\\n(L0
 354 .tm L1==\\n(L1
 355 .tm L2==\\n(L2
 356 .tm L3==\\n(L3
 357 .tm L4==\\n(L4
 358 .tm L5==\\n(L5
 359 .tm L6==\\n(L6
 360 .tm L7==\\n(L7
 361 .tm L8==\\n(L8
 362 .tm L9==\\n(L9
 363 .tm O[0-9] registers - stack of indent
 364 .tm O0==\\n(O0
 365 .tm O1==\\n(O1
 366 .tm O2==\\n(O2
 367 .tm O3==\\n(O3
 368 .tm O4==\\n(O4
 369 .tm O5==\\n(O5
 370 .tm O6==\\n(O6
 371 .tm O7==\\n(O7
 372 .tm O8==\\n(O8
 373 .tm O9==\\n(O9
 374 .tm aC==\\n(aC register argument counter (aV/fV)
 375 .tm aJ==\\n(aJ register (for vR)
 376 .tm aN==\\n(aN register
 377 .tm aP==\\n(aP register argument pointer (aV)
 378 .tm aT==\\n(aT register argument type
 379 .tm aa==\\n(aa local register
 380 .tm bK==\\n(bK register - Book Name flag
 381 .tm cF==\\n(cF register save current font
 382 .tm cI==\\n(cI register - column indent width
 383 .tm cZ==\\n(cZ register save current font size
 384 .tm dK==\\n(dK register - Date flag
 385 .tm d[0-9] registers - display-type stack
 386 .tm d0==\\n(d0
 387 .tm d1==\\n(d1
 388 .tm d2==\\n(d2
 389 .tm d3==\\n(d3
 390 .tm d4==\\n(d4
 391 .tm d5==\\n(d5
 392 .tm d6==\\n(d6
 393 .tm d7==\\n(d7
 394 .tm d8==\\n(d8
 395 .tm d9==\\n(d9
 396 .tm dZ==\\n(dZ register diversion count
 397 .tm fD==\\n(fD register subroutine test (in synopsis only)
 398 .tm fV==\\n(fV register argument counter (must set to \\n(.$ prior to
 399 .tm fY==\\n(fY register - dick with old style function declarations (fortran)
 400 .tm fZ==\\n(fZ register also subroutine count (in synopsis only)
 401 .tm h[0-9] register horizontal tag stack (continuous if 1, break if
 402 .tm h0==\\n(h0
 403 .tm h1==\\n(h1
 404 .tm h2==\\n(h2
 405 .tm h3==\\n(h3
 406 .tm h4==\\n(h4
 407 .tm h5==\\n(h5
 408 .tm h6==\\n(h6
 409 .tm h7==\\n(h7
 410 .tm h8==\\n(h8
 411 .tm h9==\\n(h9
 412 .tm iD==\\n(iD local register
 413 .tm iI==\\n(iI local register (indent for inline debug mode)
 414 .tm iN==\\n(iN register DEBUG MODE (inline if 1, to stderr if
 415 .tm iS==\\n(iS register - indent second command line in a synopsis
 416 .tm jK==\\n(jK register - [reference] Journal Name flag
 417 .tm jM==\\n(jM local register
 418 .tm jN==\\n(jN local register
 419 .tm lC==\\n(lC register - list type stack counter
 420 .tm lK==\\n(lK register count of lines read from input file
 421 .tm nK==\\n(nK register - [reference] issue number flag
 422 .tm nU==\\n(nU register count
 423 .tm oK==\\n(oK register - [reference] optional information flag
 424 .tm oM==\\n(oM register (extension possible)
 425 .tm o[0-9] register offset stack (nested tags)
 426 .tm o0==\\n(o0
 427 .tm o1==\\n(o1
 428 .tm o2==\\n(o2
 429 .tm o3==\\n(o3
 430 .tm o4==\\n(o4
 431 .tm o5==\\n(o5
 432 .tm o6==\\n(o6
 433 .tm o7==\\n(o7
 434 .tm o8==\\n(o8
 435 .tm o9==\\n(o9
 436 .tm oM==\\n(oM register open ended line flag
 437 .tm pK==\\n(pK register - [reference] page number flag
 438 .tm qK==\\n(qK register - Corporate or Foreign Author flag
 439 .tm rK==\\n(rK register - [reference] report flag
 440 .tm rS==\\n(rS register - Reference Start flag
 441 .tm sM==\\n(sM register - default is one (space mode on)
 442 .tm tK==\\n(tK register - reference title flag
 443 .tm tP==\\n(tP register tag flag (for diversions)
 444 .tm tX==\\n(tX register (initial class)
 445 .tm tY==\\n(tY register (next possible lC value)
 446 .tm t[0-9] register tag string stack (nested tags)
 447 .tm t0==\\n(t0
 448 .tm t1==\\n(t1
 449 .tm t2==\\n(t2
 450 .tm t3==\\n(t3
 451 .tm t4==\\n(t4
 452 .tm t5==\\n(t5
 453 .tm t6==\\n(t6
 454 .tm t7==\\n(t7
 455 .tm t8==\\n(t8
 456 .tm t9==\\n(t9
 457 .tm uK==\\n(uK register - reference author(s) counter
 458 .tm vK==\\n(vK register - reference volume flag
 459 .tm v[0-9] register vertical tag break stack
 460 .tm v0==\\n(v0
 461 .tm v1==\\n(v1
 462 .tm v2==\\n(v2
 463 .tm v3==\\n(v3
 464 .tm v4==\\n(v4
 465 .tm v5==\\n(v5
 466 .tm v6==\\n(v6
 467 .tm v7==\\n(v7
 468 .tm v8==\\n(v8
 469 .tm v9==\\n(v9
 470 .tm w[0-9] register tag stack (nested tags)
 471 .tm w0==\\n(w0
 472 .tm w1==\\n(w1
 473 .tm w2==\\n(w2
 474 .tm w3==\\n(w3
 475 .tm w4==\\n(w4
 476 .tm w5==\\n(w5
 477 .tm w6==\\n(w6
 478 .tm w7==\\n(w7
 479 .tm w8==\\n(w8
 480 .tm w9==\\n(w9
 481 .tm xX==\\n(xX local register
 482 .tm END OF REGISTER DUMP
 483 ..