Sync: tmac/doc-common
[s-roff.git] / tmac / mdoc-common
blob56234479fd5b6291c87247c1b7ed4474538d8736
1 .\"@ mdoc-common
2 .\"@ Common strings, definitions, stuff related typographic output.
3 .\"@ See doc.tmac for more on the mdoc semantic markup language.
4 .\"
5 .\" Copyright (c) 1991, 1993
6 .\"     The Regents of the University of California.  All rights reserved.
7 .\"
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
10 .\" are met:
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\"    notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\"    notice, this list of conditions and the following disclaimer in the
15 .\"    documentation and/or other materials provided with the distribution.
16 .\" 3. [Deleted.  See
17 .\"     ftp://ftp.cs.berkeley.edu/pub/4bsd/README.Impt.License.Change]
18 .\" 4. Neither the name of the University nor the names of its contributors
19 .\"    may be used to endorse or promote products derived from this software
20 .\"    without specific prior written permission.
21 .\"
22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" SUCH DAMAGE.
33 .\"
34 .\"     @(#)doc-common  8.1 (Berkeley) 06/08/93
35 .\" Adapted to S-roff by Steffen (Daode) Nurpmeso <sdaoden@users.sf.net>.
36 .\"
37 .\"     %beginstrip%
40 .\" Macro Identifiers.  For each user macro a corresponding register with
41 .\" the same name must exist.  Its value must not be zero.
43 .nr %A 1
44 .nr %B 1
45 .nr %C 1
46 .nr %D 1
47 .nr %I 1
48 .nr %J 1
49 .nr %N 1
50 .nr %O 1
51 .nr %P 1
52 .nr %Q 1
53 .nr %R 1
54 .nr %T 1
55 .nr %U 1
56 .nr %V 1
57 .nr Ac 3
58 .nr Ad 12n
59 .nr An 12n
60 .nr Ao 12n
61 .nr Ap 2
62 .nr Aq 12n
63 .nr Ar 12n
64 .nr At 1
65 .nr Bc 3
66 .nr Bf 8n\" ?
67 .nr Bk 8n\" ?
68 .nr Bl 1
69 .nr Bo 12n
70 .nr Bq 12n
71 .nr Brc 3
72 .nr Bro 12n
73 .nr Brq 12n
74 .nr Bsx 1
75 .nr Bt 8n\" ?
76 .nr Bx 1
77 .nr Cd 12n
78 .nr Cm 10n
79 .nr D1 8n\" ?
80 .nr Dc 3
81 .nr Dl 8n\" ?
82 .nr Dt 8n\" ?
83 .nr Do 12n
84 .nr Dq 12n
85 .nr Ds 6n\" many manpages still use this as a -width value
86 .nr Dv 12n
87 .nr Dx 1
88 .nr Ec 3
89 .nr Ef 8n\" ?
90 .nr Ek 8n\" ?
91 .nr El 1
92 .nr Em 10n
93 .nr En 12n
94 .nr Eo 12n
95 .nr Eq 12n
96 .nr Er 17n
97 .nr Es 12n
98 .nr Ev 15n
99 .nr Ex 1
100 .nr Fa 12n
101 .nr Fc 3
102 .nr Fd 12n\" ?
103 .nr Fl 10n
104 .nr Fn 16n
105 .nr Fo 16n
106 .nr Fr 12n\" ?
107 .nr Ft 8n\" ?
108 .nr Fx 1
109 .nr Ic 10n
110 .nr In 12n
111 .nr It 8n\" ?
112 .nr Lb 11n
113 .nr Li 16n
114 .nr Lk 6n\" ?
115 .nr Lp 8n\" ?
116 .nr Me 6n
117 .nr Ms 6n
118 .nr Mt 6n\" ?
119 .nr Nd 8n\" ?
120 .nr Nm 10n
121 .nr No 12n
122 .nr Ns 2
123 .nr Nx 1
124 .nr Oc 3
125 .nr Oo 10n
126 .nr Op 14n
127 .nr Os 6n\" ?
128 .nr Ox 1
129 .nr Pa 32n
130 .nr Pc 3
131 .nr Pf 12n
132 .nr Po 12n
133 .nr Pp 8n\" ?
134 .nr Pq 12n
135 .nr Qc 3
136 .nr Ql 16n
137 .nr Qo 12n
138 .nr Qq 12n
139 .nr Rv 1
140 .nr Sc 3
141 .nr Sh 8n
142 .nr Sm 8n\" ?
143 .nr So 12n
144 .nr Sq 12n
145 .nr Ss 8n
146 .nr St 8n\" ?
147 .nr Sx 16n
148 .nr Sy 6n
149 .nr Ta 2
150 .nr Tn 10n
151 .nr Ud 8n\" ?
152 .nr Ux 1
153 .nr Va 12n
154 .nr Vt 8n\" ?
155 .nr Xc 3
156 .nr Xo 1
157 .nr Xr 10n
160 .\" macros which must be processed after the closing delimiter of `Op'
161 .\" and friends
162 .ds doc-after-Ao
163 .ds doc-after-Bo
164 .ds doc-after-Bro
165 .ds doc-after-Do
166 .ds doc-after-Eo
167 .ds doc-after-Fo
168 .ds doc-after-Ns
169 .ds doc-after-Oo
170 .ds doc-after-Po
171 .ds doc-after-Qo
172 .ds doc-after-So
173 .ds doc-after-Xo
176 .nr doc-display-indent 6n
179 .\" space strings
181 .ds doc-soft-space " \"
182 .ds doc-hard-space \~
183 .ds doc-tab \t
189 .\" punctuation values (suffix=3, prefix=4)
191 .nr doc-punct. 3
192 .nr doc-punct, 3
193 .nr doc-punct: 3
194 .nr doc-punct; 3
195 .nr doc-punct( 4
196 .nr doc-punct) 3
197 .nr doc-punct[ 4
198 .nr doc-punct] 3
199 .nr doc-punct? 3
200 .nr doc-punct! 3
203 .\" header assembly macros
205 .\" NS doc-document-title global string
206 .\" NS   the title of the manual page
208 .ds doc-document-title UNTITLED
211 .\" NS doc-volume global string
212 .\" NS   the volume where the manual page belongs to
214 .ds doc-volume LOCAL
217 .\" NS doc-section global string
218 .\" NS   the manual section
220 .ds doc-section Null
223 .\" NS Dt user macro (not parsed, not callable)
224 .\" NS   document title
225 .\" NS
226 .\" NS modifies:
227 .\" NS   doc-document-title
228 .\" NS   doc-section
229 .\" NS   doc-volume
230 .\" NS   doc-command-name
231 .\" NS
232 .\" NS local variables:
233 .\" NS   doc-volume-as-XXX
234 .\" NS   doc-volume-ds-XXX
235 .\" NS
236 .\" NS width register `Dt' set above
238 .\" an alternative, more detailed scheme for naming the manual sections
240 .ds doc-volume-operating-system BSD
241 .nr doc-volume-operating-system-ateol 0
242 .ds doc-volume-ds-1 General Commands Manual
243 .ds doc-volume-ds-2 System Calls Manual
244 .ds doc-volume-ds-3 Library Functions Manual
245 .ds doc-volume-ds-4 Kernel Interfaces Manual
246 .ds doc-volume-ds-5 File Formats Manual
247 .ds doc-volume-ds-6 Games Manual
248 .ds doc-volume-ds-7 Miscellaneous Information Manual
249 .ds doc-volume-ds-8 System Manager's Manual
250 .ds doc-volume-ds-9 Kernel Developer's Manual
252 .ds doc-volume-ds-USD   User's Supplementary Documents
253 .ds doc-volume-ds-PS1   Programmer's Supplementary Documents
254 .ds doc-volume-ds-AMD   Ancestral Manual Documents
255 .ds doc-volume-ds-SMM   System Manager's Manual
256 .ds doc-volume-ds-URM   User's Reference Manual
257 .ds doc-volume-ds-PRM   Programmer's Manual
258 .ds doc-volume-ds-KM    Kernel Manual
259 .ds doc-volume-ds-IND   Manual Master Index
260 .ds doc-volume-ds-LOCAL Local Manual
261 .ds doc-volume-ds-CON   Contributed Software Manual
263 .als doc-volume-ds-MMI doc-volume-ds-IND
264 .als doc-volume-ds-LOC doc-volume-ds-LOCAL
266 .ds doc-volume-as-alpha        alpha
267 .als doc-volume-as-Alpha doc-volume-as-alpha
268 .ds doc-volume-as-acorn26      acorn26
269 .ds doc-volume-as-acorn32      acorn32
270 .ds doc-volume-as-algor        algor
271 .ds doc-volume-as-amd64        amd64
272 .ds doc-volume-as-amiga        amiga
273 .ds doc-volume-as-amigappc     amigappc
274 .ds doc-volume-as-arc          arc
275 .ds doc-volume-as-arm          arm
276 .ds doc-volume-as-arm26        arm26
277 .ds doc-volume-as-arm32        arm32
278 .ds doc-volume-as-armish       armish
279 .ds doc-volume-as-atari        atari
280 .ds doc-volume-as-aviion       aviion
281 .ds doc-volume-as-beagle       beagle
282 .ds doc-volume-as-bebox        bebox
283 .ds doc-volume-as-cats         cats
284 .ds doc-volume-as-cesfic       cesfic
285 .ds doc-volume-as-cobalt       cobalt
286 .ds doc-volume-as-dreamcast    dreamcast
287 .ds doc-volume-as-emips        emips
288 .ds doc-volume-as-evbarm       evbarm
289 .ds doc-volume-as-evbmips      evbmips
290 .ds doc-volume-as-evbppc       evbppc
291 .ds doc-volume-as-evbsh3       evbsh3
292 .ds doc-volume-as-ews4800mips  ews4800mips
293 .ds doc-volume-as-hp300        hp300
294 .ds doc-volume-as-hp700        hp700
295 .ds doc-volume-as-hpcarm       hpcarm
296 .ds doc-volume-as-hpcmips      hpcmips
297 .ds doc-volume-as-hpcsh        hpcsh
298 .ds doc-volume-as-hppa         hppa
299 .ds doc-volume-as-hppa64       hppa64
300 .ds doc-volume-as-i386         i386
301 .ds doc-volume-as-ia64         ia64
302 .ds doc-volume-as-ibmnws       ibmnws
303 .ds doc-volume-as-iyonix       iyonix
304 .ds doc-volume-as-landisk      landisk
305 .ds doc-volume-as-loongson     loongson
306 .ds doc-volume-as-luna68k      luna68k
307 .ds doc-volume-as-luna88k      luna88k
308 .ds doc-volume-as-m68k         m68k
309 .ds doc-volume-as-mac68k       mac68k
310 .ds doc-volume-as-macppc       macppc
311 .ds doc-volume-as-mips         mips
312 .ds doc-volume-as-mips64       mips64
313 .ds doc-volume-as-mipsco       mipsco
314 .ds doc-volume-as-mmeye        mmeye
315 .ds doc-volume-as-mvme68k      mvme68k
316 .ds doc-volume-as-mvme88k      mvme88k
317 .ds doc-volume-as-mvmeppc      mvmeppc
318 .ds doc-volume-as-netwinder    netwinder
319 .ds doc-volume-as-news68k      news68k
320 .ds doc-volume-as-newsmips     newsmips
321 .ds doc-volume-as-next68k      next68k
322 .ds doc-volume-as-ofppc        ofppc
323 .ds doc-volume-as-palm         palm
324 .ds doc-volume-as-pc532        pc532
325 .ds doc-volume-as-playstation2 playstation2
326 .ds doc-volume-as-pmax         pmax
327 .ds doc-volume-as-pmppc        pmppc
328 .ds doc-volume-as-powerpc      powerpc
329 .ds doc-volume-as-prep         prep
330 .ds doc-volume-as-rs6000       rs6000
331 .ds doc-volume-as-sandpoint    sandpoint
332 .ds doc-volume-as-sbmips       sbmips
333 .ds doc-volume-as-sgi          sgi
334 .ds doc-volume-as-sgimips      sgimips
335 .ds doc-volume-as-sh3          sh3
336 .ds doc-volume-as-shark        shark
337 .ds doc-volume-as-socppc       socppc
338 .ds doc-volume-as-solbourne    solbourne
339 .ds doc-volume-as-sparc        sparc
340 .ds doc-volume-as-sparc64      sparc64
341 .ds doc-volume-as-sun2         sun2
342 .ds doc-volume-as-sun3         sun3
343 .ds doc-volume-as-tahoe        tahoe
344 .ds doc-volume-as-vax          vax
345 .ds doc-volume-as-x68k         x68k
346 .ds doc-volume-as-x86_64       x86_64
347 .ds doc-volume-as-xen          xen
348 .ds doc-volume-as-zaurus       zaurus
350 .de Dt
351 .  \" reset default arguments
352 .  ds doc-document-title UNTITLED
353 .  ds doc-volume LOCAL
354 .  ds doc-section Null
355 .  ds doc-command-name
357 .  if !"\$1"" \
358 .    ds doc-document-title "\$1
360 .  if !"\$2"" \{\
361 .    ds doc-section \$2
362 .    ie \B\a\$2\a \{\
363 .      if ((\$2 >= 1) & (\$2 <= 9)) \{\
364 .        ie \n[doc-volume-operating-system-ateol] \{\
365 .          ds doc-volume "\*[doc-volume-ds-\$2] \*[doc-volume-operating-system]
366 .          if \A\a\$3\a \{\
367 .            if d doc-volume-as-\$3 \
368 .              as doc-volume "/\*[doc-volume-as-\$3]
369 .        \}\}
370 .        el \{\
371 .          ds doc-volume "\*[doc-volume-operating-system]
372 .          if \A\a\$3\a \{\
373 .            if d doc-volume-as-\$3 \
374 .              as doc-volume "/\*[doc-volume-as-\$3]
375 .          \}
376 .          as doc-volume " \*[doc-volume-ds-\$2]
377 .    \}\}\}
378 .    el \{\
379 .      ie "\$2"unass" \
380 .        ds doc-volume DRAFT
381 .      el \{ .ie "\$2"draft" \
382 .        ds doc-volume DRAFT
383 .      el .if "\$2"paper" \
384 .        ds doc-volume UNTITLED
385 .      \}\}
386 .      if \A\a\$3\a \{\
387 .        if d doc-volume-ds-\$3 \
388 .          ds doc-volume "\*[doc-volume-ds-\$3]
389 .  \}\}\}
391 .  if !"\$3"" \
392 .    if "\*[doc-volume]"LOCAL" \
393 .      ds doc-volume \$3
395 .  if !\n[cR] \
396 .    if \n[nl] \{\
397   .    doc-setup-header
398 .      bp
399 .    \}
403 .\" NS doc-default-operating-system global string
404 .\" NS   the exact (default) version of the operating system
405 .\" NS
406 .\" NS override this in `mdoc.local', if necessary
408 .ds doc-default-operating-system BSD
411 .\" NS doc-operating-system global string
412 .\" NS   the exact version of the operating system
414 .ds doc-operating-system
417 .\" NS Os user macro (not parsed, not callable)
418 .\" NS   operating system
419 .\" NS
420 .\" NS modifies:
421 .\" NS   doc-operating-system
422 .\" NS   doc-command-name
423 .\" NS
424 .\" NS local variables:
425 .\" NS   doc-operating-system-XXX-XXX
426 .\" NS
427 .\" NS width register `Os' set above
429 .ds doc-operating-system-ATT-7   7th\~Edition
430 .als doc-operating-system-ATT-7th doc-operating-system-ATT-7
431 .ds doc-operating-system-ATT-3   System\~III
432 .als doc-operating-system-ATT-III doc-operating-system-ATT-3
433 .ds doc-operating-system-ATT-V   System\~V
434 .ds doc-operating-system-ATT-V.2 System\~V Release\~2
435 .ds doc-operating-system-ATT-V.3 System\~V Release\~3
436 .ds doc-operating-system-ATT-V.4 System\~V Release\~4
438 .ds doc-operating-system-BSD-3    3rd\~Berkeley Distribution
439 .ds doc-operating-system-BSD-4    4th\~Berkeley Distribution
440 .ds doc-operating-system-BSD-4.1  4.1\~Berkeley Distribution
441 .ds doc-operating-system-BSD-4.2  4.2\~Berkeley Distribution
442 .ds doc-operating-system-BSD-4.3  4.3\~Berkeley Distribution
443 .ds doc-operating-system-BSD-4.3T 4.3-Tahoe Berkeley Distribution
444 .ds doc-operating-system-BSD-4.3R 4.3-Reno Berkeley Distribution
445 .als doc-operating-system-BSD-4.3t doc-operating-system-BSD-4.3T
446 .als doc-operating-system-BSD-4.3r doc-operating-system-BSD-4.3R
447 .ds doc-operating-system-BSD-4.4  4.4BSD
449 .ds doc-operating-system-NetBSD-0.8   0.8
450 .ds doc-operating-system-NetBSD-0.8a  0.8A
451 .ds doc-operating-system-NetBSD-0.9   0.9
452 .ds doc-operating-system-NetBSD-0.9a  0.9A
453 .ds doc-operating-system-NetBSD-1.0   1.0
454 .ds doc-operating-system-NetBSD-1.0a  1.0A
455 .ds doc-operating-system-NetBSD-1.1   1.1
456 .ds doc-operating-system-NetBSD-1.2   1.2
457 .ds doc-operating-system-NetBSD-1.2a  1.2A
458 .ds doc-operating-system-NetBSD-1.2b  1.2B
459 .ds doc-operating-system-NetBSD-1.2c  1.2C
460 .ds doc-operating-system-NetBSD-1.2d  1.2D
461 .ds doc-operating-system-NetBSD-1.2e  1.2E
462 .ds doc-operating-system-NetBSD-1.3   1.3
463 .ds doc-operating-system-NetBSD-1.3a  1.3A
464 .ds doc-operating-system-NetBSD-1.4   1.4
465 .ds doc-operating-system-NetBSD-1.4.1 1.4.1
466 .ds doc-operating-system-NetBSD-1.4.2 1.4.2
467 .ds doc-operating-system-NetBSD-1.4.3 1.4.3
468 .ds doc-operating-system-NetBSD-1.5   1.5
469 .ds doc-operating-system-NetBSD-1.5.1 1.5.1
470 .ds doc-operating-system-NetBSD-1.5.2 1.5.2
471 .ds doc-operating-system-NetBSD-1.5.3 1.5.3
472 .ds doc-operating-system-NetBSD-1.6   1.6
473 .ds doc-operating-system-NetBSD-1.6.1 1.6.1
474 .ds doc-operating-system-NetBSD-1.6.2 1.6.2
475 .ds doc-operating-system-NetBSD-1.6.3 1.6.3
476 .ds doc-operating-system-NetBSD-2.0   2.0
477 .ds doc-operating-system-NetBSD-2.0.1 2.0.1
478 .ds doc-operating-system-NetBSD-2.0.2 2.0.2
479 .ds doc-operating-system-NetBSD-2.0.3 2.0.3
480 .ds doc-operating-system-NetBSD-2.1   2.1
481 .ds doc-operating-system-NetBSD-3.0   3.0
482 .ds doc-operating-system-NetBSD-3.0.1 3.0.1
483 .ds doc-operating-system-NetBSD-3.0.2 3.0.2
484 .ds doc-operating-system-NetBSD-3.0.3 3.0.3
485 .ds doc-operating-system-NetBSD-3.1   3.1
486 .ds doc-operating-system-NetBSD-3.1.1 3.1.1
487 .ds doc-operating-system-NetBSD-4.0   4.0
488 .ds doc-operating-system-NetBSD-4.0.1 4.0.1
489 .ds doc-operating-system-NetBSD-5.0   5.0
490 .ds doc-operating-system-NetBSD-5.0.1 5.0.1
491 .ds doc-operating-system-NetBSD-5.0.2 5.0.2
492 .ds doc-operating-system-NetBSD-5.1   5.1
493 .ds doc-operating-system-NetBSD-5.1.2 5.1.2
494 .ds doc-operating-system-NetBSD-5.1.3 5.1.3
495 .ds doc-operating-system-NetBSD-5.2   5.2
496 .ds doc-operating-system-NetBSD-5.2.1 5.2.1
497 .ds doc-operating-system-NetBSD-6.0   6.0
498 .ds doc-operating-system-NetBSD-6.0.1 6.0.1
499 .ds doc-operating-system-NetBSD-6.0.2 6.0.2
500 .ds doc-operating-system-NetBSD-6.0.3 6.0.3
501 .ds doc-operating-system-NetBSD-6.1   6.1
503 .ds doc-operating-system-OpenBSD-2.0  2.0
504 .ds doc-operating-system-OpenBSD-2.1  2.1
505 .ds doc-operating-system-OpenBSD-2.2  2.2
506 .ds doc-operating-system-OpenBSD-2.3  2.3
507 .ds doc-operating-system-OpenBSD-2.4  2.4
508 .ds doc-operating-system-OpenBSD-2.5  2.5
509 .ds doc-operating-system-OpenBSD-2.6  2.6
510 .ds doc-operating-system-OpenBSD-2.7  2.7
511 .ds doc-operating-system-OpenBSD-2.8  2.8
512 .ds doc-operating-system-OpenBSD-2.9  2.9
513 .ds doc-operating-system-OpenBSD-3.0  3.0
514 .ds doc-operating-system-OpenBSD-3.1  3.1
515 .ds doc-operating-system-OpenBSD-3.2  3.2
516 .ds doc-operating-system-OpenBSD-3.3  3.3
517 .ds doc-operating-system-OpenBSD-3.4  3.4
518 .ds doc-operating-system-OpenBSD-3.5  3.5
519 .ds doc-operating-system-OpenBSD-3.6  3.6
520 .ds doc-operating-system-OpenBSD-3.7  3.7
521 .ds doc-operating-system-OpenBSD-3.8  3.8
522 .ds doc-operating-system-OpenBSD-3.9  3.9
523 .ds doc-operating-system-OpenBSD-4.0  4.0
524 .ds doc-operating-system-OpenBSD-4.1  4.1
525 .ds doc-operating-system-OpenBSD-4.2  4.2
526 .ds doc-operating-system-OpenBSD-4.3  4.3
527 .ds doc-operating-system-OpenBSD-4.4  4.4
528 .ds doc-operating-system-OpenBSD-4.5  4.5
529 .ds doc-operating-system-OpenBSD-4.6  4.6
530 .ds doc-operating-system-OpenBSD-4.7  4.7
531 .ds doc-operating-system-OpenBSD-4.8  4.8
532 .ds doc-operating-system-OpenBSD-4.9  4.9
533 .ds doc-operating-system-OpenBSD-5.0  5.0
534 .ds doc-operating-system-OpenBSD-5.1  5.1
535 .ds doc-operating-system-OpenBSD-5.2  5.2
536 .ds doc-operating-system-OpenBSD-5.3  5.3
537 .ds doc-operating-system-OpenBSD-5.4  5.4
539 .ds doc-operating-system-FreeBSD-1.0     1.0
540 .ds doc-operating-system-FreeBSD-1.1     1.1
541 .ds doc-operating-system-FreeBSD-1.1.5   1.1.5
542 .ds doc-operating-system-FreeBSD-1.1.5.1 1.1.5.1
543 .ds doc-operating-system-FreeBSD-2.0     2.0
544 .ds doc-operating-system-FreeBSD-2.0.5   2.0.5
545 .ds doc-operating-system-FreeBSD-2.1     2.1
546 .ds doc-operating-system-FreeBSD-2.1.5   2.1.5
547 .ds doc-operating-system-FreeBSD-2.1.6   2.1.6
548 .ds doc-operating-system-FreeBSD-2.1.7   2.1.7
549 .ds doc-operating-system-FreeBSD-2.2     2.2
550 .ds doc-operating-system-FreeBSD-2.2.1   2.2.1
551 .ds doc-operating-system-FreeBSD-2.2.2   2.2.2
552 .ds doc-operating-system-FreeBSD-2.2.5   2.2.5
553 .ds doc-operating-system-FreeBSD-2.2.6   2.2.6
554 .ds doc-operating-system-FreeBSD-2.2.7   2.2.7
555 .ds doc-operating-system-FreeBSD-2.2.8   2.2.8
556 .ds doc-operating-system-FreeBSD-2.2.9   2.2.9
557 .ds doc-operating-system-FreeBSD-3.0     3.0
558 .ds doc-operating-system-FreeBSD-3.1     3.1
559 .ds doc-operating-system-FreeBSD-3.2     3.2
560 .ds doc-operating-system-FreeBSD-3.3     3.3
561 .ds doc-operating-system-FreeBSD-3.4     3.4
562 .ds doc-operating-system-FreeBSD-3.5     3.5
563 .ds doc-operating-system-FreeBSD-4.0     4.0
564 .ds doc-operating-system-FreeBSD-4.1     4.1
565 .ds doc-operating-system-FreeBSD-4.1.1   4.1.1
566 .ds doc-operating-system-FreeBSD-4.2     4.2
567 .ds doc-operating-system-FreeBSD-4.3     4.3
568 .ds doc-operating-system-FreeBSD-4.4     4.4
569 .ds doc-operating-system-FreeBSD-4.5     4.5
570 .ds doc-operating-system-FreeBSD-4.6     4.6
571 .ds doc-operating-system-FreeBSD-4.6.2   4.6.2
572 .ds doc-operating-system-FreeBSD-4.7     4.7
573 .ds doc-operating-system-FreeBSD-4.8     4.8
574 .ds doc-operating-system-FreeBSD-4.9     4.9
575 .ds doc-operating-system-FreeBSD-4.10    4.10
576 .ds doc-operating-system-FreeBSD-4.11    4.11
577 .ds doc-operating-system-FreeBSD-5.0     5.0
578 .ds doc-operating-system-FreeBSD-5.1     5.1
579 .ds doc-operating-system-FreeBSD-5.2     5.2
580 .ds doc-operating-system-FreeBSD-5.2.1   5.2.1
581 .ds doc-operating-system-FreeBSD-5.3     5.3
582 .ds doc-operating-system-FreeBSD-5.4     5.4
583 .ds doc-operating-system-FreeBSD-5.5     5.5
584 .ds doc-operating-system-FreeBSD-6.0     6.0
585 .ds doc-operating-system-FreeBSD-6.1     6.1
586 .ds doc-operating-system-FreeBSD-6.2     6.2
587 .ds doc-operating-system-FreeBSD-6.3     6.3
588 .ds doc-operating-system-FreeBSD-6.4     6.4
589 .ds doc-operating-system-FreeBSD-7.0     7.0
590 .ds doc-operating-system-FreeBSD-7.1     7.1
591 .ds doc-operating-system-FreeBSD-7.2     7.2
592 .ds doc-operating-system-FreeBSD-7.3     7.3
593 .ds doc-operating-system-FreeBSD-8.0     8.0
594 .ds doc-operating-system-FreeBSD-8.1     8.1
595 .ds doc-operating-system-FreeBSD-8.2     8.2
596 .ds doc-operating-system-FreeBSD-9.0     9.0
597 .ds doc-operating-system-FreeBSD-10.0    10.0
599 .ds doc-operating-system-Darwin-8.0.0  8.0.0
600 .ds doc-operating-system-Darwin-8.1.0  8.1.0
601 .ds doc-operating-system-Darwin-8.2.0  8.2.0
602 .ds doc-operating-system-Darwin-8.3.0  8.3.0
603 .ds doc-operating-system-Darwin-8.4.0  8.4.0
604 .ds doc-operating-system-Darwin-8.5.0  8.5.0
605 .ds doc-operating-system-Darwin-8.6.0  8.6.0
606 .ds doc-operating-system-Darwin-8.7.0  8.7.0
607 .ds doc-operating-system-Darwin-8.8.0  8.8.0
608 .ds doc-operating-system-Darwin-8.9.0  8.9.0
609 .ds doc-operating-system-Darwin-8.10.0 8.10.0
610 .ds doc-operating-system-Darwin-8.11.0 8.11.0
611 .ds doc-operating-system-Darwin-9.0.0  9.0.0
612 .ds doc-operating-system-Darwin-9.1.0  9.1.0
613 .ds doc-operating-system-Darwin-9.2.0  9.2.0
614 .ds doc-operating-system-Darwin-9.3.0  9.3.0
615 .ds doc-operating-system-Darwin-9.4.0  9.4.0
616 .ds doc-operating-system-Darwin-9.5.0  9.5.0
617 .ds doc-operating-system-Darwin-9.6.0  9.6.0
618 .ds doc-operating-system-Darwin-9.7.0  9.7.0
619 .ds doc-operating-system-Darwin-9.8.0  9.8.0
620 .ds doc-operating-system-Darwin-10.1.0 10.1.0
621 .ds doc-operating-system-Darwin-10.2.0 10.2.0
622 .ds doc-operating-system-Darwin-10.3.0 10.3.0
623 .ds doc-operating-system-Darwin-10.4.0 10.4.0
624 .ds doc-operating-system-Darwin-10.5.0 10.5.0
625 .ds doc-operating-system-Darwin-10.6.0 10.6.0
626 .ds doc-operating-system-Darwin-10.7.0 10.7.0
627 .ds doc-operating-system-Darwin-11.0.0 11.0.0
629 .ds doc-operating-system-DragonFly-1.0    1.0
630 .ds doc-operating-system-DragonFly-1.1    1.1
631 .ds doc-operating-system-DragonFly-1.2    1.2
632 .ds doc-operating-system-DragonFly-1.3    1.3
633 .ds doc-operating-system-DragonFly-1.4    1.4
634 .ds doc-operating-system-DragonFly-1.5    1.5
635 .ds doc-operating-system-DragonFly-1.6    1.6
636 .ds doc-operating-system-DragonFly-1.7    1.7
637 .ds doc-operating-system-DragonFly-1.8    1.8
638 .ds doc-operating-system-DragonFly-1.8.1  1.8.1
639 .ds doc-operating-system-DragonFly-1.9    1.9
640 .ds doc-operating-system-DragonFly-1.10   1.10
641 .ds doc-operating-system-DragonFly-1.11   1.11
642 .ds doc-operating-system-DragonFly-1.12   1.12
643 .ds doc-operating-system-DragonFly-1.12.2 1.12.2
644 .ds doc-operating-system-DragonFly-1.13   1.13
645 .ds doc-operating-system-DragonFly-2.0    2.0
646 .ds doc-operating-system-DragonFly-2.1    2.1
647 .ds doc-operating-system-DragonFly-2.2    2.2
648 .ds doc-operating-system-DragonFly-2.3    2.3
649 .ds doc-operating-system-DragonFly-2.4    2.4
650 .ds doc-operating-system-DragonFly-2.5    2.5
651 .ds doc-operating-system-DragonFly-2.6    2.6
652 .ds doc-operating-system-DragonFly-2.7    2.7
653 .ds doc-operating-system-DragonFly-2.8    2.8
654 .ds doc-operating-system-DragonFly-2.9    2.9
655 .ds doc-operating-system-DragonFly-2.9.1  2.9.1
656 .ds doc-operating-system-DragonFly-2.10   2.10
657 .ds doc-operating-system-DragonFly-2.10.1 2.10.1
658 .ds doc-operating-system-DragonFly-2.11   2.11
659 .ds doc-operating-system-DragonFly-3.0    3.0
660 .ds doc-operating-system-DragonFly-3.1    3.1
661 .ds doc-operating-system-DragonFly-3.2    3.2
662 .ds doc-operating-system-DragonFly-3.3    3.3
663 .ds doc-operating-system-DragonFly-3.4    3.4
664 .ds doc-operating-system-DragonFly-3.5    3.5
665 .ds doc-operating-system-DragonFly-3.6    3.6
666 .ds doc-operating-system-DragonFly-3.7    3.7
668 .de Os
669 .  ds doc-command-name
671 .  ie "\$1"" \
672 .    ds doc-operating-system "\*[doc-default-operating-system]
673 .  el \{ .ie "\$1"ATT" \{\
674 .    ds doc-operating-system AT&T
675 .    if \A\a\$2\a \{\
676 .      ie d doc-operating-system-ATT-\$2 \
677 .        as doc-operating-system " \*[doc-operating-system-ATT-\$2]
678 .      el \
679 .        as doc-operating-system " UNIX
680 .  \}\}
681 .  el \{ .ie "\$1"BSD" \{\
682 .    if \A\a\$2\a \{\
683 .      ie d doc-operating-system-BSD-\$2 \
684 .        ds doc-operating-system "\*[doc-operating-system-BSD-\$2]
685 .      el \
686 .        tm mdoc warning: .Os: Unknown BSD version `\$2' (#\n[.c])
687 .  \}\}
688 .  el \{ .ie "\$1"FreeBSD" \{\
689 .    ds doc-operating-system FreeBSD
690 .    if \A\a\$2\a \{\
691 .      ie d doc-operating-system-FreeBSD-\$2 \
692 .        as doc-operating-system \~\*[doc-operating-system-FreeBSD-\$2]
693 .      el \
694 .        tm mdoc warning: .Os: Unknown FreeBSD version `\$2' (#\n[.c])
695 .  \}\}
696 .  el \{ .ie "\$1"DragonFly" \{\
697 .    ds doc-operating-system DragonFly
698 .    if \A\a\$2\a \{\
699 .      ie d doc-operating-system-DragonFly-\$2 \
700 .        as doc-operating-system \~\*[doc-operating-system-DragonFly-\$2]
701 .      el \
702 .        tm mdoc warning: .Os: Unknown DragonFly version `\$2' (#\n[.c])
703 .  \}\}
704 .  el \{ .ie "\$1"NetBSD" \{\
705 .    ds doc-operating-system NetBSD
706 .    if \A\a\$2\a \{\
707 .      ie d doc-operating-system-NetBSD-\$2 \
708 .        as doc-operating-system \~\*[doc-operating-system-NetBSD-\$2]
709 .      el \
710 .        tm mdoc warning: .Os: Unknown NetBSD version `\$2' (#\n[.c])
711 .  \}\}
712 .  el \{ .ie "\$1"OpenBSD" \{\
713 .    ds doc-operating-system OpenBSD
714 .    if \A\a\$2\a \{\
715 .      ie d doc-operating-system-OpenBSD-\$2 \
716 .        as doc-operating-system \~\*[doc-operating-system-OpenBSD-\$2]
717 .      el \
718 .        tm mdoc warning: .Os: Unknown OpenBSD version `\$2' (#\n[.c])
719 .  \}\}
720 .  el \{ .ie "\$1"Darwin" \{\
721 .    ds doc-operating-system Darwin
722 .    if \A\a\$2\a \{\
723 .      ie d doc-operating-system-Darwin-\$2 \
724 .        as doc-operating-system \~\*[doc-operating-system-Darwin-\$2]
725 .      el \
726 .        tm mdoc warning: .Os: Unknown Darwin version `\$2' (#\n[.c])
727 .  \}\}
728 .  el \{\
729 .    ds doc-operating-system \$1
730 .    if !"\$2"" \
731 .      as doc-operating-system " \$2
732 .  \}\}\}\}\}\}\}\}
736 .\" NS doc-date-string global string
737 .\" NS   the manual page date as set by `Dd'
739 .ds doc-date-string
742 .\" NS Dd user macro (not parsed, not callable)
743 .\" NS   set document date
744 .\" NS
745 .\" NS modifies:
746 .\" NS   doc-date-string
747 .\" NS   doc-command-name
748 .\" NS
749 .\" NS local variables:
750 .\" NS   doc-date-XXX
751 .\" NS
752 .\" NS width register `Dd' set above
754 .ds doc-date-1  January
755 .ds doc-date-2  February
756 .ds doc-date-3  March
757 .ds doc-date-4  April
758 .ds doc-date-5  May
759 .ds doc-date-6  June
760 .ds doc-date-7  July
761 .ds doc-date-8  August
762 .ds doc-date-9  September
763 .ds doc-date-10 October
764 .ds doc-date-11 November
765 .ds doc-date-12 December
767 .de Dd
768 .  ds doc-command-name
770 .  ie \n[.$] \{\
771 .    ie (\n[.$] == 3) \
772 .      ds doc-date-string \$1\~\$2 \$3
773 .    el \{\
774 .      ds doc-date-string "\*[doc-date-\n[mo]]
775 .      as doc-date-string \~\n[dy], \n[year]
776 .    \}
777 .  \}
778 .  el \
779 .    ds doc-date-string Epoch
783 .\" NS doc-hyphen-flags global register
784 .\" NS   the parameter for the `.hy' request
785 .\" NS
786 .\" NS override this in `mdoc.local', if necessary.
788 .nr doc-hyphen-flags 12
791 .\" NS doc-header macro
792 .\" NS   print page header
793 .\" NS
794 .\" NS local variables:
795 .\" NS   doc-reg-dh
796 .\" NS   doc-reg-dh1
798 .de doc-header
799 .  ev doc-env-dh
800 .  doc-setup-page-layout
801 .  if !\n[cR] \
802 .    sp \n[doc-header-space]u
803 .  nr doc-reg-dh \w'\*[doc-caption-font]\*[doc-header-string]\f[]'
804 .  nr doc-reg-dh1 \w'\*[doc-caption-font2]\*[doc-volume]\f[]'
805 .  if (\n[doc-reg-dh] + \n[doc-reg-dh1] + \n[doc-reg-dh] >= \n[.lt]) \{\
806 .    while (\n[doc-reg-dh] + \n[doc-reg-dh1] + \n[doc-reg-dh] >= \n[.lt]) \{\
807 .      substring doc-header-string 0 -2
808 .      nr doc-reg-dh \w'\*[doc-caption-font]\*[doc-header-string]\|.\|.\|.\f[]'
809 .    \}
810 .    as doc-header-string "\|.\|.\|.
811 .  \}
812 .  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
813 .  ie !\n[cR] \
814 .    sp \n[doc-header-space]u
815 .  el \
816 .    sp 1v
817 .  ev
818 .  ns
822 .\" NS doc-footer macro
823 .\" NS   print page footer
825 .de doc-footer
826 .  ie \n[cR] \
827 .    br
828 .  el \{\
829 .    ev doc-caption-enviroment
830 .    doc-setup-page-layout
831 .    sp \n[doc-footer-space]u
832 .    ie \n[D] \{\
833 .      ie o \
834 .        tl \a%\a\*[doc-caption-font2]\*[doc-date-string]\f[]\a\*[doc-caption-font]\*[doc-operating-system]\f[]\a
835 .      el \
836 .        tl \a\*[doc-caption-font]\*[doc-operating-system]\f[]\a\*[doc-caption-font2]\*[doc-date-string]\f[]\a%\a
837 .    \}
838 .    el \
839 .      tl \a\*[doc-caption-font]\*[doc-operating-system]\f[]\a\*[doc-caption-font2]\*[doc-date-string]\f[]\a%\a
840 .    bp
841 .    ev
842 .  \}
846 .\" NS doc-check-depth macro
847 .\" NS   check paired macros
849 .de doc-check-depth
850 .  if \n[doc-list-depth] \{\
851 .    tm mdoc warning: A .Bl directive has no matching .El (#\n[.c])
852 .    nr doc-list-depth 0
853 .  \}
854 .  if \n[doc-display-depth] \{\
855 .    tm mdoc warning: A .Bd directive has no matching .Ed (#\n[.c])
856 .    nr doc-display-depth 0
857 .  \}
858 .  if \n[doc-fontmode-depth] \{\
859 .    tm mdoc warning: A .Bf directive has no matching .Ef (#\n[.c])
860 .    nr doc-fontmode-depth 0
861 .  \}
865 .\" NS doc-end-macro macro
866 .\" NS   finish output
868 .de doc-end-macro
869 .  \" We may still have a partial line in the environment.  If this is the
870 .  \" case, and we happen to be on the last line of the page, the `.fl'
871 .  \" request will cause the page to be ejected and troff will immediately
872 .  \" exit.  If we are in nroff mode, this would be unfortunate, since we
873 .  \" would never get a chance to output the footer.  So we fudge the page
874 .  \" length to make sure that the last page is never ejected until we want
875 .  \" it to be.
877 .  if \n[cR] \
878 .    pl +3v
879 .  fl
881 .  doc-check-depth
883 .  if \n[cR] \{\
884 .    sp
885 .    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
886 .    \" suppress empty lines after the footer
887 .    pl \n[nl]u
888 .  \}
892 .\" NS doc-paragraph macro
893 .\" NS   insert a paragraph
895 .de doc-paragraph
896 .  sp \n[doc-paragraph-space]u
897 .  if !\n[cR] \
898 .    ne 2
899 .  ns
903 .\" NS Pp user macro (not parsed, not callable)
904 .\" NS   new paragraph
905 .\" NS
906 .\" NS width register `Pp' set above
908 .als Pp doc-paragraph
911 .\" NS Lp user macro (not parsed, not callable)
912 .\" NS   same as .Pp
913 .\" NS
914 .\" NS width register `Lp' set above
916 .als Lp doc-paragraph
919 .de LP
920 .  tm Not a \-mdoc command: .LP (#\n[.c])
924 .de PP
925 .  tm Not a \-mdoc command: .PP (#\n[.c])
929 .de pp
930 .  tm Not a \-mdoc command: .pp (#\n[.c])
934 .de SH
935 .  tm Not a \-mdoc command: .SH (#\n[.c])
939 .\" NS Nd user macro (not parsed, not callable)
940 .\" NS   print name description
941 .\" NS
942 .\" NS width register `Nd' set above
944 .de Nd
945 .  nop \[em] \$*
949 .\" NS doc-in-synopsis-section global register (bool)
950 .\" NS   whether we are in the `synopsis' section
952 .nr doc-in-synopsis-section 0
955 .\" NS doc-in-library-section global register (bool)
956 .\" NS   whether we are in the `library' section
958 .nr doc-in-library-section 0
961 .\" NS doc-in-see-also-section global register (bool)
962 .\" NS   whether we are in the `see also' section
964 .nr doc-in-see-also-section 0
967 .\" NS doc-in-files-section global register (bool)
968 .\" NS   whether we are in the `files' section
970 .nr doc-in-files-section 0
973 .\" NS doc-in-authors-section global register (bool)
974 .\" NS   whether we are in the `authors' section
976 .nr doc-in-authors-section 0
979 .\" NS doc-first-parameter macro
980 .\" NS   return first parameter
981 .\" NS
982 .\" NS local variables:
983 .\" NS   doc-str-dfp
985 .de doc-first-parameter
986 .  ds doc-str-dfp "\$1
990 .\" NS Sh user macro (not callable)
991 .\" NS   section headers
992 .\" NS
993 .\" NS modifies:
994 .\" NS   doc-func-args-processed
995 .\" NS   doc-func-count
996 .\" NS   doc-in-authors-section
997 .\" NS   doc-in-files-section
998 .\" NS   doc-in-library-section
999 .\" NS   doc-in-see-also-section
1000 .\" NS   doc-in-synopsis-section
1001 .\" NS   doc-indent-synopsis
1002 .\" NS   doc-indent-synopsis-active
1003 .\" NS   doc-is-func
1004 .\" NS   doc-num-func-args
1005 .\" NS
1006 .\" NS local variables:
1007 .\" NS   doc-reg-Sh
1008 .\" NS   doc-reg-Sh1
1009 .\" NS   doc-section-XXX
1010 .\" NS
1011 .\" NS width register `Sh' set in doc-common
1013 .ds doc-section-name        NAME
1014 .ds doc-section-synopsis    SYNOPSIS
1015 .ds doc-section-library     LIBRARY
1016 .ds doc-section-description DESCRIPTION
1017 .ds doc-section-see-also    SEE
1018 .ds doc-section-files       FILES
1019 .ds doc-section-authors     AUTHORS
1021 .de Sh
1022 .  ie \n[doc-arg-limit] \{\
1023 .    \" we only allow `Sh' within `Sh'; it will change the font back to
1024 .    \" `doc-Sh-font'
1025 .    ie "\*[doc-macro-name]"Sh" \{\
1026 .      nr doc-arg-ptr +1
1027 .      ie (\n[doc-arg-limit] >= \n[doc-arg-ptr]) \{\
1028 .        nr doc-curr-font \n[.f]
1029 .        nr doc-curr-size \n[.ps]
1030 .        nop \*[doc-Sh-font]\c
1031 .        doc-print-recursive
1032 .      \}
1033 .      el \{\
1034 .        tm Usage: .Sh section_name ... (#\n[.c])
1035 .        doc-reset-args
1036 .    \}\}
1037 .    el \{\
1038 .      tm Usage: .Sh not callable by other macros (#\n[.c])
1039 .      doc-reset-args
1040 .  \}\}
1041 .  el \{\
1042 .    if !\n[.$] \{\
1043 .      tm Usage: .Sh section_name ... (#\n[.c])
1044 .      return
1045 .    \}
1047 .    ds doc-macro-name Sh
1048 .    doc-parse-args \$@
1050 .    if t \
1051 .      ad
1053 .    \" this resolves e.g. `.Sh "SEE ALSO"'
1054 .    doc-first-parameter \$*
1056 .    ie "\*[doc-str-dfp]"\*[doc-section-name]" \{\
1057 .      doc-setup-header
1058 .      in 0
1059 .    \}
1060 .    el \{\
1061 .      nr doc-in-synopsis-section 0
1062 .      nr doc-in-library-section 0
1063 .      nr doc-in-see-also-section 0
1064 .      nr doc-in-files-section 0
1065 .      nr doc-in-authors-section 0
1067 .      ie        "\*[doc-str-dfp]"\*[doc-section-synopsis]" \{\
1068 .        if t \
1069 .          na
1070 .        nr doc-in-synopsis-section 1
1071 .        nr doc-indent-synopsis 0
1072 .        nr doc-indent-synopsis-active 0
1073 .      \}
1074 .      el \{ .ie "\*[doc-str-dfp]"\*[doc-section-library]" \{\
1075 .        nr doc-in-library-section 1
1076 .      \}
1077 .      el \{ .ie "\*[doc-str-dfp]"\*[doc-section-description]" \{\
1078 .        nr doc-is-func 0
1079 .        nr doc-func-count 0
1080 .        nr doc-func-args-processed 0
1081 .        nr doc-num-func-args 0
1082 .      \}
1083 .      el \{ .ie "\*[doc-str-dfp]"\*[doc-section-see-also]" \{\
1084 .        if t \
1085 .          na
1086 .        nr doc-in-see-also-section 1
1087 .      \}
1088 .      el \{ .ie "\*[doc-str-dfp]"\*[doc-section-files]" \
1089 .        nr doc-in-files-section 1
1090 .      el .if    "\*[doc-str-dfp]"\*[doc-section-authors]" \
1091 .        nr doc-in-authors-section 1
1092 .      \}\}\}\}
1094 .      in 0
1095 .      nr doc-have-author 0
1096 .    \}
1098 .    doc-setup-page-layout
1099 .    sp
1100 .    ns
1101 .    ta T .5i
1102 .    if !\n[cR] \
1103 .      ne 3
1104 .    fi
1106 .    if t \{\
1107 .      nr doc-reg-Sh \n[.ss]
1108 .      nr doc-reg-Sh1 \n[.sss]
1109 .      ss (\n[.ss] * 5 / 3) (\n[.sss] * 5 / 3)
1110 .    \}
1112 .    nr doc-arg-ptr +1
1113 .    nr doc-curr-font \n[.f]
1114 .    nr doc-curr-size \n[.ps]
1115 .    nop \*[doc-Sh-font]\c
1116 .    doc-print-recursive
1118 .    if t \
1119 .      ss \n[doc-reg-Sh] \n[doc-reg-Sh1]
1121 .    in +\n[doc-subheader-indent]u
1122 .    ns
1124 .    doc-check-depth
1125 .  \}
1129 .\" NS Ss user macro (not callable)
1130 .\" NS   subsection
1131 .\" NS
1132 .\" NS local variable:
1133 .\" NS   doc-reg-Ss
1134 .\" NS   doc-reg-Ss1
1135 .\" NS
1136 .\" NS width register `Ss' set above
1138 .de Ss
1139 .  ie \n[doc-arg-limit] \{\
1140 .    \" we only allow `Ss' within `Ss'; it will change the font back to
1141 .    \" `doc-Sh-font'
1142 .    ie "\*[doc-macro-name]"Ss" \{\
1143 .      nr doc-arg-ptr +1
1144 .      ie (\n[doc-arg-limit] >= \n[doc-arg-ptr]) \{\
1145 .        nr doc-curr-font \n[.f]
1146 .        nr doc-curr-size \n[.ps]
1147 .        nop \*[doc-Sh-font]\c
1148 .        doc-print-recursive
1149 .      \}
1150 .      el \{\
1151 .        tm Usage: .Ss subsection_name ... (#\n[.c])
1152 .        doc-reset-args
1153 .    \}\}
1154 .    el \{\
1155 .      tm Usage: .Ss not callable by other macros (#\n[.c])
1156 .      doc-reset-args
1157 .  \}\}
1158 .  el \{\
1159 .    if !\n[.$] \{\
1160 .      tm Usage: .Ss subsection_name ... (#\n[.c])
1161 .      return
1162 .    \}
1164 .    ds doc-macro-name Ss
1165 .    doc-parse-args \$@
1167 .    sp
1168 .    if !\n[cR] \
1169 .      ne 3
1170 .    ti -.25i
1172 .    nr doc-reg-Ss \n[.ss]
1173 .    nr doc-reg-Ss1 \n[.sss]
1174 .    ss (\n[.ss] * 5 / 4) (\n[.sss] * 5 / 4)
1176 .    nr doc-arg-ptr +1
1177 .    nr doc-curr-font \n[.f]
1178 .    nr doc-curr-size \n[.ps]
1179 .    nop \*[doc-Sh-font]\c
1180 .    doc-print-recursive
1182 .    ss \n[doc-reg-Ss] \n[doc-reg-Ss1]
1184 .    ta T .5i
1185 .    if !\n[cR] \
1186 .      ne 2
1187 .    br
1188 .    ns
1190 .    doc-check-depth
1191 .  \}
1195 .\" NS Rd macro (not parsed, not callable)
1196 .\" NS   print global register dump to stderr
1197 .\" NS
1198 .\" NS local variables:
1199 .\" NS   doc-reg-Rd
1201 .de Rd
1202 .  tm MDOC GLOBAL REGISTER DUMP
1203 .  tm doc-macro-name == `\*[doc-macro-name]'
1204 .  tm doc-arg-limit == \n[doc-arg-limit]
1205 .  tm doc-num-args == \n[doc-num-args]
1206 .  tm doc-arg-ptr == \n[doc-arg-ptr]
1208 .  nr doc-reg-Rd 1
1209 .  while (\n[doc-reg-Rd] <= \n[doc-arg-limit]) \{\
1210 .    tm doc-arg\n[doc-reg-Rd] == `\*[doc-arg\n[doc-reg-Rd]]'
1211 .    tm doc-type\n[doc-reg-Rd] == \n[doc-type\n[doc-reg-Rd]]
1212 .    tm doc-space\n[doc-reg-Rd] == `\*[doc-space\n[doc-reg-Rd]]'
1213 .    nr doc-reg-Rd +1
1214 .  \}
1216 .  tm doc-curr-font == \n[doc-curr-font]
1217 .  tm doc-curr-size == \n[doc-curr-size]
1218 .  tm doc-indent-synopsis == \n[doc-indent-synopsis]
1219 .  tm doc-indent-synopsis-active == \n[doc-indent-synopsis-active]
1220 .  tm doc-have-decl == \n[doc-have-decl]
1221 .  tm doc-have-var == \n[doc-have-var]
1222 .  tm doc-command-name == `\*[doc-command-name]'
1223 .  tm doc-quote-left == `\*[doc-quote-left]'
1224 .  tm doc-quote-right == `\*[doc-quote-right]'
1225 .  tm doc-nesting-level == \n[doc-nesting-level]
1226 .  tm doc-in-list == \n[doc-in-list]
1227 .  tm doc-space == `\*[doc-space]'
1228 .  tm doc-saved-space == `\*[doc-saved-space]'
1229 .  tm doc-space-mode == \n[doc-space-mode]
1230 .  tm doc-have-space == \n[doc-have-space]
1231 .  tm doc-have-slot == \n[doc-have-slot]
1232 .  tm doc-keep-type == \n[doc-keep-type]
1233 .  tm doc-display-depth == \n[doc-display-depth]
1234 .  tm doc-is-compact == \n[doc-is-compact]
1236 .  nr doc-reg-Rd 0
1237 .  while (\n[doc-reg-Rd] <= \n[doc-display-depth]) \{\
1238 .    tm doc-display-type-stack\n[doc-reg-Rd] == `\*[doc-display-type-stack\n[doc-reg-Rd]]'
1239 .    tm doc-display-indent-stack\n[doc-reg-Rd] == \n[doc-display-indent-stack\n[doc-reg-Rd]]
1240 .    tm doc-display-ad-stack\n[doc-reg-Rd] == \n[doc-display-ad-stack\n[doc-reg-Rd]]
1241 .    tm doc-display-fi-stack\n[doc-reg-Rd] == \n[doc-display-fi-stack\n[doc-reg-Rd]]
1242 .    tm doc-display-ft-stack\n[doc-reg-Rd] == \n[doc-display-ft-stack\n[doc-reg-Rd]]
1243 .    tm doc-display-ps-stack\n[doc-reg-Rd] == \n[doc-display-ps-stack\n[doc-reg-Rd]]
1244 .    nr doc-reg-Rd +1
1245 .  \}
1247 .  tm doc-fontmode-depth == \n[doc-fontmode-depth]
1249 .  nr doc-reg-Rd 1
1250 .  while (\n[doc-reg-Rd] <= \n[doc-fontmode-depth]) \{\
1251 .    tm doc-fontmode-font-stack\n[doc-reg-Rd] == `\n[doc-fontmode-font-stack\n[doc-reg-Rd]]'
1252 .    tm doc-fontmode-size-stack\n[doc-reg-Rd] == `\n[doc-fontmode-size-stack\n[doc-reg-Rd]]'
1253 .    nr doc-reg-Rd +1
1254 .  \}
1256 .  tm doc-list-depth == \n[doc-list-depth]
1258 .  nr doc-reg-Rd 1
1259 .  while (\n[doc-reg-Rd] <= \n[doc-list-depth]) \{\
1260 .    tm doc-list-type-stack\n[doc-reg-Rd] == `\*[doc-list-type-stack\n[doc-reg-Rd]]'
1261 .    tm doc-list-have-indent-stack\n[doc-reg-Rd] == \n[doc-list-have-indent-stack\n[doc-reg-Rd]]
1262 .    tm doc-list-indent-stack\n[doc-reg-Rd] == \n[doc-list-indent-stack\n[doc-reg-Rd]]
1263 .    tm doc-compact-list-stack\n[doc-reg-Rd] == \n[doc-compact-list-stack\n[doc-reg-Rd]]
1264 .    tm doc-tag-prefix-stack\n[doc-reg-Rd] == `\*[doc-tag-prefix-stack\n[doc-reg-Rd]]'
1265 .    tm doc-tag-width-stack\n[doc-reg-Rd] == `\*[doc-tag-width-stack\n[doc-reg-Rd]]'
1266 .    tm doc-list-offset-stack\n[doc-reg-Rd] == \n[doc-list-offset-stack\n[doc-reg-Rd]]
1267 .    tm doc-enum-list-count-stack\n[doc-reg-Rd] == \n[doc-enum-list-count-stack\n[doc-reg-Rd]]
1268 .    nr doc-reg-Rd +1
1269 .  \}
1271 .  tm doc-saved-Pa-font == `\*[doc-saved-Pa-font]'
1272 .  tm doc-curr-type == \n[doc-curr-type]
1273 .  tm doc-curr-arg == `\*[doc-curr-arg]'
1274 .  tm doc-diag-list-input-line-count == \n[doc-diag-list-input-line-count]
1275 .  tm doc-num-columns == \n[doc-num-columns]
1276 .  tm doc-column-indent-width == \n[doc-column-indent-width]
1277 .  tm doc-is-func == \n[doc-is-func]
1278 .  tm doc-have-old-func == \n[doc-have-old-func]
1279 .  tm doc-func-arg-count == \n[doc-func-arg-count]
1280 .  tm doc-func-arg == `\*[doc-func-arg]'
1281 .  tm doc-num-func-args == \n[doc-num-func-args]
1282 .  tm doc-func-args-processed == \n[doc-func-args-processed]
1283 .  tm doc-have-func == \n[doc-have-func]
1284 .  tm doc-is-reference == \n[doc-is-reference]
1285 .  tm doc-reference-count == \n[doc-reference-count]
1286 .  tm doc-author-count == \n[doc-author-count]
1288 .  nr doc-reg-Rd 0
1289 .  while (\n[doc-reg-Rd] <= \n[doc-author-count]) \{\
1290 .    tm doc-author-name\n[doc-reg-Rd] == `\*[doc-author-name\n[doc-reg-Rd]]'
1291 .    nr doc-reg-Rd +1
1292 .  \}
1294 .  tm doc-book-count == \n[doc-book-count]
1295 .  tm doc-book-name == `\*[doc-book-name]'
1296 .  tm doc-date-count == \n[doc-date-count]
1297 .  tm doc-date == `\*[doc-date]'
1298 .  tm doc-publisher-count == \n[doc-publisher-count]
1299 .  tm doc-publisher-name == `\*[doc-publisher-name]'
1300 .  tm doc-journal-count == \n[doc-journal-count]
1301 .  tm doc-journal-name == `\*[doc-journal-name]'
1302 .  tm doc-issue-count == \n[doc-issue-count]
1303 .  tm doc-issue-name == `\*[doc-issue-name]'
1304 .  tm doc-optional-count == \n[doc-optional-count]
1305 .  tm doc-optional-string == `\*[doc-optional-string]'
1306 .  tm doc-page-number-count == \n[doc-page-number-count]
1307 .  tm doc-page-number-string == `\*[doc-page-number-string]'
1308 .  tm doc-corporate-count == \n[doc-corporate-count]
1309 .  tm doc-corporate-name == `\*[doc-corporate-name]'
1310 .  tm doc-report-count == \n[doc-report-count]
1311 .  tm doc-report-name == `\*[doc-report-name]'
1312 .  tm doc-reference-title-count == \n[doc-reference-title-count]
1313 .  tm doc-reference-title-name == `\*[doc-reference-title-name]'
1314 .  tm doc-reference-title-name-for-book == `\*[doc-reference-title-name-for-book]'
1315 .  tm doc-url-count == \n[doc-url-count]
1316 .  tm doc-url-name == `\*[doc-url-name]'
1317 .  tm doc-volume-count == \n[doc-volume-count]
1318 .  tm doc-volume-name == `\*[doc-volume-name]'
1319 .  tm doc-have-author == \n[doc-have-author]
1321 .  tm doc-document-title == `\*[doc-document-title]'
1322 .  tm doc-volume == `\*[doc-volume]'
1323 .  tm doc-section == `\*[doc-section]'
1324 .  tm doc-operating-system == `\*[doc-operating-system]'
1325 .  tm doc-date-string == `\*[doc-date-string]'
1326 .  tm doc-header-space == \n[doc-header-space]
1327 .  tm doc-footer-space == \n[doc-footer-space]
1328 .  tm doc-display-vertical == \n[doc-display-vertical]
1329 .  tm doc-header-string == `\*[doc-header-string]'
1330 .  tm doc-in-synopsis-section == \n[doc-in-synopsis-section]
1331 .  tm doc-in-library-section == \n[doc-in-library-section]
1332 .  tm doc-in-see-also-section == \n[doc-in-see-also-section]
1333 .  tm doc-in-files-section == \n[doc-in-files-section]
1334 .  tm doc-in-authors-section == \n[doc-in-authors-section]
1336 .  tm END OF GLOBAL REGISTER DUMP
1342 .\" s-ts-mode