share/tmac/doc-common

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