0e8808f986ae4e136c1f427c6e9ce2a808268c5e
[dragonfly.git] / contrib / 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 .\"     $FreeBSD: src/contrib/groff/tmac/doc-common,v 1.21.2.28 2003/02/14 15:22:11 ru Exp $
34 .\"     $DragonFly: src/contrib/groff/tmac/Attic/doc-common,v 1.2 2003/06/17 04:24:02 dillon Exp $
35 .\"
36 .\"     %beginstrip%
37 .
38 .
39 .\" Macro Identifiers.  For each user macro a corresponding register with
40 .\" the same name must exist.  Its value must not be zero.
41 .
42 .nr %A 1
43 .nr %B 1
44 .nr %D 1
45 .nr %I 1
46 .nr %J 1
47 .nr %N 1
48 .nr %O 1
49 .nr %P 1
50 .nr %Q 1
51 .nr %R 1
52 .nr %T 1
53 .nr %V 1
54 .nr Ac 3
55 .nr Ad 12n
56 .nr An 12n
57 .nr Ao 12n
58 .nr Ap 2
59 .nr Aq 12n
60 .nr Ar 12n
61 .nr At 1
62 .nr Bc 3
63 .nr Bf 8n\" ?
64 .nr Bk 8n\" ?
65 .nr Bl 1
66 .nr Bo 12n
67 .nr Bq 12n
68 .nr Brc 3
69 .nr Bro 12n
70 .nr Brq 12n
71 .nr Bsx 1
72 .nr Bt 8n\" ?
73 .nr Bx 1
74 .nr Cd 12n
75 .nr Cm 10n
76 .nr D1 8n\" ?
77 .nr Dc 3
78 .nr Dl 8n\" ?
79 .nr Dt 8n\" ?
80 .nr Do 12n
81 .nr Dq 12n
82 .nr Ds 6n\" many manpages still use this as a -width value
83 .nr Dv 12n
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 .
401 .ds doc-operating-system-FreeBSD-1.0     1.0
402 .ds doc-operating-system-FreeBSD-1.1     1.1
403 .ds doc-operating-system-FreeBSD-1.1.5   1.1.5
404 .ds doc-operating-system-FreeBSD-1.1.5.1 1.1.5.1
405 .ds doc-operating-system-FreeBSD-2.0     2.0
406 .ds doc-operating-system-FreeBSD-2.0.5   2.0.5
407 .ds doc-operating-system-FreeBSD-2.1     2.1
408 .ds doc-operating-system-FreeBSD-2.1.5   2.1.5
409 .ds doc-operating-system-FreeBSD-2.1.6   2.1.6
410 .ds doc-operating-system-FreeBSD-2.1.7   2.1.7
411 .ds doc-operating-system-FreeBSD-2.2     2.2
412 .ds doc-operating-system-FreeBSD-2.2.1   2.2.1
413 .ds doc-operating-system-FreeBSD-2.2.2   2.2.2
414 .ds doc-operating-system-FreeBSD-2.2.5   2.2.5
415 .ds doc-operating-system-FreeBSD-2.2.6   2.2.6
416 .ds doc-operating-system-FreeBSD-2.2.7   2.2.7
417 .ds doc-operating-system-FreeBSD-2.2.8   2.2.8
418 .ds doc-operating-system-FreeBSD-3.0     3.0
419 .ds doc-operating-system-FreeBSD-3.1     3.1
420 .ds doc-operating-system-FreeBSD-3.2     3.2
421 .ds doc-operating-system-FreeBSD-3.3     3.3
422 .ds doc-operating-system-FreeBSD-3.4     3.4
423 .ds doc-operating-system-FreeBSD-3.5     3.5
424 .ds doc-operating-system-FreeBSD-4.0     4.0
425 .ds doc-operating-system-FreeBSD-4.1     4.1
426 .ds doc-operating-system-FreeBSD-4.1.1   4.1.1
427 .ds doc-operating-system-FreeBSD-4.2     4.2
428 .ds doc-operating-system-FreeBSD-4.3     4.3
429 .ds doc-operating-system-FreeBSD-4.4     4.4
430 .ds doc-operating-system-FreeBSD-4.5     4.5
431 .ds doc-operating-system-FreeBSD-4.6     4.6
432 .ds doc-operating-system-FreeBSD-4.6.2   4.6.2
433 .ds doc-operating-system-FreeBSD-4.7     4.7
434 .ds doc-operating-system-FreeBSD-4.8     4.8
435 .ds doc-operating-system-FreeBSD-5.0     5.0
436 .
437 .de Os
438 .  if "\$1"" \
439 .    return
440 .
441 .  ie        "\$1"ATT" \{\
442 .    ds doc-operating-system AT&T
443 .    if \A\a\$2\a \{\
444 .      ie d doc-operating-system-ATT-\$2 \
445 .        as doc-operating-system " \*[doc-operating-system-ATT-\$2]
446 .      el \
447 .        as doc-operating-system " UNIX
448 .  \}\}
449 .  el \{ .ie "\$1"BSD" \{\
450 .    if \A\a\$2\a \{\
451 .      ie d doc-operating-system-BSD-\$2 \
452 .        ds doc-operating-system "\*[doc-operating-system-BSD-\$2]
453 .      el \
454 .        tm mdoc warning: .Os: Unknown BSD version `\$2' (#\n[.c])
455 .  \}\}
456 .  el \{ .ie "\$1"FreeBSD" \{\
457 .    ds doc-operating-system FreeBSD
458 .    if \A\a\$2\a \{\
459 .      ie d doc-operating-system-FreeBSD-\$2 \
460 .        as doc-operating-system \~\*[doc-operating-system-FreeBSD-\$2]
461 .      el \
462 .        tm mdoc warning: .Os: Unknown FreeBSD version `\$2' (#\n[.c])
463 .  \}\}
464 .  el \{ .ie "\$1"NetBSD" \{\
465 .    ds doc-operating-system NetBSD
466 .    if \A\a\$2\a \{\
467 .      ie d doc-operating-system-NetBSD-\$2 \
468 .        as doc-operating-system \~\*[doc-operating-system-NetBSD-\$2]
469 .      el \
470 .        tm mdoc warning: .Os: Unknown NetBSD version `\$2' (#\n[.c])
471 .  \}\}
472 .  el \{\
473 .    ds doc-operating-system \$1
474 .    if !"\$2"" \
475 .      as doc-operating-system " \$2
476 .  \}\}\}\}
477 ..
478 .
479 .
480 .\" NS doc-date-string global string
481 .\" NS   the manual page date as set by `Dd'
482 .
483 .ds doc-date-string
484 .
485 .
486 .\" NS Dd user macro (not parsed, not callable)
487 .\" NS   set document date
488 .\" NS
489 .\" NS modifies:
490 .\" NS   doc-date-string
491 .\" NS
492 .\" NS local variables:
493 .\" NS   doc-date-XXX
494 .\" NS
495 .\" NS width register `Dd' set above
496 .
497 .ds doc-date-1  January
498 .ds doc-date-2  February
499 .ds doc-date-3  March
500 .ds doc-date-4  April
501 .ds doc-date-5  May
502 .ds doc-date-6  June
503 .ds doc-date-7  July
504 .ds doc-date-8  August
505 .ds doc-date-9  September
506 .ds doc-date-10 October
507 .ds doc-date-11 November
508 .ds doc-date-12 December
509 .
510 .de Dd
511 .  \" XXX: why do we need gX?
512 .  if "\*[doc-date-string]"" \
513 .    nr gX 1
514 .
515 .  ie \n[.$] \{\
516 .    ie (\n[.$] == 3) \
517 .      ds doc-date-string \$1\~\$2 \$3
518 .    el \{\
519 .      ds doc-date-string "\*[doc-date-\n[mo]]
520 .      as doc-date-string \~\n[dy], \n[year]
521 .    \}
522 .  \}
523 .  el \
524 .    ds doc-date-string Epoch
525 ..
526 .
527 .
528 .\" NS doc-hyphen-flags global register
529 .\" NS   the parameter for the `.hy' request
530 .\" NS
531 .\" NS override this in `mdoc.local', if necessary.
532 .
533 .nr doc-hyphen-flags 12
534 .
535 .
536 .\" NS doc-header macro
537 .\" NS   print page header
538 .\" NS
539 .\" NS local variables:
540 .\" NS   doc-reg-dh
541 .\" NS   doc-reg-dh1
542 .
543 .de doc-header
544 .  ev doc-env-dh
545 .  doc-setup-page-layout
546 .  if !\n[cR] \
547 '    sp \n[doc-header-space]u
548 .  nr doc-reg-dh \w'\*[doc-caption-font]\*[doc-header-string]\f[]'
549 .  nr doc-reg-dh1 \w'\*[doc-caption-font2]\*[doc-volume]\f[]'
550 .  if (\n[doc-reg-dh] + \n[doc-reg-dh1] + \n[doc-reg-dh] >= \n[.lt]) \{\
551 .    while (\n[doc-reg-dh] + \n[doc-reg-dh1] + \n[doc-reg-dh] >= \n[.lt]) \{\
552 .      substring doc-header-string 0 -2
553 .      nr doc-reg-dh \w'\*[doc-caption-font]\*[doc-header-string]\|.\|.\|.\f[]'
554 .    \}
555 .    as doc-header-string "\|.\|.\|.
556 .  \}
557 .  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
558 '  sp \n[doc-header-space]u
559 .  ev
560 ..
561 .
562 .
563 .\" NS doc-footer macro
564 .\" NS   print page footer
565 .
566 .de doc-footer
567 .  ie \n[cR] \
568 '    br
569 .  el \{\
570 .    ev doc-caption-enviroment
571 .    doc-setup-page-layout
572 '    sp \n[doc-footer-space]u
573 .    ie \n[D] \{\
574 .      ie o \
575 .        tl \a%\a\*[doc-caption-font2]\*[doc-date-string]\f[]\a\*[doc-caption-font]\*[doc-operating-system]\f[]\a
576 .      el \
577 .        tl \a\*[doc-caption-font]\*[doc-operating-system]\f[]\a\*[doc-caption-font2]\*[doc-date-string]\f[]\a%\a
578 .    \}
579 .    el \
580 .      tl \a\*[doc-caption-font]\*[doc-operating-system]\f[]\a\*[doc-caption-font2]\*[doc-date-string]\f[]\a%\a
581 '    bp
582 .    ev
583 .  \}
584 ..
585 .
586 .
587 .\" NS doc-end-macro macro
588 .\" NS   finish output
589 .
590 .de doc-end-macro
591 .  \" We may still have a partial line in the environment.  If this is the
592 .  \" case, and we happen to be on the last line of the page, the `.fl'
593 .  \" request will cause the page to be ejected and troff will immediately
594 .  \" exit.  If we are in nroff mode, this would be unfortunate, since we
595 .  \" would never get a chance to output the footer.  So we fudge the page
596 .  \" length to make sure that the last page is never ejected until we want
597 .  \" it to be.
598 .
599 .  if \n[cR] \
600 .    pl +3v
601 .  fl
602 .
603 .  if \n[doc-list-depth] \
604 .    tm mdoc warning: list open at EOF!  A .Bl directive has no matching .El
605 .
606 .  if \n[cR] \{\
607 '    sp
608 .    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
609 .    \" suppress empty lines after the footer
610 .    pl \n[nl]u
611 .  \}
612 ..
613 .
614 .
615 .\" NS doc-paragraph macro
616 .\" NS   insert a paragraph
617 .
618 .de doc-paragraph
619 .  sp \n[doc-paragraph-space]u
620 .  if !\n[cR] \
621 .    ne 2
622 .  ns
623 ..
624 .
625 .
626 .\" NS Pp user macro (not parsed, not callable)
627 .\" NS   new paragraph
628 .\" NS
629 .\" NS width register `Pp' set above
630 .
631 .als Pp doc-paragraph
632 .
633 .
634 .\" NS Lp user macro (not parsed, not callable)
635 .\" NS   same as .Pp
636 .\" NS
637 .\" NS width register `Lp' set above
638 .
639 .als Lp doc-paragraph
640 .
641 .
642 .de LP
643 .  tm Not a \-mdoc command: .LP (#\n[.c])
644 ..
645 .
646 .
647 .de PP
648 .  tm Not a \-mdoc command: .PP (#\n[.c])
649 ..
650 .
651 .
652 .de pp
653 .  tm Not a \-mdoc command: .pp (#\n[.c])
654 ..
655 .
656 .
657 .de SH
658 .  tm Not a \-mdoc command: .SH (#\n[.c])
659 ..
660 .
661 .
662 .\" NS Nd user macro (not parsed, not callable)
663 .\" NS   print name description
664 .\" NS
665 .\" NS width register `Nd' set above
666 .
667 .de Nd
668 .  nop \- \$*
669 ..
670 .
671 .
672 .\" NS doc-in-synopsis-section global register (bool)
673 .\" NS   whether we are in the `synopsis' section
674 .
675 .nr doc-in-synopsis-section 0
676 .
677 .
678 .\" NS doc-in-see-also-section global register (bool)
679 .\" NS   whether we are in the `see also' section
680 .
681 .nr doc-in-see-also-section 0
682 .
683 .
684 .\" NS doc-in-files-section global register (bool)
685 .\" NS   whether we are in the `files' section
686 .
687 .nr doc-in-files-section 0
688 .
689 .
690 .\" NS doc-in-authors-section global register (bool)
691 .\" NS   whether we are in the `authors' section
692 .
693 .nr doc-in-authors-section 0
694 .
695 .
696 .\" NS doc-first-parameter macro
697 .\" NS   return first parameter
698 .\" NS
699 .\" NS local variables:
700 .\" NS   doc-str-dfp
701 .
702 .de doc-first-parameter
703 .  ds doc-str-dfp "\$1
704 ..
705 .
706 .
707 .\" NS Sh user macro (not callable)
708 .\" NS   section headers
709 .\" NS
710 .\" NS modifies:
711 .\" NS   doc-func-args-processed
712 .\" NS   doc-func-count
713 .\" NS   doc-in-authors-section
714 .\" NS   doc-in-files-section
715 .\" NS   doc-in-see-also-section
716 .\" NS   doc-in-synopsis-section
717 .\" NS   doc-indent-synopsis
718 .\" NS   doc-indent-synopsis-active
719 .\" NS   doc-is-func
720 .\" NS   doc-num-func-args
721 .\" NS
722 .\" NS local variables:
723 .\" NS   doc-reg-Sh
724 .\" NS   doc-reg-Sh1
725 .\" NS   doc-section-XXX
726 .\" NS
727 .\" NS width register `Sh' set in doc-common
728 .
729 .ds doc-section-name        NAME
730 .ds doc-section-synopsis    SYNOPSIS
731 .ds doc-section-description DESCRIPTION
732 .ds doc-section-see-also    SEE
733 .ds doc-section-files       FILES
734 .ds doc-section-authors     AUTHORS
735 .
736 .de Sh
737 .  ie \n[doc-arg-limit] \{\
738 .    \" we only allow `Sh' within `Sh'; it will change the font back to
739 .    \" `doc-Sh-font'
740 .    ie "\*[doc-macro-name]"Sh" \{\
741 .      nr doc-arg-ptr +1
742 .      ie (\n[doc-arg-limit] >= \n[doc-arg-ptr]) \{\
743 .        nr doc-curr-font \n[.f]
744 .        nr doc-curr-size \n[.ps]
745 .        nop \*[doc-Sh-font]\c
746 .        doc-print-recursive
747 .      \}
748 .      el \{\
749 .        tm Usage: .Sh section_name ... (#\n[.c])
750 .        doc-reset-args
751 .    \}\}
752 .    el \{\
753 .      tm Usage: .Sh not callable by other macros (#\n[.c])
754 .      doc-reset-args
755 .  \}\}
756 .  el \{\
757 .    if !\n[.$] \{\
758 .      tm Usage: .Sh section_name ... (#\n[.c])
759 .      return
760 .    \}
761 .
762 .    ds doc-macro-name Sh
763 .    doc-parse-args \$@
764 .
765 .    if t \
766 '      ad
767 .
768 .    \" this resolves e.g. `.Sh "SEE ALSO"'
769 .    doc-first-parameter \$*
770 .
771 .    ie "\*[doc-str-dfp]"\*[doc-section-name]" \{\
772 .      doc-setup-header
773 '      in 0
774 .    \}
775 .    el \{\
776 .      nr doc-in-synopsis-section 0
777 .      nr doc-in-see-also-section 0
778 .      nr doc-in-files-section 0
779 .      nr doc-in-authors-section 0
780 .
781 .      ie        "\*[doc-str-dfp]"\*[doc-section-synopsis]" \{\
782 .        if t \
783 .          na
784 .        nr doc-in-synopsis-section 1
785 .        nr doc-indent-synopsis 0
786 .        nr doc-indent-synopsis-active 0
787 .      \}
788 .      el \{ .ie "\*[doc-str-dfp]"\*[doc-section-description]" \{\
789 .        nr doc-is-func 0
790 .        nr doc-func-count 0
791 .        nr doc-func-args-processed 0
792 .        nr doc-num-func-args 0
793 .      \}
794 .      el \{ .ie "\*[doc-str-dfp]"\*[doc-section-see-also]" \{\
795 .        if t \
796 .          na
797 .        nr doc-in-see-also-section 1
798 .      \}
799 .      el \{ .ie "\*[doc-str-dfp]"\*[doc-section-files]" \
800 .        nr doc-in-files-section 1
801 .      el .if    "\*[doc-str-dfp]"\*[doc-section-authors]" \
802 .        nr doc-in-authors-section 1
803 .      \}\}\}
804 .
805 .      in 0
806 .      nr doc-have-author 0
807 .    \}
808 .
809 .    doc-setup-page-layout
810 '    sp
811 .    ns
812 .    ta T .5i
813 .    if !\n[cR] \
814 .      ne 3
815 '    fi
816 .
817 .    if t \{\
818 .      nr doc-reg-Sh \n[.ss]
819 .      nr doc-reg-Sh1 \n[.sss]
820 .      ss (\n[.ss] * 5 / 3) (\n[.sss] * 5 / 3)
821 .    \}
822 .
823 .    nr doc-arg-ptr +1
824 .    nr doc-curr-font \n[.f]
825 .    nr doc-curr-size \n[.ps]
826 .    nop \*[doc-Sh-font]\c
827 .    doc-print-recursive
828 .
829 .    if t \
830 .      ss \n[doc-reg-Sh] \n[doc-reg-Sh1]
831 .
832 .    in +\n[doc-subheader-indent]u
833 .    ns
834 .  \}
835 ..
836 .
837 .
838 .\" NS Ss user macro (not callable)
839 .\" NS   subsection
840 .\" NS
841 .\" NS local variable:
842 .\" NS   doc-reg-Ss
843 .\" NS   doc-reg-Ss1
844 .\" NS
845 .\" NS width register `Ss' set above
846 .
847 .de Ss
848 .  ie \n[doc-arg-limit] \{\
849 .    \" we only allow `Ss' within `Ss'; it will change the font back to
850 .    \" `doc-Sh-font'
851 .    ie "\*[doc-macro-name]"Ss" \{\
852 .      nr doc-arg-ptr +1
853 .      ie (\n[doc-arg-limit] >= \n[doc-arg-ptr]) \{\
854 .        nr doc-curr-font \n[.f]
855 .        nr doc-curr-size \n[.ps]
856 .        nop \*[doc-Sh-font]\c
857 .        doc-print-recursive
858 .      \}
859 .      el \{\
860 .        tm Usage: .Ss subsection_name ... (#\n[.c])
861 .        doc-reset-args
862 .    \}\}
863 .    el \{\
864 .      tm Usage: .Ss not callable by other macros (#\n[.c])
865 .      doc-reset-args
866 .  \}\}
867 .  el \{\
868 .    if !\n[.$] \{\
869 .      tm Usage: .Ss subsection_name ... (#\n[.c])
870 .      return
871 .    \}
872 .
873 .    ds doc-macro-name Ss
874 .    doc-parse-args \$@
875 .
876 .    sp
877 .    if !\n[cR] \
878 .      ne 3
879 .    ti -.25i
880 .
881 .    nr doc-reg-Ss \n[.ss]
882 .    nr doc-reg-Ss1 \n[.sss]
883 .    ss (\n[.ss] * 5 / 4) (\n[.sss] * 5 / 4)
884 .
885 .    nr doc-arg-ptr +1
886 .    nr doc-curr-font \n[.f]
887 .    nr doc-curr-size \n[.ps]
888 .    nop \*[doc-Sh-font]\c
889 .    doc-print-recursive
890 .
891 .    ss \n[doc-reg-Ss] \n[doc-reg-Ss1]
892 .
893 .    ta T .5i
894 .    if !\n[cR] \
895 .      ne 2
896 .    br
897 .    ns
898 .  \}
899 ..
900 .
901 .
902 .\" NS Rd macro (not parsed, not callable)
903 .\" NS   print global register dump to stderr
904 .\" NS
905 .\" NS local variables:
906 .\" NS   doc-reg-Rd
907 .
908 .de Rd
909 .  tm MDOC GLOBAL REGISTER DUMP
910 .  tm doc-macro-name == `\*[doc-macro-name]'
911 .  tm doc-arg-limit == \n[doc-arg-limit]
912 .  tm doc-num-args == \n[doc-num-args]
913 .  tm doc-arg-ptr == \n[doc-arg-ptr]
914 .
915 .  nr doc-reg-Rd 1
916 .  while (\n[doc-reg-Rd] <= \n[doc-arg-limit]) \{\
917 .    tm doc-arg\n[doc-reg-Rd] == `\*[doc-arg\n[doc-reg-Rd]]'
918 .    tm doc-type\n[doc-reg-Rd] == \n[doc-type\n[doc-reg-Rd]]
919 .    tm doc-space\n[doc-reg-Rd] == `\*[doc-space\n[doc-reg-Rd]]'
920 .    nr doc-reg-Rd +1
921 .  \}
922 .
923 .  tm doc-curr-font == \n[doc-curr-font]
924 .  tm doc-curr-size == \n[doc-curr-size]
925 .  tm doc-indent-synopsis == \n[doc-indent-synopsis]
926 .  tm doc-indent-synopsis-active == \n[doc-indent-synopsis-active]
927 .  tm doc-have-decl == \n[doc-have-decl]
928 .  tm doc-have-var == \n[doc-have-var]
929 .  tm doc-command-name == `\*[doc-command-name]'
930 .  tm doc-quote-left == `\*[doc-quote-left]'
931 .  tm doc-quote-right == `\*[doc-quote-right]'
932 .  tm doc-nesting-level == \n[doc-nesting-level]
933 .  tm doc-in-list == \n[doc-in-list]
934 .  tm doc-space == `\*[doc-space]'
935 .  tm doc-saved-space == `\*[doc-saved-space]'
936 .  tm doc-space-mode == \n[doc-space-mode]
937 .  tm doc-have-space == \n[doc-have-space]
938 .  tm doc-have-slot == \n[doc-have-slot]
939 .  tm doc-keep-type == \n[doc-keep-type]
940 .  tm doc-display-depth == \n[doc-display-depth]
941 .  tm doc-is-compact == \n[doc-is-compact]
942 .
943 .  nr doc-reg-Rd 0
944 .  while (\n[doc-reg-Rd] <= \n[doc-display-depth]) \{\
945 .    tm doc-display-type-stack\n[doc-reg-Rd] == `\*[doc-display-type-stack\n[doc-reg-Rd]]'
946 .    tm doc-display-indent-stack\n[doc-reg-Rd] == \n[doc-display-indent-stack\n[doc-reg-Rd]]
947 .    tm doc-display-ad-stack\n[doc-reg-Rd] == \n[doc-display-ad-stack\n[doc-reg-Rd]]
948 .    tm doc-display-fi-stack\n[doc-reg-Rd] == \n[doc-display-fi-stack\n[doc-reg-Rd]]
949 .    tm doc-display-ft-stack\n[doc-reg-Rd] == \n[doc-display-ft-stack\n[doc-reg-Rd]]
950 .    tm doc-display-ps-stack\n[doc-reg-Rd] == \n[doc-display-ps-stack\n[doc-reg-Rd]]
951 .    nr doc-reg-Rd +1
952 .  \}
953 .
954 .  tm doc-fontmode-depth == \n[doc-fontmode-depth]
955 .
956 .  nr doc-reg-Rd 1
957 .  while (\n[doc-reg-Rd] <= \n[doc-fontmode-depth]) \{\
958 .    tm doc-fontmode-font-stack\n[doc-reg-Rd] == `\n[doc-fontmode-font-stack\n[doc-reg-Rd]]'
959 .    tm doc-fontmode-size-stack\n[doc-reg-Rd] == `\n[doc-fontmode-size-stack\n[doc-reg-Rd]]'
960 .    nr doc-reg-Rd +1
961 .  \}
962 .
963 .  tm doc-list-depth == \n[doc-list-depth]
964 .
965 .  nr doc-reg-Rd 1
966 .  while (\n[doc-reg-Rd] <= \n[doc-list-depth]) \{\
967 .    tm doc-list-type-stack\n[doc-reg-Rd] == `\*[doc-list-type-stack\n[doc-reg-Rd]]'
968 .    tm doc-list-have-indent-stack\n[doc-reg-Rd] == \n[doc-list-have-indent-stack\n[doc-reg-Rd]]
969 .    tm doc-list-indent-stack\n[doc-reg-Rd] == \n[doc-list-indent-stack\n[doc-reg-Rd]]
970 .    tm doc-compact-list-stack\n[doc-reg-Rd] == \n[doc-compact-list-stack\n[doc-reg-Rd]]
971 .    tm doc-tag-prefix-stack\n[doc-reg-Rd] == `\*[doc-tag-prefix-stack\n[doc-reg-Rd]]'
972 .    tm doc-tag-width-stack\n[doc-reg-Rd] == `\*[doc-tag-width-stack\n[doc-reg-Rd]]'
973 .    tm doc-list-offset-stack\n[doc-reg-Rd] == \n[doc-list-offset-stack\n[doc-reg-Rd]]
974 .    tm doc-enum-list-count-stack\n[doc-reg-Rd] == \n[doc-enum-list-count-stack\n[doc-reg-Rd]]
975 .    nr doc-reg-Rd +1
976 .  \}
977 .
978 .  tm doc-saved-Pa-font == `\*[doc-saved-Pa-font]'
979 .  tm doc-curr-type == \n[doc-curr-type]
980 .  tm doc-curr-arg == `\*[doc-curr-arg]'
981 .  tm doc-diag-list-input-line-count == \n[doc-diag-list-input-line-count]
982 .  tm doc-num-columns == \n[doc-num-columns]
983 .  tm doc-column-indent-width == \n[doc-column-indent-width]
984 .  tm doc-is-func == \n[doc-is-func]
985 .  tm doc-have-old-func == \n[doc-have-old-func]
986 .  tm doc-func-arg-count == \n[doc-func-arg-count]
987 .  tm doc-func-arg == `\*[doc-func-arg]'
988 .  tm doc-num-func-args == \n[doc-num-func-args]
989 .  tm doc-func-args-processed == \n[doc-func-args-processed]
990 .  tm doc-have-func == \n[doc-have-func]
991 .  tm doc-is-reference == \n[doc-is-reference]
992 .  tm doc-reference-count == \n[doc-reference-count]
993 .  tm doc-author-count == \n[doc-author-count]
994 .
995 .  nr doc-reg-Rd 0
996 .  while (\n[doc-reg-Rd] <= \n[doc-author-count]) \{\
997 .    tm doc-author-name\n[doc-reg-Rd] == `\*[doc-author-name\n[doc-reg-Rd]]'
998 .    nr doc-reg-Rd +1
999 .  \}
1000 .
1001 .  tm doc-book-count == \n[doc-book-count]
1002 .  tm doc-book-name == `\*[doc-book-name]'
1003 .  tm doc-date-count == \n[doc-date-count]
1004 .  tm doc-date == `\*[doc-date]'
1005 .  tm doc-publisher-count == \n[doc-publisher-count]
1006 .  tm doc-publisher-name == `\*[doc-publisher-name]'
1007 .  tm doc-journal-count == \n[doc-journal-count]
1008 .  tm doc-journal-name == `\*[doc-journal-name]'
1009 .  tm doc-issue-count == \n[doc-issue-count]
1010 .  tm doc-issue-name == `\*[doc-issue-name]'
1011 .  tm doc-optional-count == \n[doc-optional-count]
1012 .  tm doc-optional-string == `\*[doc-optional-string]'
1013 .  tm doc-page-number-count == \n[doc-page-number-count]
1014 .  tm doc-page-number-string == `\*[doc-page-number-string]'
1015 .  tm doc-corporate-count == \n[doc-corporate-count]
1016 .  tm doc-corporate-name == `\*[doc-corporate-name]'
1017 .  tm doc-report-count == \n[doc-report-count]
1018 .  tm doc-report-name == `\*[doc-report-name]'
1019 .  tm doc-reference-title-count == \n[doc-reference-title-count]
1020 .  tm doc-reference-title-name == `\*[doc-reference-title-name]'
1021 .  tm doc-reference-title-name-for-book == `\*[doc-reference-title-name-for-book]'
1022 .  tm doc-volume-count == \n[doc-volume-count]
1023 .  tm doc-volume-name == `\*[doc-volume-name]'
1024 .  tm doc-have-author == \n[doc-have-author]
1025 .
1026 .  tm doc-document-title == `\*[doc-document-title]'
1027 .  tm doc-volume == `\*[doc-volume]'
1028 .  tm doc-section == `\*[doc-section]'
1029 .  tm doc-operating-system == `\*[doc-operating-system]'
1030 .  tm doc-date-string == `\*[doc-date-string]'
1031 .  tm doc-header-space == \n[doc-header-space]
1032 .  tm doc-footer-space == \n[doc-footer-space]
1033 .  tm doc-display-vertical == \n[doc-display-vertical]
1034 .  tm doc-header-string == `\*[doc-header-string]'
1035 .  tm doc-in-synopsis-section == \n[doc-in-synopsis-section]
1036 .  tm doc-in-see-also-section == \n[doc-in-see-also-section]
1037 .  tm doc-in-files-section == \n[doc-in-files-section]
1038 .  tm doc-in-authors-section == \n[doc-in-authors-section]
1039 .
1040 .  tm END OF GLOBAL REGISTER DUMP
1041 ..
1042 .
1043 .
1044 .ec
1045 .
1046 .\" EOF