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 .\"     $FreeBSD$
  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 .nr Yr \n(yr+1900
 123 .ds sV \& \&
 124 .ds hV \&\ \&
 125 .ds iV \& \&
 126 .ds tV \&\\t\&
 127 .\" Punctuation values (3 = closing punctuation, 4 = opening)
 128 .nr z. 3
 129 .nr z, 3
 130 .nr z: 3
 131 .nr z; 3
 132 .nr z( 4
 133 .nr z) 3
 134 .nr z[ 4
 135 .nr z] 3
 136 .\" Matching pairs
 137 .ds z( z)
 138 .ds z[ z]
 139 .ds z< z>
 140 .\" This is disgusting, troff not parse ``if'' stmt properly
 141 .nr z0 0
 142 .nr z1 0
 143 .nr z2 0
 144 .nr z3 0
 145 .nr z4 0
 146 .nr z5 0
 147 .nr z6 0
 148 .nr z7 0
 149 .nr z8 0
 150 .nr z9 0
 151 .nr z# 0
 152 .\" Header assembly macros
 153 .de Dt
 154 .ds dT UNTITLED
 155 .ds vT LOCAL
 156 .ds cH Null
 157 .if !"\\$1"" .ds dT \\$1
 158 .if !"\\$2"" \{\
 159 .       ds cH \\$2
 160 .\" .   if "\\$3"" \{\
 161 .               if \\$2>=1 .if \\$2<=9 \{\
 162 .                       ds vT FreeBSD Reference Manual
 163 .                       if "\\$2"1" .ds vT FreeBSD General Commands Manual
 164 .                       if "\\$2"2" .ds vT FreeBSD System Calls Manual
 165 .                       if "\\$2"3" .ds vT FreeBSD Library Functions Manual
 166 .                       if "\\$2"4" .ds vT FreeBSD Kernel Interfaces Manual
 167 .                       if "\\$2"5" .ds vT FreeBSD File Formats Manual
 168 .                       if "\\$2"6" .ds vT FreeBSD Games Manual
 169 .                       if "\\$2"7" .ds vT FreeBSD Miscellaneous Information Manual
 170 .                       if "\\$2"8" .ds vT FreeBSD System Manager's Manual
 171 .                       if "\\$2"9" .ds vT FreeBSD Kernel Developer's Manual
 172 .                       nr sN \\$2
 173 .               \}
 174 .               if "\\$2"unass"  .ds vT DRAFT
 175 .               if "\\$2"draft"  .ds vT DRAFT
 176 .               if "\\$2"paper"  .ds vT UNTITLED
 177 .\" .   \}
 178 .\}
 179 .if !"\\$3"" \{\
 180 .       if "\\$3"USD"   .ds vT FreeBSD User's Supplementary Documents
 181 .       if "\\$3"PS1"   .ds vT FreeBSD Programmers's Supplementary Documents
 182 .       if "\\$3"AMD"   .ds vT FreeBSD Ancestral Manual Documents
 183 .       if "\\$3"SMM"   .ds vT FreeBSD System Manager's Manual
 184 .       if "\\$3"URM"   .ds vT FreeBSD Reference Manual
 185 .       if "\\$3"PRM"   .ds vT FreeBSD Programmers's Manual
 186 .       if "\\$3"IND"   .ds vT FreeBSD Manual Master Index
 187 .\" .   if "\\$3"CON"   .ds vT FreeBSD Contributed Software Manual
 188 .\" .   if "\\$3"IMP"   .ds vT FreeBSD Implementation Notes
 189 .\" .   if "\\$3"HOW"   .ds vT FreeBSD How Pocket Manual
 190 .       if "\\$3"LOCAL" .ds vT FreeBSD Local Manual
 191 .       if "\\$3"tahoe" .as vT \ (Tahoe Architecture)
 192 .       if "\\$3"vax" .as vT \ (VAX Architecture)
 193 .       if "\\$3"hp300" .as vT \ (HP300 Architecture)
 194 .       if "\\$3"i386" .as vT \ (i386 Architecture)
 195 .       if "\\$3"Alpha" .as vT \ (Alpha Architecture)
 196 .       if "\\*(vT"LOCAL" .ds vT \\$3
 197 .\}
 198 ..
 199 .\" NS Os macro - Operating System (behaviour changes after first call)
 200 .\" .   ds vT \f(CODRAFT\fP\ \ \-\-\ \ \\*(vT\ \ \-\-\ \ \f(CODRAFT
 201 .\" .   ds dD \f(CODRAFT\fP\ \ \-\-\ \ \\*(dD\ \ \-\-\ \ \f(CODRAFT
 202 .\" .ds vT \s+4\f(CODRAFT\fP\s-4\ \ \-\-\ \ \\*(vT\ \ \-\-\ \ \s+4\f(CODRAFT\s-4
 203 .\" .ds dD \s+4\f(CODRAFT\fP\s-4\ \ \-\-\ \ \\*(dD\ \ \-\-\ \ \s+4\f(CODRAFT\s-4
 204 .de Os
 205 .ds oS Null
 206 .if "\\$1"" .ds oS BSD
 207 .if "\\$1"ATT"   \{\
 208 .       ds oS AT&T
 209 .       if "\\$2""    .as oS \0UNIX
 210 .       if "\\$2"7th" .as oS \07th Edition
 211 .       if "\\$2"7"   .as oS \07th Edition
 212 .       if "\\$2"III" .as oS \0System III
 213 .       if "\\$2"3"   .as oS \0System III
 214 .       if "\\$2"V"   .as oS \0System V
 215 .       if "\\$2"V.2" .as oS \0System V Release 2
 216 .       if "\\$2"V.3" .as oS \0System V Release 3
 217 .       if "\\$2"V.4" .as oS \0System V Release 4
 218 .\}
 219 .if "\\$1"BSD" \{\
 220 .       if "\\$2"3"    .ds oS 3rd Berkeley Distribution
 221 .       if "\\$2"4"    .ds oS 4th Berkeley Distribution
 222 .       if "\\$2"4.1"  .ds oS 4.1 Berkeley Distribution
 223 .       if "\\$2"4.2"  .ds oS 4.2 Berkeley Distribution
 224 .       if "\\$2"4.3"  .ds oS 4.3 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.3t" .ds oS 4.3-Tahoe Berkeley Distribution
 228 .       if "\\$2"4.3r" .ds oS 4.3-Reno Berkeley Distribution
 229 .       if "\\$2"4.4"  .ds oS 4.4BSD
 230 .       if "\\*(oS"Null" .tm Unknown BSD version ``\\$2'' at line \\n(c.
 231 .\}
 232 .if "\\$1"FreeBSD" \{\
 233 .       if "\\$2"2"      .ds oS FreeBSD 2.0
 234 .           ie \\n(.$==1        %comment%
 235 .       el .ie "\\$2"1.0"       %comment%
 236 .       el .ie "\\$2"1.1"       %comment%
 237 .       el .ie "\\$2"1.1.5"     %comment%
 238 .       el .ie "\\$2"1.1.5.1"   %comment%
 239 .       el .ie "\\$2"2"         %comment%
 240 .       el .ie "\\$2"2.0"       %comment%
 241 .       el .ie "\\$2"2.0.5"     %comment%
 242 .       el .ie "\\$2"2.1"       %comment%
 243 .       el .ie "\\$2"2.1.5"     %comment%
 244 .       el .ie "\\$2"2.1.6"     %comment%
 245 .       el .ie "\\$2"2.1.7"     %comment%
 246 .       el .ie "\\$2"2.2"       %comment%
 247 .       el .ie "\\$2"2.2.1"     %comment%
 248 .       el .ie "\\$2"2.2.2"     %comment%
 249 .       el .ie "\\$2"2.2.5"     %comment%
 250 .       el .ie "\\$2"2.2.6"     %comment%
 251 .       el .ie "\\$2"2.2.7"     %comment%
 252 .       el .ie "\\$2"2.2.8"     %comment%
 253 .       el .ie "\\$2"3"         %comment%
 254 .       el .ie "\\$2"3.0"       %comment%
 255 .       el .ie "\\$2"3.1"       %comment%
 256 .       el .ie "\\$2"3.2"       %comment%
 257 .       el .ie "\\$2"3.3"       %comment%
 258 .       el .ie "\\$2"3.4"       %comment%
 259 .       el .ie "\\$2"3.5"       %comment%
 260 .       el .ie "\\$2"4"         %comment%
 261 .       el .ie "\\$2"4.0"       %comment%
 262 .       el .tm Unknown FreeBSD version ``\\$2'' at line \\n(c.
 263 .\}
 264 .if "\\*(oS"Null" \{\
 265 .       ds oS \&\\$1
 266 .       if !"\\$2"" .as oS \& \\$2
 267 .\}
 268 ..
 269 .de Dd
 270 .if !"\\*(dD"" .nr gX 1
 271 .ie \\n(.$>0 \{\
 272 .       ie \\n(.$==3 \{\
 273 .               ds dD \\$1 \\$2 \\$3
 274 .       \}
 275 .       el \{\
 276 .               if "\\n(mo"1"  .ds dD January
 277 .               if "\\n(mo"2"  .ds dD February
 278 .               if "\\n(mo"3"  .ds dD March
 279 .               if "\\n(mo"4"  .ds dD April
 280 .               if "\\n(mo"5"  .ds dD May
 281 .               if "\\n(mo"6"  .ds dD June
 282 .               if "\\n(mo"7"  .ds dD July
 283 .               if "\\n(mo"8"  .ds dD August
 284 .               if "\\n(mo"9"  .ds dD September
 285 .               if "\\n(mo"10" .ds dD October
 286 .               if "\\n(mo"11" .ds dD November
 287 .               if "\\n(mo"12" .ds dD December
 288 .               as dD \&\ \\n(dy, \\n(Yr
 289 .       \}
 290 .\}
 291 .el \{\
 292 .       ds dD Epoch
 293 .\}
 294 ..
 295 .de hM
 296 .ev 1
 297 .pL
 298 .if !\\n(cR 'sp \\n(Hmu
 299 .tl @\\*(Hs\\*(hT\fP@\\*(Vs\\*(vT\fP@\\*(Hs\\*(hT\fP@
 300 'sp \\n(Hmu
 301 .ev
 302 ..
 303 .de fM
 304 .ie \\n(cR 'br
 305 .el \{\
 306 .       ev 1
 307 .       pL
 308 .       if !\\n(cR \{\
 309 '               sp \\n(Fmu
 310 .               tl @\\*(Hs\\*(oS\fP@\\*(Vs\\*(dD\fP@%@
 311 '               bp
 312 .       \}
 313 .       ev
 314 .\}
 315 .\" .tm IN 444 fM .k == \\n(.k and nl == \\n(nl
 316 ..
 317 .de lM
 318 .fl
 319 .if \\n(cR \{\
 320 '       sp
 321 .       tl @\\*(Hs\\*(oS\fP@\\*(Vs\\*(dD\fP@%@
 322 .       pl \\n(nlu
 323 .\}
 324 ..
 325 .de Pp
 326 .sp \\n(Ppu
 327 .ne 2
 328 .ns
 329 ..
 330 .de Lp
 331 .Pp
 332 ..
 333 .de LP
 334 .tm Not a \-mdoc command: .LP
 335 ..
 336 .de PP
 337 .tm Not a \-mdoc command: .PP
 338 ..
 339 .de pp
 340 .tm Not a \-mdoc command: .pp
 341 ..
 342 .de Nd
 343 \&\-\& \\$1 \\$2 \\$3 \\$4 \\$5 \\$6 \\$7 \\$8 \\$9
 344 ..
 345 .de Ss
 346 .sp
 347 .ne 2
 348 .ti -.25i
 349 \&\\*(sH\\$1 \|\\$2 \|\\$3 \|\\$4 \|\\$5 \|\\$6 \|\\$7 \|\\$8 \|\\$9
 350 \&\fP\s0
 351 .ta .5i 1i 1.5i 2i 2.5i 3i 3.5i 4i 4.5i 5i 5.5i 6i 6.5i
 352 .if !\\n(cR .ne 2
 353 .br
 354 ..
 355 .de Rd
 356 .tm MDOC REGISTER DUMP
 357 .tm Db==\\n(Db register DEBUG MODE
 358 .tm L[0-9] registers - stack of list types
 359 .tm L0==\\n(L0
 360 .tm L1==\\n(L1
 361 .tm L2==\\n(L2
 362 .tm L3==\\n(L3
 363 .tm L4==\\n(L4
 364 .tm L5==\\n(L5
 365 .tm L6==\\n(L6
 366 .tm L7==\\n(L7
 367 .tm L8==\\n(L8
 368 .tm L9==\\n(L9
 369 .tm O[0-9] registers - stack of indent
 370 .tm O0==\\n(O0
 371 .tm O1==\\n(O1
 372 .tm O2==\\n(O2
 373 .tm O3==\\n(O3
 374 .tm O4==\\n(O4
 375 .tm O5==\\n(O5
 376 .tm O6==\\n(O6
 377 .tm O7==\\n(O7
 378 .tm O8==\\n(O8
 379 .tm O9==\\n(O9
 380 .tm aC==\\n(aC register argument counter (aV/fV)
 381 .tm aJ==\\n(aJ register (for vR)
 382 .tm aN==\\n(aN register
 383 .tm aP==\\n(aP register argument pointer (aV)
 384 .tm aT==\\n(aT register argument type
 385 .tm aa==\\n(aa local register
 386 .tm bK==\\n(bK register - Book Name flag
 387 .tm cF==\\n(cF register save current font
 388 .tm cI==\\n(cI register - column indent width
 389 .tm cZ==\\n(cZ register save current font size
 390 .tm dK==\\n(dK register - Date flag
 391 .tm d[0-9] registers - display-type stack
 392 .tm d0==\\n(d0
 393 .tm d1==\\n(d1
 394 .tm d2==\\n(d2
 395 .tm d3==\\n(d3
 396 .tm d4==\\n(d4
 397 .tm d5==\\n(d5
 398 .tm d6==\\n(d6
 399 .tm d7==\\n(d7
 400 .tm d8==\\n(d8
 401 .tm d9==\\n(d9
 402 .tm dZ==\\n(dZ register diversion count
 403 .tm fD==\\n(fD register subroutine test (in synopsis only)
 404 .tm fV==\\n(fV register argument counter (must set to \\n(.$ prior to
 405 .tm fY==\\n(fY register - dick with old style function declarations (fortran)
 406 .tm fZ==\\n(fZ register also subroutine count (in synopsis only)
 407 .tm h[0-9] register horizontal tag stack (continuous if 1, break if
 408 .tm h0==\\n(h0
 409 .tm h1==\\n(h1
 410 .tm h2==\\n(h2
 411 .tm h3==\\n(h3
 412 .tm h4==\\n(h4
 413 .tm h5==\\n(h5
 414 .tm h6==\\n(h6
 415 .tm h7==\\n(h7
 416 .tm h8==\\n(h8
 417 .tm h9==\\n(h9
 418 .tm iD==\\n(iD local register
 419 .tm iI==\\n(iI local register (indent for inline debug mode)
 420 .tm iN==\\n(iN register DEBUG MODE (inline if 1, to stderr if
 421 .tm iS==\\n(iS register - indent second command line in a synopsis
 422 .tm jK==\\n(jK register - [reference] Journal Name flag
 423 .tm jM==\\n(jM local register
 424 .tm jN==\\n(jN local register
 425 .tm lC==\\n(lC register - list type stack counter
 426 .tm lK==\\n(lK register count of lines read from input file
 427 .tm nK==\\n(nK register - [reference] issue number flag
 428 .tm nU==\\n(nU register count
 429 .tm oK==\\n(oK register - [reference] optional information flag
 430 .tm oM==\\n(oM register (extension possible)
 431 .tm o[0-9] register offset stack (nested tags)
 432 .tm o0==\\n(o0
 433 .tm o1==\\n(o1
 434 .tm o2==\\n(o2
 435 .tm o3==\\n(o3
 436 .tm o4==\\n(o4
 437 .tm o5==\\n(o5
 438 .tm o6==\\n(o6
 439 .tm o7==\\n(o7
 440 .tm o8==\\n(o8
 441 .tm o9==\\n(o9
 442 .tm oM==\\n(oM register open ended line flag
 443 .tm pK==\\n(pK register - [reference] page number flag
 444 .tm qK==\\n(qK register - Corporate or Foreign Author flag
 445 .tm rK==\\n(rK register - [reference] report flag
 446 .tm rS==\\n(rS register - Reference Start flag
 447 .tm sM==\\n(sM register - default is one (space mode on)
 448 .tm tK==\\n(tK register - reference title flag
 449 .tm tP==\\n(tP register tag flag (for diversions)
 450 .tm tX==\\n(tX register (initial class)
 451 .tm tY==\\n(tY register (next possible lC value)
 452 .tm t[0-9] register tag string stack (nested tags)
 453 .tm t0==\\n(t0
 454 .tm t1==\\n(t1
 455 .tm t2==\\n(t2
 456 .tm t3==\\n(t3
 457 .tm t4==\\n(t4
 458 .tm t5==\\n(t5
 459 .tm t6==\\n(t6
 460 .tm t7==\\n(t7
 461 .tm t8==\\n(t8
 462 .tm t9==\\n(t9
 463 .tm uK==\\n(uK register - reference author(s) counter
 464 .tm vK==\\n(vK register - reference volume flag
 465 .tm v[0-9] register vertical tag break stack
 466 .tm v0==\\n(v0
 467 .tm v1==\\n(v1
 468 .tm v2==\\n(v2
 469 .tm v3==\\n(v3
 470 .tm v4==\\n(v4
 471 .tm v5==\\n(v5
 472 .tm v6==\\n(v6
 473 .tm v7==\\n(v7
 474 .tm v8==\\n(v8
 475 .tm v9==\\n(v9
 476 .tm w[0-9] register tag stack (nested tags)
 477 .tm w0==\\n(w0
 478 .tm w1==\\n(w1
 479 .tm w2==\\n(w2
 480 .tm w3==\\n(w3
 481 .tm w4==\\n(w4
 482 .tm w5==\\n(w5
 483 .tm w6==\\n(w6
 484 .tm w7==\\n(w7
 485 .tm w8==\\n(w8
 486 .tm w9==\\n(w9
 487 .tm xX==\\n(xX local register
 488 .tm END OF REGISTER DUMP
 489 ..