3 .\" Copyright (C) 1989-2018 Free Software Foundation, Inc.
4 .\" Written by James Clark (jjc@jclark.com)
6 .\" This file is part of groff.
8 .\" groff is free software; you can redistribute it and/or modify it
9 .\" under the terms of the GNU General Public License as published by
10 .\" the Free Software Foundation, either version 3 of the License, or
11 .\" (at your option) any later version.
13 .\" groff is distributed in the hope that it will be useful, but WITHOUT
14 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15 .\" or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
16 .\" License for more details.
18 .\" You should have received a copy of the GNU General Public License
19 .\" along with this program. If not, see
20 .\" <http://www.gnu.org/licenses/>.
22 .\" -rcR=1 => Create a single, very long page instead of multiple
23 .\" pages. Useful for online display. Default in nroff
24 .\" mode. Deactivate with -rcR=0.
25 .\" -rC1 => Number pages continuously, rather than start each at 1.
26 .\" -rD1 => Double-sided printing, ie different odd and even page
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 1.18 or higher to run this version of man!
49 .\" Define a string for use in diagnostic messages.
50 .ds an-old an-old.tmac
55 .\" We must use consecutive page numbers when using PostScript to
56 .\" generate HTML images, and we must not reset the page number at the
57 .\" beginning (the 'ps4html' register is automatically added to the
58 .\" command line by the pre-HTML preprocessor).
69 .\" set up the line length...
70 .\" giving precedence to any prior assignment to the \n[LL] register.
73 . \" but if that isn't predefined...
74 . \" then try to respect any prior '.ll' request.
77 . \" For troff, this is sufficient to give us a default line length of
78 . \" 6.5i, but for nroff, we prefer a default of 78n to nroff's default
79 . \" 65n. This has the unfortunate side effect that we will override a
80 . \" user's '.ll 65n' request, with our preferred 78n default; we can't
81 . \" possibly know that the 65n came from a '.ll' request, and MUST
82 . \" assume that it was set by nroff, as its built-in default! If the
83 . \" user wants to force this setting, then he MUST use the '-rLL=65n'
84 . \" option, or an equivalent '.nr LL 65n' request.
95 .\" Default heading font
101 .if '\*[.T]'html' .nr an-html 1
102 .if \n[an-html] .nr C 1
103 .if r ps4html .nr C 1
105 .\" We redefine .ne to avoid page breaks if cR is set; instead, the page
106 .\" length is increased to the necessary amount (this is needed for
109 .\" Similarly, we redefine .bp if cR is set, adjusting the page length
110 .\" to the current position so that no empty lines are inserted.
117 . if (\\n[an-ne] >= \\n[.t]) \
118 . pl +(\\n[an-ne]u - \\n[.t]u + 1v)
131 . nr an-margin \\n[IN]
132 . nr an-saved-margin1 \\n[IN]
133 . nr an-prevailing-indent \\n[IN]
134 . nr an-saved-prevailing-indent1 \\n[IN]
141 .\" .TH title section extra1 extra2 extra3
143 . if \\n[an-html] \{\
149 . de an-init \" This approach gets multiple man pages right.
150 . ds an-title "\\$1\"
151 . ds an-section "\\$2\"
152 . ds an-extra1 "\\$3\"
153 . ie (\\n[.$] > 3) .ds an-extra2 "\\$4\"
154 . el .ds an-extra2 \"Sun Release 4.0
156 . ie (\\n[.$] > 4) .ds an-extra3 "\\$5\"
157 . el \{ .ie '\\$2'1' .ds an-extra3 General Commands Manual
158 . el \{ .ie '\\$2'2' .ds an-extra3 System Calls Manual
159 . el \{ .ie '\\$2'3' .ds an-extra3 Library Functions Manual
160 . el \{ .ie '\\$2'3p' .ds an-extra3 Perl Programmers Reference Guide
161 . el \{ .ie '\\$2'4' .ds an-extra3 Kernel Interfaces Manual
162 . el \{ .ie '\\$2'5' .ds an-extra3 File Formats Manual
163 . el \{ .ie '\\$2'6' .ds an-extra3 Games Manual
164 . el \{ .ie '\\$2'7' .ds an-extra3 Miscellaneous Information Manual
165 . el \{ .ie '\\$2'8' .ds an-extra3 System Manager's Manual
166 . el \{ .ie '\\$2'9' .ds an-extra3 Kernel Developer's Manual
168 . \}\}\}\}\}\}\}\}\}\}
174 . nr PS 10z \" default point size
179 . \" use sizes similar to LaTeX
181 . ie (\\n[S] == 11) \{\
188 . if (\\n[S] == 12) \{\
201 .\" We must select an integer indentation value for nroff;
202 .\" see comment in an-do-tag.
209 . nr SN 3n \" indentation of sub-sub-headings relative to sub-heads
213 . nr an-no-space-flag 0
222 . wh \\n[FT]u an-p-footer
225 . ie \\n[C] .bp (\\n[%] + 1)
231 .\" BSD compatibility macros: .AT and .UC
234 . ds an-extra2 "7th Edition\"
235 . if "\\$1"3" .ds an-extra2 "7th Edition\"
236 . if "\\$1"4" .ds an-extra2 "System III\"
238 . ie "\\$2"" .ds an-extra2 "System V\"
239 . el .ds an-extra2 "System V Release \\$2\"
244 . ds an-extra2 "3rd Berkeley Distribution\"
245 . if "\\$1"3" .ds an-extra2 "3rd Berkeley Distribution\"
246 . if "\\$1"4" .ds an-extra2 "4th Berkeley Distribution\"
247 . if "\\$1"5" .ds an-extra2 "4.2 Berkeley Distribution\"
248 . if "\\$1"6" .ds an-extra2 "4.3 Berkeley Distribution\"
249 . if "\\$1"7" .ds an-extra2 "4.4 Berkeley Distribution\"
253 . ta T .5i \" This sets tabs every .5 inches
257 . ie \\n[.$] .nr PD (v;\\$1)
258 . el .nr PD (.4v >? \n[.V])
261 .\" Redefine these to customize the header & footer
264 . tl '\\*[an-title](\\*[an-section])'\\*[an-extra3]'\\*[an-title](\\*[an-section])'
271 . if o .tl '\\*[an-extra2]'\\*[an-extra1]'\\*[an-page-string]'
272 . if e .tl '\\*[an-page-string]'\\*[an-extra1]'\\*[an-extra2]'
275 . tl '\\*[an-extra2]'\\*[an-extra1]'\\*[an-page-string]'
316 . ie \\n[an-html] \{\
323 . if (\\n[%] > \\n[X]) \{\
324 . nr an-page-letter (\\n[%] - \\n[X])
325 . ds an-page-string \\n[X]\\n[an-page-letter]\"
330 . ds an-page-string "\\*[an-title](\\*[an-section])\"
332 . ds an-page-string \\n[%]\"
348 .if \n[cR] .em an-end
357 . DEVTAG-NH \\n[an-level]
359 . nr an-no-space-flag 1
374 . nr an-no-space-flag 1
391 . if \\n[.$] \,\\$*\/
409 . if \\n[.$] .nr an-prevailing-indent (n;\\$1)
412 . if !\\n[an-div?] \{\
413 . ll -\\n[an-margin]u
420 . if \\n[need_eo_h]>0 .DEVTAG-EO-H
422 . if \\n[need_col2]>0 .DEVTAG-COL 2
427 . if \\n[an-break-flag] \{\
431 . if \\n[an-no-space-flag] \{\
433 . nr an-no-space-flag 0
435 . if \\n[an-div?] .an-do-tag
443 . \" We must emit the diversion in a separate environment to assure
444 . \" that a possible margin character is printed correctly.
450 . ie (\\n[dl] + \\n[an-tag-sep] > \\n[an-prevailing-indent]) \{\
454 . in (\\n[an-margin]u + \\n[an-prevailing-indent]u)
457 . \" In nroff mode, the indentation value should be an integer
458 . \" multiple of the character cell, to avoid different results
459 . \" compared to the .ie part above.
465 . in (\\n[an-margin]u + \\n[an-prevailing-indent]u)
476 . nr an-prevailing-indent \\n[IN]
490 . in (\\n[an-margin]u + \\n[an-prevailing-indent]u)
494 . ie (\\n[.$] - 1) .TP "\\$2"
506 . if \\n[.$] .nr an-prevailing-indent (n;\\$1)
507 . in (\\n[an-margin]u + \\n[an-prevailing-indent]u)
514 .ds an-empty \" this is referenced to avoid looping on, e.g., .RB ( \\ )
518 . ds an-result \&\f[R]\\$1\"
520 . while (\\n[.$] >= 2) \{\
521 . as an-result \,\f[I]\\$1\f[R]\/\\$2\\*[an-empty]\"
524 . if \\n[.$] .as an-result \,\f[I]\\$1\"
532 . ds an-result \&\f[I]\,\\$1\f[R]\"
534 . while (\\n[.$] >= 2) \{\
535 . as an-result \/\\$1\f[I]\,\\$2\f[R]\"
538 . if \\n[.$] .as an-result \/\\$1\"
546 . ds an-result \&\f[I]\,\\$1\"
548 . while (\\n[.$] >= 2) \{\
549 . as an-result \/\f[B]\\$1\f[I]\,\\$2\\*[an-empty]\"
552 . if \\n[.$] .as an-result \/\f[B]\\$1\"
560 . ds an-result \&\f[B]\\$1\"
562 . while (\\n[.$] >= 2) \{\
563 . as an-result \,\f[I]\\$1\f[B]\/\\$2\\*[an-empty]\"
566 . if \\n[.$] .as an-result \,\f[I]\\$1\"
574 . while (\\n[.$] >= 2) \{\
575 . as an-result \f[R]\\$1\f[B]\\$2\\*[an-empty]\"
578 . if \\n[.$] .as an-result \f[R]\\$1\"
585 . while (\\n[.$] >= 2) \{\
586 . as an-result \f[B]\\$1\f[R]\\$2\\*[an-empty]\"
589 . if \\n[.$] .as an-result \f[B]\\$1\"
595 . nr an-saved-margin\\n[an-level] \\n[an-margin]
596 . nr an-saved-prevailing-indent\\n[an-level] \\n[an-prevailing-indent]
597 . ie \\n[.$] .nr an-margin +(n;\\$1)
598 . el .nr an-margin +\\n[an-prevailing-indent]
600 . nr an-prevailing-indent \\n[IN]
605 . ie \\n[.$] .nr an-level ((;\\$1) <? \\n[an-level])
607 . nr an-level (1 >? \\n[an-level])
608 . nr an-margin \\n[an-saved-margin\\n[an-level]]
609 . nr an-prevailing-indent \\n[an-saved-prevailing-indent\\n[an-level]]
617 . if \\n[an-html] \{\
618 . nr an-TS-ll \\n[.l]
633 .\" dummy equation delimiters
635 . if \\n[an-html] \{\
636 . nr an-EQ-ll \\n[.l]
650 . tmc \\*[an-old]: \\n[.F]: line \\n[.c]: 'R' is a string
651 . tm1 " (producing the registered sign), not a macro.
662 .\" These strings must work in compatibility mode also.
665 .ie c\[tm] .ds Tm \(tm\"
680 .\" For UTF-8, map some characters conservatively for the sake
681 .\" of easy cut and paste.
683 .if '\*[.T]'utf8' \{\
692 .\" Load man macro extensions.
695 .\" Load local modifications.
700 .\" ====================================================================
702 .\" ====================================================================
708 .\" vim: set filetype=groff textwidth=72: