3 .\" Copyright (C) 1989, 1990, 1991, 1992, 2001, 2002, 2003, 2004, 2005
4 .\" Free Software Foundation, Inc.
5 .\" Written by James Clark (jjc@jclark.com)
7 .\" This file is part of groff.
9 .\" groff is free software; you can redistribute it and/or modify it under
10 .\" the terms of the GNU General Public License as published by the Free
11 .\" Software Foundation; either version 2, or (at your option) any later
14 .\" groff is distributed in the hope that it will be useful, but WITHOUT ANY
15 .\" WARRANTY; without even the implied warranty of MERCHANTABILITY or
16 .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19 .\" You should have received a copy of the GNU General Public License along
20 .\" with groff; see the file COPYING. If not, write to the Free Software
21 .\" Foundation, 51 Franklin St - Fifth Floor, Boston, MA 02110-1301, USA.
23 .\" -rcR=1 => Create a single, very long page instead of multiple pages.
24 .\" Useful for online display. Default in nroff mode.
25 .\" Desactivate with -rcR=0.
26 .\" -rC1 => Number pages continuously, rather than start each at 1.
27 .\" -rD1 => Double-sided printing, ie different odd and even page footers.
28 .\" -rPnnn => Number first page nnn.
29 .\" -rSxx => Use size `xx'pt (either 10, 11, or 12) for document rather
30 .\" than the default size of 10pt.
31 .\" -rXnnn => Number pages after nnn as nnna, nnnb, nnnc, ...
33 .\" The file man.local is loaded at the end. Put local additions there.
34 .\" If you need to add things to TH, use `.am1 TH'.
37 .if !\n(.g .ab These man macros work only with groff.
46 .if (\n[.x]\n[.y] < 118) \
47 . ab You need GNU troff version 1.18 or higher to run this version of man!
52 .\" we must use consecutive page numbers when using postscript to generate
53 .\" html images, and we must not reset the page number at the beginning
54 .\" (the `ps4html' register is automatically added to the command line by
55 .\" the pre-html preprocessor)
65 .\" set up the line length...
66 .\" giving precedence to any prior assignment to the \n[LL] register.
69 . \" but if that isn't predefined...
70 . \" then try to respect any prior `.ll' request.
73 . \" For troff, this is sufficient to give us a default line length of
74 . \" 6.5i, but for nroff, we prefer a default of 78n to nroff's default
75 . \" 65n. This has the unfortunate side effect that we will override a
76 . \" user's `.ll 65n' request, with our preferred 78n default; we can't
77 . \" possibly know that the 65n came from a `.ll' request, and MUST
78 . \" assume that it was set by nroff, as its built-in default! If the
79 . \" user wants to force this setting, then he MUST use the `-rLL=65n'
80 . \" option, or an equivalent `.nr LL 65n' request.
91 .\" Default heading font
97 .if '\*[.T]'html' .nr an-html 1
98 .if \n[an-html] .nr C 1
101 .\" we redefine .ne to avoid page breaks if cR is set; instead, the page
102 .\" length is increased to the necessary amount (this is needed for tables)
104 .\" similarly, we redefine .bp if cR is set, adjusting the page length to
105 .\" the current position so that no empty lines are inserted
112 . if (\\n[an-ne] >= \\n[.t]) \
113 . pl +(\\n[an-ne]u - \\n[.t]u + 1v)
125 . nr an-margin \\n[IN]
128 .\" .TH title section extra1 extra2 extra3
130 . if \\n[an-html] \{\
136 . de an-init \" We have to do it like this to get multiple man pages right.
138 . ds an-section "\\$2
140 . ie (\\n[.$] > 3) .ds an-extra2 "\\$4
141 . el .ds an-extra2 \"Sun Release 4.0
142 . ie (\\n[.$] > 4) .ds an-extra3 "\\$5
143 . el .ds an-extra3 \"System Programmer's Manual
149 . nr PS 10z \" default point size
154 . \" use sizes similar to LaTeX
156 . ie (\\n[S] == 11) \{\
163 . if (\\n[S] == 12) \{\
176 .\" We must select an integer indentation value for nroff;
177 .\" see comment in an-do-tag.
184 . nr SN 3n \" the indentation of sub-sub-headings relative to sub-headings
187 . nr an-prevailing-indent \\n[IN]
190 . nr an-no-space-flag 0
199 . wh \\n[FT]u an-p-footer
201 . if (\\n[nl] > 0) \{\
202 . ie \\n[C] .bp (\\n[%] + 1)
208 .\" BSD compatibility macros: .AT and .UC
211 . ds an-extra2 "7th Edition
212 . if "\\$1"3" .ds an-extra2 "7th Edition
213 . if "\\$1"4" .ds an-extra2 "System III
215 . ie "\\$2"" .ds an-extra2 "System V
216 . el .ds an-extra2 "System V Release \\$2
221 . ds an-extra2 "3rd Berkeley Distribution
222 . if "\\$1"3" .ds an-extra2 "3rd Berkeley Distribution
223 . if "\\$1"4" .ds an-extra2 "4th Berkeley Distribution
224 . if "\\$1"5" .ds an-extra2 "4.2 Berkeley Distribution
225 . if "\\$1"6" .ds an-extra2 "4.3 Berkeley Distribution
226 . if "\\$1"7" .ds an-extra2 "4.4 Berkeley Distribution
230 . ta T .5i \" This sets tabs every .5 inches
234 . ie \\n[.$] .nr PD (v;\\$1)
235 . el .nr PD (.4v >? \n[.V])
238 .\" Redefine these to customize the header & footer
241 . tl '\\*[an-title](\\*[an-section])'\\*[an-extra3]'\\*[an-title](\\*[an-section])'
248 . if o .tl '\\*[an-extra2]'\\*[an-extra1]'\\*[an-page-string]'
249 . if e .tl '\\*[an-page-string]'\\*[an-extra1]'\\*[an-extra2]'
252 . tl '\\*[an-extra2]'\\*[an-extra1]'\\*[an-page-string]'
293 . ie \\n[an-html] \{\
300 . if (\\n[%] > \\n[X]) \{\
301 . nr an-page-letter (\\n[%] - \\n[X])
302 . ds an-page-string \\n[X]\\n[an-page-letter]
307 . ds an-page-string "\\*[an-title](\\*[an-section])
309 . ds an-page-string \\n[%]
325 .if \n[cR] .em an-end
331 . nr an-prevailing-indent \\n[IN]
336 . DEVTAG-NH \\n[an-level]
338 . nr an-no-space-flag 1
350 . nr an-prevailing-indent \\n[IN]
355 . nr an-no-space-flag 1
372 . if \\n[.$] \,\\$*\/
390 . if \\n[.$] .nr an-prevailing-indent (n;\\$1)
393 . ll -\\n[an-margin]u
394 . if !\\n[an-div?] .di an-div
399 . if \\n[need_eo_h]>0 .DEVTAG-EO-H
404 . if \\n[an-break-flag] \{\
408 . if \\n[an-no-space-flag] \{\
410 . nr an-no-space-flag 0
412 . if \\n[an-div?] .an-do-tag
420 . ie (\\n[dl] + \\n[an-tag-sep] > \\n[an-prevailing-indent]) \{\
424 . in (\\n[an-margin]u + \\n[an-prevailing-indent]u)
427 . \" In nroff mode, if the indentation value is not an integer multiple
428 . \" of the character cell, it is possible that the following combination
429 . \" of .in and .ti yields a different result as the .in request in
430 . \" the .ie part above.
431 . in (\\n[an-margin]u + \\n[an-prevailing-indent]u)
432 . ti -\\n[an-prevailing-indent]u
436 \\*[an-div]\\h'|\\n[an-prevailing-indent]u'\c
447 . nr an-prevailing-indent \\n[IN]
460 . in (\\n[an-margin]u + \\n[an-prevailing-indent]u)
463 . ie (\\n[.$] - 1) .TP "\\$2"
475 . if \\n[.$] .nr an-prevailing-indent (n;\\$1)
476 . in (\\n[an-margin]u + \\n[an-prevailing-indent]u)
480 .ds an-empty \" this is referenced to avoid looping on eg .RB ( \\ )
484 . ds an-result \&\f[R]\\$1
486 . while (\\n[.$] >= 2) \{\
487 . as an-result \,\f[I]\\$1\f[R]\/\\$2\\*[an-empty]
490 . if \\n[.$] .as an-result \,\f[I]\\$1
498 . ds an-result \&\f[I]\\$1\f[R]
500 . while (\\n[.$] >= 2) \{\
501 . as an-result \/\\$1\f[I]\,\\$2\f[R]
504 . if \\n[.$] .as an-result \/\\$1
512 . ds an-result \&\f[I]\\$1
514 . while (\\n[.$] >= 2) \{\
515 . as an-result \/\f[B]\\$1\f[I]\,\\$2\\*[an-empty]
518 . if \\n[.$] .as an-result \/\f[B]\\$1
526 . ds an-result \&\f[B]\\$1
528 . while (\\n[.$] >= 2) \{\
529 . as an-result \,\f[I]\\$1\f[B]\/\\$2\\*[an-empty]
532 . if \\n[.$] .as an-result \,\f[I]\\$1
540 . while (\\n[.$] >= 2) \{\
541 . as an-result \f[R]\\$1\f[B]\\$2\\*[an-empty]
544 . if \\n[.$] .as an-result \f[R]\\$1
551 . while (\\n[.$] >= 2) \{\
552 . as an-result \f[B]\\$1\f[R]\\$2\\*[an-empty]
555 . if \\n[.$] .as an-result \f[B]\\$1
561 . nr an-saved-margin\\n[an-level] \\n[an-margin]
562 . nr an-saved-prevailing-indent\\n[an-level] \\n[an-prevailing-indent]
563 . ie \\n[.$] .nr an-margin +(n;\\$1)
564 . el .nr an-margin +\\n[an-prevailing-indent]
566 . nr an-prevailing-indent \\n[IN]
571 . ie \\n[.$] .nr an-level ((;\\$1) <? \\n[an-level])
573 . nr an-level (1 >? \\n[an-level])
574 . nr an-margin \\n[an-saved-margin\\n[an-level]]
575 . nr an-prevailing-indent \\n[an-saved-prevailing-indent\\n[an-level]]
593 .\" dummy equation delimiters
604 . tm `R' is a string (producing the registered sign), not a macro.
615 .\" these strings must work in compatibility mode also
618 .ie c\[tm] .ds Tm \(tm
633 .\" Load local modifications.
638 .\" end of an-old.tmac