Add DragonFly release numbers.
[dragonfly.git] / gnu / usr.bin / groff / 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) 06/08/93
33 .\"     $DragonFly: src/gnu/usr.bin/groff/tmac/Attic/doc-common,v 1.9 2005/08/28 05:34:49 asmodai Exp $ 
34 .\"
35 .\"     %beginstrip%
36 .
37 .
38 .\" Macro Identifiers.  For each user macro a corresponding register with
39 .\" the same name must exist.  Its value must not be zero.
40 .
41 .nr %A 1
42 .nr %B 1
43 .nr %D 1
44 .nr %I 1
45 .nr %J 1
46 .nr %N 1
47 .nr %O 1
48 .nr %P 1
49 .nr %Q 1
50 .nr %R 1
51 .nr %T 1
52 .nr %V 1
53 .nr Ac 3
54 .nr Ad 12n
55 .nr An 12n
56 .nr Ao 12n
57 .nr Ap 2
58 .nr Aq 12n
59 .nr Ar 12n
60 .nr At 1
61 .nr Bc 3
62 .nr Bf 8n\" ?
63 .nr Bk 8n\" ?
64 .nr Bl 1
65 .nr Bo 12n
66 .nr Bq 12n
67 .nr Brc 3
68 .nr Bro 12n
69 .nr Brq 12n
70 .nr Bsx 1
71 .nr Bt 8n\" ?
72 .nr Bx 1
73 .nr Cd 12n
74 .nr Cm 10n
75 .nr D1 8n\" ?
76 .nr Dc 3
77 .nr Dl 8n\" ?
78 .nr Dt 8n\" ?
79 .nr Do 12n
80 .nr Dq 12n
81 .nr Ds 6n\" many manpages still use this as a -width value
82 .nr Dv 12n
83 .nr Dx 1
84 .nr Ec 3
85 .nr Ef 8n\" ?
86 .nr Ek 8n\" ?
87 .nr El 1
88 .nr Em 10n
89 .nr En 12n
90 .nr Eo 12n
91 .nr Eq 12n
92 .nr Er 17n
93 .nr Es 12n
94 .nr Ev 15n
95 .nr Ex 1
96 .nr Fa 12n
97 .nr Fc 3
98 .nr Fd 12n\" ?
99 .nr Fl 10n
100 .nr Fn 16n
101 .nr Fo 16n
102 .nr Fr 12n\" ?
103 .nr Ft 8n\" ?
104 .nr Fx 1
105 .nr Ic 10n
106 .nr In 12n\" ?
107 .nr It 8n\" ?
108 .nr Lb 11n
109 .nr Li 16n
110 .nr Lk 6n\" ?
111 .nr Lp 8n\" ?
112 .nr Me 6n
113 .nr Ms 6n
114 .nr Mt 6n\" ?
115 .nr Nd 8n\" ?
116 .nr Nm 10n
117 .nr No 12n
118 .nr Ns 2
119 .nr Nx 1
120 .nr Oc 3
121 .nr Oo 10n
122 .nr Op 14n
123 .nr Os 6n\" ?
124 .nr Ox 1
125 .nr Pa 32n
126 .nr Pc 3
127 .nr Pf 12n
128 .nr Po 12n
129 .nr Pp 8n\" ?
130 .nr Pq 12n
131 .nr Qc 3
132 .nr Ql 16n
133 .nr Qo 12n
134 .nr Qq 12n
135 .nr Rv 1
136 .nr Sc 3
137 .nr Sh 8n
138 .nr Sm 8n\" ?
139 .nr So 12n
140 .nr Sq 12n
141 .nr Ss 8n
142 .nr St 8n\" ?
143 .nr Sx 16n
144 .nr Sy 6n
145 .nr Ta 2
146 .nr Tn 10n
147 .nr Ud 8n\" ?
148 .nr Ux 1
149 .nr Va 12n
150 .nr Vt 8n\" ?
151 .nr Xc 3
152 .nr Xo 1
153 .nr Xr 10n
154 .
155 .
156 .\" macros which must be processed after the closing delimiter of `Op'
157 .\" and friends
158 .ds doc-after-Ao
159 .ds doc-after-Bo
160 .ds doc-after-Bro
161 .ds doc-after-Do
162 .ds doc-after-Eo
163 .ds doc-after-Fo
164 .ds doc-after-Ns
165 .ds doc-after-Oo
166 .ds doc-after-Po
167 .ds doc-after-Qo
168 .ds doc-after-So
169 .ds doc-after-Xo
170 .
171 .
172 .nr doc-display-indent 6n
173 .
174 .
175 .\" space strings
176 .
177 .ds doc-soft-space " \"
178 .ds doc-hard-space \~
179 .ds doc-tab \t
180 .
181 .
182 .eo
183 .
184 .
185 .\" punctuation values (suffix=3, prefix = 4)
186 .
187 .nr doc-punct. 3
188 .nr doc-punct, 3
189 .nr doc-punct: 3
190 .nr doc-punct; 3
191 .nr doc-punct( 4
192 .nr doc-punct) 3
193 .nr doc-punct[ 4
194 .nr doc-punct] 3
195 .nr doc-punct? 3
196 .nr doc-punct! 3
197 .
198 .
199 .\" header assembly macros
200 .
201 .\" NS doc-document-title global string
202 .\" NS   the title of the manual page
203 .
204 .ds doc-document-title UNTITLED
205 .
206 .
207 .\" NS doc-volume global string
208 .\" NS   the volume where the manual page belongs to
209 .
210 .ds doc-volume LOCAL
211 .
212 .
213 .\" NS doc-section global string
214 .\" NS   the manual section
215 .
216 .ds doc-section Null
217 .
218 .
219 .\" NS Dt user macro (not parsed, not callable)
220 .\" NS   document title
221 .\" NS
222 .\" NS modifies:
223 .\" NS   doc-document-title
224 .\" NS   doc-section
225 .\" NS   doc-volume
226 .\" NS
227 .\" NS local variables:
228 .\" NS   doc-volume-as-XXX
229 .\" NS   doc-volume-ds-XXX
230 .\" NS
231 .\" NS width register `Dt' set above
232 .
233 .\" an alternative, more detailed scheme for naming the manual sections
234 .\"
235 .ds doc-volume-operating-system BSD
236 .nr doc-volume-operating-system-ateol 0
237 .ds doc-volume-ds-1 General Commands Manual
238 .ds doc-volume-ds-2 System Calls Manual
239 .ds doc-volume-ds-3 Library Functions Manual
240 .ds doc-volume-ds-4 Kernel Interfaces Manual
241 .ds doc-volume-ds-5 File Formats Manual
242 .ds doc-volume-ds-6 Games Manual
243 .ds doc-volume-ds-7 Miscellaneous Information Manual
244 .ds doc-volume-ds-8 System Manager's Manual
245 .ds doc-volume-ds-9 Kernel Developer's Manual
246 .
247 .ds doc-volume-ds-USD   User's Supplementary Documents
248 .ds doc-volume-ds-PS1   Programmer's Supplementary Documents
249 .ds doc-volume-ds-AMD   Ancestral Manual Documents
250 .ds doc-volume-ds-SMM   System Manager's Manual
251 .ds doc-volume-ds-URM   User's Reference Manual
252 .ds doc-volume-ds-PRM   Programmer's Manual
253 .ds doc-volume-ds-KM    Kernel Manual
254 .ds doc-volume-ds-IND   Manual Master Index
255 .ds doc-volume-ds-LOCAL Local Manual
256 .ds doc-volume-ds-CON   Contributed Software Manual
257 .
258 .als doc-volume-ds-MMI doc-volume-ds-IND
259 .als doc-volume-ds-LOC doc-volume-ds-LOCAL
260 .
261 .ds doc-volume-as-alpha    Alpha
262 .als doc-volume-as-Alpha doc-volume-as-alpha
263 .ds doc-volume-as-amiga    Amiga
264 .ds doc-volume-as-arc      Arc
265 .ds doc-volume-as-arm26    ARM26
266 .ds doc-volume-as-arm32    ARM32
267 .ds doc-volume-as-atari    Atari
268 .ds doc-volume-as-bebox    BEbox
269 .ds doc-volume-as-cobalt   Cobalt
270 .ds doc-volume-as-evbsh3   Evbsh3
271 .ds doc-volume-as-hp300    HP300
272 .ds doc-volume-as-hpcmips  HPcmips
273 .ds doc-volume-as-i386     i386
274 .ds doc-volume-as-luna68k  luna68k
275 .ds doc-volume-as-m68k     m68k
276 .ds doc-volume-as-mac68k   mac68k
277 .ds doc-volume-as-macppc   macppc
278 .ds doc-volume-as-mips     MIPS
279 .ds doc-volume-as-mmeye    mmeye
280 .ds doc-volume-as-mvme68k  mvme68k
281 .ds doc-volume-as-news68k  news68k
282 .ds doc-volume-as-newsmips newsmips
283 .ds doc-volume-as-next68k  next68k
284 .ds doc-volume-as-ofppc    ofppc
285 .ds doc-volume-as-pc532    pc532
286 .ds doc-volume-as-pmax     pmax
287 .ds doc-volume-as-powerpc  powerpc
288 .ds doc-volume-as-prep     prep
289 .ds doc-volume-as-sgimips  sgimips
290 .ds doc-volume-as-sh3      sh3
291 .ds doc-volume-as-sparc    SPARC
292 .ds doc-volume-as-sparc64  sparc64
293 .ds doc-volume-as-sun3     sun3
294 .ds doc-volume-as-tahoe    Tahoe
295 .ds doc-volume-as-vax      VAX
296 .ds doc-volume-as-x68k     x68k
297 .
298 .de Dt
299 .  \" reset default arguments
300 .  ds doc-document-title UNTITLED
301 .  ds doc-volume LOCAL
302 .  ds doc-section Null
303 .
304 .  if !"\$1"" \
305 .    ds doc-document-title "\$1
306 .
307 .  if !"\$2"" \{\
308 .    ds doc-section \$2
309 .    ie \B\a\$2\a \{\
310 .      if ((\$2 >= 1) & (\$2 <= 9)) \{\
311 .        ie \n[doc-volume-operating-system-ateol] \{\
312 .          ds doc-volume "\*[doc-volume-ds-\$2] \*[doc-volume-operating-system]
313 .          if \A\a\$3\a \{\
314 .            if d doc-volume-as-\$3 \
315 .              as doc-volume "/\*[doc-volume-as-\$3]
316 .        \}\}
317 .        el \{\
318 .          ds doc-volume "\*[doc-volume-operating-system]
319 .          if \A\a\$3\a \{\
320 .            if d doc-volume-as-\$3 \
321 .              as doc-volume "/\*[doc-volume-as-\$3]
322 .          \}
323 .          as doc-volume " \*[doc-volume-ds-\$2]
324 .    \}\}\}
325 .    el \{\
326 .      ie "\$2"unass" .ds doc-volume DRAFT
327 .      el \{ .ie "\$2"draft" .ds doc-volume DRAFT
328 .      el \{ .ie "\$2"paper" .ds doc-volume UNTITLED
329 .      el \
330 .        tm mdoc warning: .Dt: unknown section `\$2' (#\n[.c])
331 .      \}\}
332 .      if \A\a\$3\a \{\
333 .        if d doc-volume-ds-\$3 \
334 .          ds doc-volume "\*[doc-volume-ds-\$3]
335 .  \}\}\}
336 .
337 .  if !"\$3"" \
338 .    if "\*[doc-volume]"LOCAL" \
339 .      ds doc-volume \$3
340 ..
341 .
342 .
343 .\" NS doc-operating-system global string
344 .\" NS   the exact version of the operating system
345 .\" NS
346 .\" NS override this in `mdoc.local', if necessary
347 .
348 .ds doc-operating-system BSD
349 .
350 .
351 .\" NS Os user macro (not parsed, not callable)
352 .\" NS   operating system
353 .\" NS
354 .\" NS modifies:
355 .\" NS   doc-operating-system
356 .\" NS
357 .\" NS local variables:
358 .\" NS   doc-operating-system-XXX-XXX
359 .\" NS
360 .\" NS width register `Os' set above
361 .
362 .ds doc-operating-system-ATT-7   7th\~Edition
363 .als doc-operating-system-ATT-7th doc-operating-system-ATT-7
364 .ds doc-operating-system-ATT-3   System\~III
365 .als doc-operating-system-ATT-III doc-operating-system-ATT-3
366 .ds doc-operating-system-ATT-V   System\~V
367 .ds doc-operating-system-ATT-V.2 System\~V Release\~2
368 .ds doc-operating-system-ATT-V.3 System\~V Release\~3
369 .ds doc-operating-system-ATT-V.4 System\~V Release\~4
370 .
371 .ds doc-operating-system-BSD-3    3rd\~Berkeley Distribution
372 .ds doc-operating-system-BSD-4    4th\~Berkeley Distribution
373 .ds doc-operating-system-BSD-4.1  4.1\~Berkeley Distribution
374 .ds doc-operating-system-BSD-4.2  4.2\~Berkeley Distribution
375 .ds doc-operating-system-BSD-4.3  4.3\~Berkeley Distribution
376 .ds doc-operating-system-BSD-4.3T 4.3-Tahoe Berkeley Distribution
377 .ds doc-operating-system-BSD-4.3R 4.3-Reno Berkeley Distribution
378 .als doc-operating-system-BSD-4.3t doc-operating-system-BSD-4.3T
379 .als doc-operating-system-BSD-4.3r doc-operating-system-BSD-4.3R
380 .ds doc-operating-system-BSD-4.4  4.4BSD
381 .
382 .ds doc-operating-system-NetBSD-0.8  0.8
383 .ds doc-operating-system-NetBSD-0.8a 0.8A
384 .ds doc-operating-system-NetBSD-0.9  0.9
385 .ds doc-operating-system-NetBSD-0.9a 0.9A
386 .ds doc-operating-system-NetBSD-1.0  1.0
387 .ds doc-operating-system-NetBSD-1.0a 1.0A
388 .ds doc-operating-system-NetBSD-1.1  1.1
389 .ds doc-operating-system-NetBSD-1.2  1.2
390 .ds doc-operating-system-NetBSD-1.2a 1.2A
391 .ds doc-operating-system-NetBSD-1.2b 1.2B
392 .ds doc-operating-system-NetBSD-1.2c 1.2C
393 .ds doc-operating-system-NetBSD-1.2d 1.2D
394 .ds doc-operating-system-NetBSD-1.2e 1.2E
395 .ds doc-operating-system-NetBSD-1.3  1.3
396 .ds doc-operating-system-NetBSD-1.3a 1.3A
397 .ds doc-operating-system-NetBSD-1.4  1.4
398 .ds doc-operating-system-NetBSD-1.5  1.5
399 .ds doc-operating-system-NetBSD-1.6  1.6
400 .ds doc-operating-system-NetBSD-2.0  2.0
401 .ds doc-operating-system-NetBSD-3.0  3.0
402 .
403 .ds doc-operating-system-FreeBSD-1.0     1.0
404 .ds doc-operating-system-FreeBSD-1.1     1.1
405 .ds doc-operating-system-FreeBSD-1.1.5   1.1.5
406 .ds doc-operating-system-FreeBSD-1.1.5.1 1.1.5.1
407 .ds doc-operating-system-FreeBSD-2.0     2.0
408 .ds doc-operating-system-FreeBSD-2.0.5   2.0.5
409 .ds doc-operating-system-FreeBSD-2.1     2.1
410 .ds doc-operating-system-FreeBSD-2.1.5   2.1.5
411 .ds doc-operating-system-FreeBSD-2.1.6   2.1.6
412 .ds doc-operating-system-FreeBSD-2.1.7   2.1.7
413 .ds doc-operating-system-FreeBSD-2.2     2.2
414 .ds doc-operating-system-FreeBSD-2.2.1   2.2.1
415 .ds doc-operating-system-FreeBSD-2.2.2   2.2.2
416 .ds doc-operating-system-FreeBSD-2.2.5   2.2.5
417 .ds doc-operating-system-FreeBSD-2.2.6   2.2.6
418 .ds doc-operating-system-FreeBSD-2.2.7   2.2.7
419 .ds doc-operating-system-FreeBSD-2.2.8   2.2.8
420 .ds doc-operating-system-FreeBSD-3.0     3.0
421 .ds doc-operating-system-FreeBSD-3.1     3.1
422 .ds doc-operating-system-FreeBSD-3.2     3.2
423 .ds doc-operating-system-FreeBSD-3.3     3.3
424 .ds doc-operating-system-FreeBSD-3.4     3.4
425 .ds doc-operating-system-FreeBSD-3.5     3.5
426 .ds doc-operating-system-FreeBSD-4.0     4.0
427 .ds doc-operating-system-FreeBSD-4.1     4.1
428 .ds doc-operating-system-FreeBSD-4.1.1   4.1.1
429 .ds doc-operating-system-FreeBSD-4.2     4.2
430 .ds doc-operating-system-FreeBSD-4.3     4.3
431 .ds doc-operating-system-FreeBSD-4.4     4.4
432 .ds doc-operating-system-FreeBSD-4.5     4.5
433 .ds doc-operating-system-FreeBSD-4.6     4.6
434 .ds doc-operating-system-FreeBSD-4.6.2   4.6.2
435 .ds doc-operating-system-FreeBSD-4.7     4.7
436 .ds doc-operating-system-FreeBSD-4.8     4.8
437 .ds doc-operating-system-FreeBSD-4.9     4.9
438 .ds doc-operating-system-FreeBSD-4.10    4.10
439 .ds doc-operating-system-FreeBSD-4.11    4.11
440 .ds doc-operating-system-FreeBSD-5.0     5.0
441 .ds doc-operating-system-FreeBSD-5.1     5.1
442 .ds doc-operating-system-FreeBSD-5.2     5.2
443 .ds doc-operating-system-FreeBSD-5.2.1   5.2.1
444 .ds doc-operating-system-FreeBSD-5.3     5.3
445 .ds doc-operating-system-FreeBSD-5.4     5.4
446 .ds doc-operating-system-FreeBSD-6.0     6.0
447 .ds doc-operating-system-DragonFly-1.0   1.0
448 .ds doc-operating-system-DragonFly-1.1   1.1
449 .ds doc-operating-system-DragonFly-1.2.0 1.2.0
450 .ds doc-operating-system-DragonFly-1.2.1 1.2.1
451 .ds doc-operating-system-DragonFly-1.2.2 1.2.2
452 .ds doc-operating-system-DragonFly-1.2.3 1.2.3
453 .ds doc-operating-system-DragonFly-1.2.4 1.2.4
454 .ds doc-operating-system-DragonFly-1.2.5 1.2.5
455 .ds doc-operating-system-DragonFly-1.3.0 1.3.0
456 .ds doc-operating-system-DragonFly-1.3.1 1.3.1
457 .ds doc-operating-system-DragonFly-1.3.2 1.3.2
458 .ds doc-operating-system-DragonFly-1.3.3 1.3.3
459 .ds doc-operating-system-DragonFly-1.3.4 1.3.4
460 .ds doc-operating-system-DragonFly-1.3.5 1.3.5
461 .
462 .de Os
463 .  if "\$1"" \
464 .    return
465 .
466 .  ie        "\$1"ATT" \{\
467 .    ds doc-operating-system AT&T
468 .    if \A\a\$2\a \{\
469 .      ie d doc-operating-system-ATT-\$2 \
470 .        as doc-operating-system " \*[doc-operating-system-ATT-\$2]
471 .      el \
472 .        as doc-operating-system " UNIX
473 .  \}\}
474 .  el \{ .ie "\$1"BSD" \{\
475 .    if \A\a\$2\a \{\
476 .      ie d doc-operating-system-BSD-\$2 \
477 .        ds doc-operating-system "\*[doc-operating-system-BSD-\$2]
478 .      el \
479 .        tm mdoc warning: .Os: Unknown BSD version `\$2' (#\n[.c])
480 .  \}\}
481 .  el \{ .ie "\$1"FreeBSD" \{\
482 .    ds doc-operating-system FreeBSD
483 .    if \A\a\$2\a \{\
484 .      ie d doc-operating-system-FreeBSD-\$2 \
485 .        as doc-operating-system \~\*[doc-operating-system-FreeBSD-\$2]
486 .      el \
487 .        tm mdoc warning: .Os: Unknown FreeBSD version `\$2' (#\n[.c])
488 .  \}\}
489 .  el \{ .ie "\$1"DragonFly" \{\
490 .    ds doc-operating-system DragonFly
491 .    if \A\a\$2\a \{\
492 .      ie d doc-operating-system-DragonFly-\$2 \
493 .        as doc-operating-system \~\*[doc-operating-system-DragonFly-\$2]
494 .      el \
495 .        tm mdoc warning: .Os: Unknown DragonFly version `\$2' (#\n[.c])
496 .  \}\}
497 .  el \{ .ie "\$1"NetBSD" \{\
498 .    ds doc-operating-system NetBSD
499 .    if \A\a\$2\a \{\
500 .      ie d doc-operating-system-NetBSD-\$2 \
501 .        as doc-operating-system \~\*[doc-operating-system-NetBSD-\$2]
502 .      el \
503 .        tm mdoc warning: .Os: Unknown NetBSD version `\$2' (#\n[.c])
504 .  \}\}
505 .  el \{\
506 .    ds doc-operating-system \$1
507 .    if !"\$2"" \
508 .      as doc-operating-system " \$2
509 .  \}\}\}\}
510 ..
511 .
512 .
513 .\" NS doc-date-string global string
514 .\" NS   the manual page date as set by `Dd'
515 .
516 .ds doc-date-string
517 .
518 .
519 .\" NS Dd user macro (not parsed, not callable)
520 .\" NS   set document date
521 .\" NS
522 .\" NS modifies:
523 .\" NS   doc-date-string
524 .\" NS
525 .\" NS local variables:
526 .\" NS   doc-date-XXX
527 .\" NS
528 .\" NS width register `Dd' set above
529 .
530 .ds doc-date-1  January
531 .ds doc-date-2  February
532 .ds doc-date-3  March
533 .ds doc-date-4  April
534 .ds doc-date-5  May
535 .ds doc-date-6  June
536 .ds doc-date-7  July
537 .ds doc-date-8  August
538 .ds doc-date-9  September
539 .ds doc-date-10 October
540 .ds doc-date-11 November
541 .ds doc-date-12 December
542 .
543 .de Dd
544 .  \" XXX: why do we need gX?
545 .  if "\*[doc-date-string]"" \
546 .    nr gX 1
547 .
548 .  ie \n[.$] \{\
549 .    ie (\n[.$] == 3) \
550 .      ds doc-date-string \$1\~\$2 \$3
551 .    el \{\
552 .      ds doc-date-string "\*[doc-date-\n[mo]]
553 .      as doc-date-string \~\n[dy], \n[year]
554 .    \}
555 .  \}
556 .  el \
557 .    ds doc-date-string Epoch
558 ..
559 .
560 .
561 .\" NS doc-hyphen-flags global register
562 .\" NS   the parameter for the `.hy' request
563 .\" NS
564 .\" NS override this in `mdoc.local', if necessary.
565 .
566 .nr doc-hyphen-flags 12
567 .
568 .
569 .\" NS doc-header macro
570 .\" NS   print page header
571 .\" NS
572 .\" NS local variables:
573 .\" NS   doc-reg-dh
574 .\" NS   doc-reg-dh1
575 .
576 .de doc-header
577 .  ev doc-env-dh
578 .  doc-setup-page-layout
579 .  if !\n[cR] \
580 '    sp \n[doc-header-space]u
581 .  nr doc-reg-dh \w'\*[doc-caption-font]\*[doc-header-string]\f[]'
582 .  nr doc-reg-dh1 \w'\*[doc-caption-font2]\*[doc-volume]\f[]'
583 .  if (\n[doc-reg-dh] + \n[doc-reg-dh1] + \n[doc-reg-dh] >= \n[.lt]) \{\
584 .    while (\n[doc-reg-dh] + \n[doc-reg-dh1] + \n[doc-reg-dh] >= \n[.lt]) \{\
585 .      substring doc-header-string 0 -2
586 .      nr doc-reg-dh \w'\*[doc-caption-font]\*[doc-header-string]\|.\|.\|.\f[]'
587 .    \}
588 .    as doc-header-string "\|.\|.\|.
589 .  \}
590 .  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
591 '  sp \n[doc-header-space]u
592 .  ev
593 ..
594 .
595 .
596 .\" NS doc-footer macro
597 .\" NS   print page footer
598 .
599 .de doc-footer
600 .  ie \n[cR] \
601 '    br
602 .  el \{\
603 .    ev doc-caption-enviroment
604 .    doc-setup-page-layout
605 '    sp \n[doc-footer-space]u
606 .    ie \n[D] \{\
607 .      ie o \
608 .        tl \a%\a\*[doc-caption-font2]\*[doc-date-string]\f[]\a\*[doc-caption-font]\*[doc-operating-system]\f[]\a
609 .      el \
610 .        tl \a\*[doc-caption-font]\*[doc-operating-system]\f[]\a\*[doc-caption-font2]\*[doc-date-string]\f[]\a%\a
611 .    \}
612 .    el \
613 .      tl \a\*[doc-caption-font]\*[doc-operating-system]\f[]\a\*[doc-caption-font2]\*[doc-date-string]\f[]\a%\a
614 '    bp
615 .    ev
616 .  \}
617 ..
618 .
619 .
620 .\" NS doc-end-macro macro
621 .\" NS   finish output
622 .
623 .de doc-end-macro
624 .  \" We may still have a partial line in the environment.  If this is the
625 .  \" case, and we happen to be on the last line of the page, the `.fl'
626 .  \" request will cause the page to be ejected and troff will immediately
627 .  \" exit.  If we are in nroff mode, this would be unfortunate, since we
628 .  \" would never get a chance to output the footer.  So we fudge the page
629 .  \" length to make sure that the last page is never ejected until we want
630 .  \" it to be.
631 .
632 .  if \n[cR] \
633 .    pl +3v
634 .  fl
635 .
636 .  if \n[doc-list-depth] \
637 .    tm mdoc warning: list open at EOF!  A .Bl directive has no matching .El
638 .
639 .  if \n[cR] \{\
640 '    sp
641 .    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
642 .    \" suppress empty lines after the footer
643 .    pl \n[nl]u
644 .  \}
645 ..
646 .
647 .
648 .\" NS doc-paragraph macro
649 .\" NS   insert a paragraph
650 .
651 .de doc-paragraph
652 .  sp \n[doc-paragraph-space]u
653 .  if !\n[cR] \
654 .    ne 2
655 .  ns
656 ..
657 .
658 .
659 .\" NS Pp user macro (not parsed, not callable)
660 .\" NS   new paragraph
661 .\" NS
662 .\" NS width register `Pp' set above
663 .
664 .als Pp doc-paragraph
665 .
666 .
667 .\" NS Lp user macro (not parsed, not callable)
668 .\" NS   same as .Pp
669 .\" NS
670 .\" NS width register `Lp' set above
671 .
672 .als Lp doc-paragraph
673 .
674 .
675 .de LP
676 .  tm Not a \-mdoc command: .LP (#\n[.c])
677 ..
678 .
679 .
680 .de PP
681 .  tm Not a \-mdoc command: .PP (#\n[.c])
682 ..
683 .
684 .
685 .de pp
686 .  tm Not a \-mdoc command: .pp (#\n[.c])
687 ..
688 .
689 .
690 .de SH
691 .  tm Not a \-mdoc command: .SH (#\n[.c])
692 ..
693 .
694 .
695 .\" NS Nd user macro (not parsed, not callable)
696 .\" NS   print name description
697 .\" NS
698 .\" NS width register `Nd' set above
699 .
700 .de Nd
701 .  nop \- \$*
702 ..
703 .
704 .
705 .\" NS doc-in-synopsis-section global register (bool)
706 .\" NS   whether we are in the `synopsis' section
707 .
708 .nr doc-in-synopsis-section 0
709 .
710 .
711 .\" NS doc-in-see-also-section global register (bool)
712 .\" NS   whether we are in the `see also' section
713 .
714 .nr doc-in-see-also-section 0
715 .
716 .
717 .\" NS doc-in-files-section global register (bool)
718 .\" NS   whether we are in the `files' section
719 .
720 .nr doc-in-files-section 0
721 .
722 .
723 .\" NS doc-in-authors-section global register (bool)
724 .\" NS   whether we are in the `authors' section
725 .
726 .nr doc-in-authors-section 0
727 .
728 .
729 .\" NS doc-first-parameter macro
730 .\" NS   return first parameter
731 .\" NS
732 .\" NS local variables:
733 .\" NS   doc-str-dfp
734 .
735 .de doc-first-parameter
736 .  ds doc-str-dfp "\$1
737 ..
738 .
739 .
740 .\" NS Sh user macro (not callable)
741 .\" NS   section headers
742 .\" NS
743 .\" NS modifies:
744 .\" NS   doc-func-args-processed
745 .\" NS   doc-func-count
746 .\" NS   doc-in-authors-section
747 .\" NS   doc-in-files-section
748 .\" NS   doc-in-see-also-section
749 .\" NS   doc-in-synopsis-section
750 .\" NS   doc-indent-synopsis
751 .\" NS   doc-indent-synopsis-active
752 .\" NS   doc-is-func
753 .\" NS   doc-num-func-args
754 .\" NS
755 .\" NS local variables:
756 .\" NS   doc-reg-Sh
757 .\" NS   doc-reg-Sh1
758 .\" NS   doc-section-XXX
759 .\" NS
760 .\" NS width register `Sh' set in doc-common
761 .
762 .ds doc-section-name        NAME
763 .ds doc-section-synopsis    SYNOPSIS
764 .ds doc-section-description DESCRIPTION
765 .ds doc-section-see-also    SEE
766 .ds doc-section-files       FILES
767 .ds doc-section-authors     AUTHORS
768 .
769 .de Sh
770 .  ie \n[doc-arg-limit] \{\
771 .    \" we only allow `Sh' within `Sh'; it will change the font back to
772 .    \" `doc-Sh-font'
773 .    ie "\*[doc-macro-name]"Sh" \{\
774 .      nr doc-arg-ptr +1
775 .      ie (\n[doc-arg-limit] >= \n[doc-arg-ptr]) \{\
776 .        nr doc-curr-font \n[.f]
777 .        nr doc-curr-size \n[.ps]
778 .        nop \*[doc-Sh-font]\c
779 .        doc-print-recursive
780 .      \}
781 .      el \{\
782 .        tm Usage: .Sh section_name ... (#\n[.c])
783 .        doc-reset-args
784 .    \}\}
785 .    el \{\
786 .      tm Usage: .Sh not callable by other macros (#\n[.c])
787 .      doc-reset-args
788 .  \}\}
789 .  el \{\
790 .    if !\n[.$] \{\
791 .      tm Usage: .Sh section_name ... (#\n[.c])
792 .      return
793 .    \}
794 .
795 .    ds doc-macro-name Sh
796 .    doc-parse-args \$@
797 .
798 .    if t \
799 '      ad
800 .
801 .    \" this resolves e.g. `.Sh "SEE ALSO"'
802 .    doc-first-parameter \$*
803 .
804 .    ie "\*[doc-str-dfp]"\*[doc-section-name]" \{\
805 .      doc-setup-header
806 '      in 0
807 .    \}
808 .    el \{\
809 .      nr doc-in-synopsis-section 0
810 .      nr doc-in-see-also-section 0
811 .      nr doc-in-files-section 0
812 .      nr doc-in-authors-section 0
813 .
814 .      ie        "\*[doc-str-dfp]"\*[doc-section-synopsis]" \{\
815 .        if t \
816 .          na
817 .        nr doc-in-synopsis-section 1
818 .        nr doc-indent-synopsis 0
819 .        nr doc-indent-synopsis-active 0
820 .      \}
821 .      el \{ .ie "\*[doc-str-dfp]"\*[doc-section-description]" \{\
822 .        nr doc-is-func 0
823 .        nr doc-func-count 0
824 .        nr doc-func-args-processed 0
825 .        nr doc-num-func-args 0
826 .      \}
827 .      el \{ .ie "\*[doc-str-dfp]"\*[doc-section-see-also]" \{\
828 .        if t \
829 .          na
830 .        nr doc-in-see-also-section 1
831 .      \}
832 .      el \{ .ie "\*[doc-str-dfp]"\*[doc-section-files]" \
833 .        nr doc-in-files-section 1
834 .      el .if    "\*[doc-str-dfp]"\*[doc-section-authors]" \
835 .        nr doc-in-authors-section 1
836 .      \}\}\}
837 .
838 .      in 0
839 .      nr doc-have-author 0
840 .    \}
841 .
842 .    doc-setup-page-layout
843 '    sp
844 .    ns
845 .    ta T .5i
846 .    if !\n[cR] \
847 .      ne 3
848 '    fi
849 .
850 .    if t \{\
851 .      nr doc-reg-Sh \n[.ss]
852 .      nr doc-reg-Sh1 \n[.sss]
853 .      ss (\n[.ss] * 5 / 3) (\n[.sss] * 5 / 3)
854 .    \}
855 .
856 .    nr doc-arg-ptr +1
857 .    nr doc-curr-font \n[.f]
858 .    nr doc-curr-size \n[.ps]
859 .    nop \*[doc-Sh-font]\c
860 .    doc-print-recursive
861 .
862 .    if t \
863 .      ss \n[doc-reg-Sh] \n[doc-reg-Sh1]
864 .
865 .    in +\n[doc-subheader-indent]u
866 .    ns
867 .  \}
868 ..
869 .
870 .
871 .\" NS Ss user macro (not callable)
872 .\" NS   subsection
873 .\" NS
874 .\" NS local variable:
875 .\" NS   doc-reg-Ss
876 .\" NS   doc-reg-Ss1
877 .\" NS
878 .\" NS width register `Ss' set above
879 .
880 .de Ss
881 .  ie \n[doc-arg-limit] \{\
882 .    \" we only allow `Ss' within `Ss'; it will change the font back to
883 .    \" `doc-Sh-font'
884 .    ie "\*[doc-macro-name]"Ss" \{\
885 .      nr doc-arg-ptr +1
886 .      ie (\n[doc-arg-limit] >= \n[doc-arg-ptr]) \{\
887 .        nr doc-curr-font \n[.f]
888 .        nr doc-curr-size \n[.ps]
889 .        nop \*[doc-Sh-font]\c
890 .        doc-print-recursive
891 .      \}
892 .      el \{\
893 .        tm Usage: .Ss subsection_name ... (#\n[.c])
894 .        doc-reset-args
895 .    \}\}
896 .    el \{\
897 .      tm Usage: .Ss not callable by other macros (#\n[.c])
898 .      doc-reset-args
899 .  \}\}
900 .  el \{\
901 .    if !\n[.$] \{\
902 .      tm Usage: .Ss subsection_name ... (#\n[.c])
903 .      return
904 .    \}
905 .
906 .    ds doc-macro-name Ss
907 .    doc-parse-args \$@
908 .
909 .    sp
910 .    if !\n[cR] \
911 .      ne 3
912 .    ti -.25i
913 .
914 .    nr doc-reg-Ss \n[.ss]
915 .    nr doc-reg-Ss1 \n[.sss]
916 .    ss (\n[.ss] * 5 / 4) (\n[.sss] * 5 / 4)
917 .
918 .    nr doc-arg-ptr +1
919 .    nr doc-curr-font \n[.f]
920 .    nr doc-curr-size \n[.ps]
921 .    nop \*[doc-Sh-font]\c
922 .    doc-print-recursive
923 .
924 .    ss \n[doc-reg-Ss] \n[doc-reg-Ss1]
925 .
926 .    ta T .5i
927 .    if !\n[cR] \
928 .      ne 2
929 .    br
930 .    ns
931 .  \}
932 ..
933 .
934 .
935 .\" NS Rd macro (not parsed, not callable)
936 .\" NS   print global register dump to stderr
937 .\" NS
938 .\" NS local variables:
939 .\" NS   doc-reg-Rd
940 .
941 .de Rd
942 .  tm MDOC GLOBAL REGISTER DUMP
943 .  tm doc-macro-name == `\*[doc-macro-name]'
944 .  tm doc-arg-limit == \n[doc-arg-limit]
945 .  tm doc-num-args == \n[doc-num-args]
946 .  tm doc-arg-ptr == \n[doc-arg-ptr]
947 .
948 .  nr doc-reg-Rd 1
949 .  while (\n[doc-reg-Rd] <= \n[doc-arg-limit]) \{\
950 .    tm doc-arg\n[doc-reg-Rd] == `\*[doc-arg\n[doc-reg-Rd]]'
951 .    tm doc-type\n[doc-reg-Rd] == \n[doc-type\n[doc-reg-Rd]]
952 .    tm doc-space\n[doc-reg-Rd] == `\*[doc-space\n[doc-reg-Rd]]'
953 .    nr doc-reg-Rd +1
954 .  \}
955 .
956 .  tm doc-curr-font == \n[doc-curr-font]
957 .  tm doc-curr-size == \n[doc-curr-size]
958 .  tm doc-indent-synopsis == \n[doc-indent-synopsis]
959 .  tm doc-indent-synopsis-active == \n[doc-indent-synopsis-active]
960 .  tm doc-have-decl == \n[doc-have-decl]
961 .  tm doc-have-var == \n[doc-have-var]
962 .  tm doc-command-name == `\*[doc-command-name]'
963 .  tm doc-quote-left == `\*[doc-quote-left]'
964 .  tm doc-quote-right == `\*[doc-quote-right]'
965 .  tm doc-nesting-level == \n[doc-nesting-level]
966 .  tm doc-in-list == \n[doc-in-list]
967 .  tm doc-space == `\*[doc-space]'
968 .  tm doc-saved-space == `\*[doc-saved-space]'
969 .  tm doc-space-mode == \n[doc-space-mode]
970 .  tm doc-have-space == \n[doc-have-space]
971 .  tm doc-have-slot == \n[doc-have-slot]
972 .  tm doc-keep-type == \n[doc-keep-type]
973 .  tm doc-display-depth == \n[doc-display-depth]
974 .  tm doc-is-compact == \n[doc-is-compact]
975 .
976 .  nr doc-reg-Rd 0
977 .  while (\n[doc-reg-Rd] <= \n[doc-display-depth]) \{\
978 .    tm doc-display-type-stack\n[doc-reg-Rd] == `\*[doc-display-type-stack\n[doc-reg-Rd]]'
979 .    tm doc-display-indent-stack\n[doc-reg-Rd] == \n[doc-display-indent-stack\n[doc-reg-Rd]]
980 .    tm doc-display-ad-stack\n[doc-reg-Rd] == \n[doc-display-ad-stack\n[doc-reg-Rd]]
981 .    tm doc-display-fi-stack\n[doc-reg-Rd] == \n[doc-display-fi-stack\n[doc-reg-Rd]]
982 .    tm doc-display-ft-stack\n[doc-reg-Rd] == \n[doc-display-ft-stack\n[doc-reg-Rd]]
983 .    tm doc-display-ps-stack\n[doc-reg-Rd] == \n[doc-display-ps-stack\n[doc-reg-Rd]]
984 .    nr doc-reg-Rd +1
985 .  \}
986 .
987 .  tm doc-fontmode-depth == \n[doc-fontmode-depth]
988 .
989 .  nr doc-reg-Rd 1
990 .  while (\n[doc-reg-Rd] <= \n[doc-fontmode-depth]) \{\
991 .    tm doc-fontmode-font-stack\n[doc-reg-Rd] == `\n[doc-fontmode-font-stack\n[doc-reg-Rd]]'
992 .    tm doc-fontmode-size-stack\n[doc-reg-Rd] == `\n[doc-fontmode-size-stack\n[doc-reg-Rd]]'
993 .    nr doc-reg-Rd +1
994 .  \}
995 .
996 .  tm doc-list-depth == \n[doc-list-depth]
997 .
998 .  nr doc-reg-Rd 1
999 .  while (\n[doc-reg-Rd] <= \n[doc-list-depth]) \{\
1000 .    tm doc-list-type-stack\n[doc-reg-Rd] == `\*[doc-list-type-stack\n[doc-reg-Rd]]'
1001 .    tm doc-list-have-indent-stack\n[doc-reg-Rd] == \n[doc-list-have-indent-stack\n[doc-reg-Rd]]
1002 .    tm doc-list-indent-stack\n[doc-reg-Rd] == \n[doc-list-indent-stack\n[doc-reg-Rd]]
1003 .    tm doc-compact-list-stack\n[doc-reg-Rd] == \n[doc-compact-list-stack\n[doc-reg-Rd]]
1004 .    tm doc-tag-prefix-stack\n[doc-reg-Rd] == `\*[doc-tag-prefix-stack\n[doc-reg-Rd]]'
1005 .    tm doc-tag-width-stack\n[doc-reg-Rd] == `\*[doc-tag-width-stack\n[doc-reg-Rd]]'
1006 .    tm doc-list-offset-stack\n[doc-reg-Rd] == \n[doc-list-offset-stack\n[doc-reg-Rd]]
1007 .    tm doc-enum-list-count-stack\n[doc-reg-Rd] == \n[doc-enum-list-count-stack\n[doc-reg-Rd]]
1008 .    nr doc-reg-Rd +1
1009 .  \}
1010 .
1011 .  tm doc-saved-Pa-font == `\*[doc-saved-Pa-font]'
1012 .  tm doc-curr-type == \n[doc-curr-type]
1013 .  tm doc-curr-arg == `\*[doc-curr-arg]'
1014 .  tm doc-diag-list-input-line-count == \n[doc-diag-list-input-line-count]
1015 .  tm doc-num-columns == \n[doc-num-columns]
1016 .  tm doc-column-indent-width == \n[doc-column-indent-width]
1017 .  tm doc-is-func == \n[doc-is-func]
1018 .  tm doc-have-old-func == \n[doc-have-old-func]
1019 .  tm doc-func-arg-count == \n[doc-func-arg-count]
1020 .  tm doc-func-arg == `\*[doc-func-arg]'
1021 .  tm doc-num-func-args == \n[doc-num-func-args]
1022 .  tm doc-func-args-processed == \n[doc-func-args-processed]
1023 .  tm doc-have-func == \n[doc-have-func]
1024 .  tm doc-is-reference == \n[doc-is-reference]
1025 .  tm doc-reference-count == \n[doc-reference-count]
1026 .  tm doc-author-count == \n[doc-author-count]
1027 .
1028 .  nr doc-reg-Rd 0
1029 .  while (\n[doc-reg-Rd] <= \n[doc-author-count]) \{\
1030 .    tm doc-author-name\n[doc-reg-Rd] == `\*[doc-author-name\n[doc-reg-Rd]]'
1031 .    nr doc-reg-Rd +1
1032 .  \}
1033 .
1034 .  tm doc-book-count == \n[doc-book-count]
1035 .  tm doc-book-name == `\*[doc-book-name]'
1036 .  tm doc-date-count == \n[doc-date-count]
1037 .  tm doc-date == `\*[doc-date]'
1038 .  tm doc-publisher-count == \n[doc-publisher-count]
1039 .  tm doc-publisher-name == `\*[doc-publisher-name]'
1040 .  tm doc-journal-count == \n[doc-journal-count]
1041 .  tm doc-journal-name == `\*[doc-journal-name]'
1042 .  tm doc-issue-count == \n[doc-issue-count]
1043 .  tm doc-issue-name == `\*[doc-issue-name]'
1044 .  tm doc-optional-count == \n[doc-optional-count]
1045 .  tm doc-optional-string == `\*[doc-optional-string]'
1046 .  tm doc-page-number-count == \n[doc-page-number-count]
1047 .  tm doc-page-number-string == `\*[doc-page-number-string]'
1048 .  tm doc-corporate-count == \n[doc-corporate-count]
1049 .  tm doc-corporate-name == `\*[doc-corporate-name]'
1050 .  tm doc-report-count == \n[doc-report-count]
1051 .  tm doc-report-name == `\*[doc-report-name]'
1052 .  tm doc-reference-title-count == \n[doc-reference-title-count]
1053 .  tm doc-reference-title-name == `\*[doc-reference-title-name]'
1054 .  tm doc-reference-title-name-for-book == `\*[doc-reference-title-name-for-book]'
1055 .  tm doc-volume-count == \n[doc-volume-count]
1056 .  tm doc-volume-name == `\*[doc-volume-name]'
1057 .  tm doc-have-author == \n[doc-have-author]
1058 .
1059 .  tm doc-document-title == `\*[doc-document-title]'
1060 .  tm doc-volume == `\*[doc-volume]'
1061 .  tm doc-section == `\*[doc-section]'
1062 .  tm doc-operating-system == `\*[doc-operating-system]'
1063 .  tm doc-date-string == `\*[doc-date-string]'
1064 .  tm doc-header-space == \n[doc-header-space]
1065 .  tm doc-footer-space == \n[doc-footer-space]
1066 .  tm doc-display-vertical == \n[doc-display-vertical]
1067 .  tm doc-header-string == `\*[doc-header-string]'
1068 .  tm doc-in-synopsis-section == \n[doc-in-synopsis-section]
1069 .  tm doc-in-see-also-section == \n[doc-in-see-also-section]
1070 .  tm doc-in-files-section == \n[doc-in-files-section]
1071 .  tm doc-in-authors-section == \n[doc-in-authors-section]
1072 .
1073 .  tm END OF GLOBAL REGISTER DUMP
1074 ..
1075 .
1076 .
1077 .ec
1078 .
1079 .\" EOF