3 .\" Copyright (c) 2014 - 2017 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
5 .\" Copyright (C) 1989 - 1992, 2001 - 2005, 2007 - 2009
6 .\" Free Software Foundation, Inc.
7 .\" Written by James Clark (jjc@jclark.com)
9 .\" This 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 .\" This 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 / compatible.
46 .if (\n[.x]\n[.y] < 118) \
47 . ab You need a newer troff (v1.18 or higher) for 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)
66 .\" set up the line length...
67 .\" giving precedence to any prior assignment to the \n[LL] register.
70 . \" but if that isn't predefined...
71 . \" then try to respect any prior `.ll' request.
74 . \" For troff, this is sufficient to give us a default line length of
75 . \" 6.5i, but for nroff, we prefer a default of 78n to nroff's default
76 . \" 65n. This has the unfortunate side effect that we will override a
77 . \" user's `.ll 65n' request, with our preferred 78n default; we can't
78 . \" possibly know that the 65n came from a `.ll' request, and MUST
79 . \" assume that it was set by nroff, as its built-in default! If the
80 . \" user wants to force this setting, then he MUST use the `-rLL=65n'
81 . \" option, or an equivalent `.nr LL 65n' request.
92 .\" Default heading font
98 .if '\*[.T]'html' .nr an-html 1
99 .if \n[an-html] .nr C 1
100 .if r ps4html .nr C 1
102 .\" we redefine .ne to avoid page breaks if cR is set; instead, the page
103 .\" length is increased to the necessary amount (this is needed for tables)
105 .\" similarly, we redefine .bp if cR is set, adjusting the page length to
106 .\" the current position so that no empty lines are inserted
113 . if (\\n[an-ne] >= \\n[.t]) \
114 . pl +(\\n[an-ne]u - \\n[.t]u + 1v)
127 . nr an-margin \\n[IN]
128 . nr an-saved-margin1 \\n[IN]
129 . nr an-prevailing-indent \\n[IN]
130 . nr an-saved-prevailing-indent1 \\n[IN]
136 .\" Print volume headers like mdoc(7) does
137 .ds an-doc-volume-ds-1 General Commands Manual
138 .ds an-doc-volume-ds-2 System Calls Manual
139 .ds an-doc-volume-ds-3 Library Functions Manual
140 .ds an-doc-volume-ds-4 Kernel Interfaces Manual
141 .ds an-doc-volume-ds-5 File Formats Manual
142 .ds an-doc-volume-ds-6 Games Manual
143 .ds an-doc-volume-ds-7 Miscellaneous Information Manual
144 .ds an-doc-volume-ds-8 System Manager's Manual
145 .ds an-doc-volume-ds-9 Kernel Developer's Manual
147 .\" .TH title section extra1 extra2 extra3
149 . if \\n[an-html] \{\
155 . de an-init \" We have to do it like this to get multiple man pages right.
156 . ds an-title "\\$1\"
157 . ds an-section "\\$2\"
158 . ds an-extra1 "\\$3\"
159 . ie (\\n[.$] > 3) .ds an-extra2 "\\$4\"
160 . el .ds an-extra2 \"Sun Release 4.0
162 . ie (\\n[.$] > 4) .ds an-extra3 "\\$5\"
165 . if '\\$2'1' .als an-extra3 an-doc-volume-ds-1
166 . if '\\$2'2' .als an-extra3 an-doc-volume-ds-2
167 . if '\\$2'3' .als an-extra3 an-doc-volume-ds-3
168 . if '\\$2'3p' .ds an-extra3 Perl Programmers Reference Guide
169 . if '\\$2'4' .als an-extra3 an-doc-volume-ds-4
170 . if '\\$2'5' .als an-extra3 an-doc-volume-ds-5
171 . if '\\$2'6' .als an-extra3 an-doc-volume-ds-6
172 . if '\\$2'7' .als an-extra3 an-doc-volume-ds-7
173 . if '\\$2'8' .als an-extra3 an-doc-volume-ds-8
174 . if '\\$2'9' .als an-extra3 an-doc-volume-ds-9
175 . if !d an-extra3 .ds an-extra3
182 . nr PS 10z \" default point size
187 . \" use sizes similar to LaTeX
189 . ie (\\n[S] == 11) \{\
196 . if (\\n[S] == 12) \{\
209 .\" We must select an integer indentation value for nroff;
210 .\" see comment in an-do-tag.
217 . nr SN 3n \" the indentation of sub-sub-headings relative to sub-headings
221 . nr an-no-space-flag 0
230 . wh \\n[FT]u an-p-footer
233 . ie \\n[C] .bp (\\n[%] + 1)
239 .\" BSD compatibility macros: .AT and .UC
242 . ds an-extra2 "7th Edition\"
243 . if "\\$1"3" .ds an-extra2 "7th Edition\"
244 . if "\\$1"4" .ds an-extra2 "System III\"
246 . ie "\\$2"" .ds an-extra2 "System V\"
247 . el .ds an-extra2 "System V Release \\$2\"
252 . ds an-extra2 "3rd Berkeley Distribution\"
253 . if "\\$1"3" .ds an-extra2 "3rd Berkeley Distribution\"
254 . if "\\$1"4" .ds an-extra2 "4th Berkeley Distribution\"
255 . if "\\$1"5" .ds an-extra2 "4.2 Berkeley Distribution\"
256 . if "\\$1"6" .ds an-extra2 "4.3 Berkeley Distribution\"
257 . if "\\$1"7" .ds an-extra2 "4.4 Berkeley Distribution\"
261 . ta T .5i \" This sets tabs every .5 inches
265 . ie \\n[.$] .nr PD (v;\\$1)
266 . el .nr PD (.4v >? \n[.V])
269 .\" Redefine these to customize the header & footer
272 . tl '\\*[an-title](\\*[an-section])'\\*[an-extra3]'\\*[an-title](\\*[an-section])'
279 . if o .tl '\\*[an-extra2]'\\*[an-extra1]'\\*[an-page-string]'
280 . if e .tl '\\*[an-page-string]'\\*[an-extra1]'\\*[an-extra2]'
283 . tl '\\*[an-extra2]'\\*[an-extra1]'\\*[an-page-string]'
324 . ie \\n[an-html] \{\
331 . if (\\n[%] > \\n[X]) \{\
332 . nr an-page-letter (\\n[%] - \\n[X])
333 . ds an-page-string \\n[X]\\n[an-page-letter]\"
338 . ds an-page-string "\\*[an-title](\\*[an-section])\"
340 . ds an-page-string \\n[%]\"
356 .if \n[cR] .em an-end
365 . DEVTAG-NH \\n[an-level]
367 . nr an-no-space-flag 1
382 . nr an-no-space-flag 1
399 . if \\n[.$] \,\\$*\/
417 . if \\n[.$] .nr an-prevailing-indent (n;\\$1)
420 . ll -\\n[an-margin]u
421 . if !\\n[an-div?] .di an-div
426 . if \\n[need_eo_h]>0 .DEVTAG-EO-H
428 . if \\n[need_col2]>0 .DEVTAG-COL 2
433 . if \\n[an-break-flag] \{\
437 . if \\n[an-no-space-flag] \{\
439 . nr an-no-space-flag 0
441 . if \\n[an-div?] .an-do-tag
449 . \" We must emit the diversion in a separate environment to
450 . \" assure that a possible margin character is printed correctly.
456 . ie (\\n[dl] + \\n[an-tag-sep] > \\n[an-prevailing-indent]) \{\
460 . in (\\n[an-margin]u + \\n[an-prevailing-indent]u)
463 . \" In nroff mode, the indentation value should be an integer multiple
464 . \" of the character cell, to avoid different results compared to the
465 . \" the .ie part above.
471 . in (\\n[an-margin]u + \\n[an-prevailing-indent]u)
482 . nr an-prevailing-indent \\n[IN]
496 . in (\\n[an-margin]u + \\n[an-prevailing-indent]u)
500 . ie (\\n[.$] - 1) .TP "\\$2"
512 . if \\n[.$] .nr an-prevailing-indent (n;\\$1)
513 . in (\\n[an-margin]u + \\n[an-prevailing-indent]u)
520 .ds an-empty \" this is referenced to avoid looping on eg .RB ( \\ )
524 . ds an-result \&\f[R]\\$1\"
526 . while (\\n[.$] >= 2) \{\
527 . as an-result \,\f[I]\\$1\f[R]\/\\$2\\*[an-empty]\"
530 . if \\n[.$] .as an-result \,\f[I]\\$1\"
538 . ds an-result \&\f[I]\\$1\f[R]\"
540 . while (\\n[.$] >= 2) \{\
541 . as an-result \/\\$1\f[I]\,\\$2\f[R]\"
544 . if \\n[.$] .as an-result \/\\$1\"
552 . ds an-result \&\f[I]\\$1\"
554 . while (\\n[.$] >= 2) \{\
555 . as an-result \/\f[B]\\$1\f[I]\,\\$2\\*[an-empty]\"
558 . if \\n[.$] .as an-result \/\f[B]\\$1\"
566 . ds an-result \&\f[B]\\$1\"
568 . while (\\n[.$] >= 2) \{\
569 . as an-result \,\f[I]\\$1\f[B]\/\\$2\\*[an-empty]\"
572 . if \\n[.$] .as an-result \,\f[I]\\$1\"
580 . while (\\n[.$] >= 2) \{\
581 . as an-result \f[R]\\$1\f[B]\\$2\\*[an-empty]\"
584 . if \\n[.$] .as an-result \f[R]\\$1\"
591 . while (\\n[.$] >= 2) \{\
592 . as an-result \f[B]\\$1\f[R]\\$2\\*[an-empty]\"
595 . if \\n[.$] .as an-result \f[B]\\$1\"
601 . nr an-saved-margin\\n[an-level] \\n[an-margin]
602 . nr an-saved-prevailing-indent\\n[an-level] \\n[an-prevailing-indent]
603 . ie \\n[.$] .nr an-margin +(n;\\$1)
604 . el .nr an-margin +\\n[an-prevailing-indent]
606 . nr an-prevailing-indent \\n[IN]
611 . ie \\n[.$] .nr an-level ((;\\$1) <? \\n[an-level])
613 . nr an-level (1 >? \\n[an-level])
614 . nr an-margin \\n[an-saved-margin\\n[an-level]]
615 . nr an-prevailing-indent \\n[an-saved-prevailing-indent\\n[an-level]]
633 .\" dummy equation delimiters
644 . tm `R' is a string (producing the registered sign), not a macro.
655 .\" these strings must work in compatibility mode also
658 .ie c\[tm] .ds Tm \(tm\"
673 .\" For UTF-8, map some characters conservatively for the sake
674 .\" of easy cut and paste.
676 .if '\*[.T]'utf8' \{\
685 .\" Load man macro extensions.
688 .\" Load local modifications.