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