1 .\" Copyright (c) 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .\" @(#)doc-nroff 8.1 (Berkeley) 06/08/93
39 .\" use -rD=1 for double-sided printing
43 .\" use -rcR=0 to have multiple pages instead of a single, very long page
47 .\" the following switch is ignored in nroff mode
51 .\" the `doc-xx-font' strings must not be empty!
53 .ds doc-caption-font \f[R]
54 .ds doc-caption-font2 \f[R]
75 .ds doc-Tn-font-shape \f[R]
80 .ds doc-left-parenthesis \f[R](\f[]
81 .ds doc-right-parenthesis \f[R])\f[]
84 .ds doc-left-bracket \f[R][\f[]
85 .ds doc-right-bracket \f[R]]\f[]
88 .nr doc-subheader-indent .5i
89 .nr doc-paragraph-space 1v
92 .nr doc-digit-width \w'\0\0'u
93 .nr doc-fixed-width \w'0'
97 .\" NS doc-header-space global register
98 .\" NS the space between header and body
100 .nr doc-header-space 0
103 .\" NS doc-footer-space global register
104 .\" NS the space between body and footer
106 .nr doc-footer-space 0
109 .\" NS doc-display-vertical global register
110 .\" NS vertical space between list elements etc.
112 .nr doc-display-vertical 0
115 .\" NS doc-setup-page-layout macro
116 .\" NS set up page layout
119 .\" NS doc-display-vertical
120 .\" NS doc-footer-space
121 .\" NS doc-header-space
123 .de doc-setup-page-layout
124 . nr doc-header-space .5i
125 . nr doc-footer-space .5i
139 . nr doc-display-vertical 1v
147 .ds doc-left-singlequote \[oq]
148 .ds doc-right-singlequote \[cq]
150 .\" the following strings are `official'
166 .\" Unicode TTYs have all glyph forms; for other TTY character sets we need
167 .\" character representations which are different from GNU troff's standard
169 .ie '\*[.T]'utf8' \{\
187 .\" NS doc-header-string global string
188 .\" NS the final string used for the manual page header
190 .ds doc-header-string
193 .\" NS doc-setup-header macro
194 .\" NS install and initialize header and footer support
197 .\" NS doc-header-string
200 . ds doc-header-string "\*[doc-document-title]
201 . if !"\*[doc-section]"Null" \
202 . as doc-header-string (\*[doc-section])
208 . wh -1.167i doc-footer
215 .\" NS doc-get-width macro
216 .\" NS computes the width of a string as a multiple of `doc-fixed-width':
217 .\" NS `.doc-get-width string'
223 . nr doc-width \w
\a\$1
\a
224 . ie (\n[doc-width] >= \n[doc-fixed-width]) \{\
225 . ie (\n[doc-width] % \n[doc-fixed-width]) \
226 . nr doc-width ((\n[doc-width] / \n[doc-fixed-width]) + 1)
228 . nr doc-width (\n[doc-width] / \n[doc-fixed-width])
235 .\" NS doc-get-arg-width macro
236 .\" NS computes the width of an argument as a multiple of
237 .\" NS `doc-fixed-width': `.doc-get-arg-width arg-index'
242 .de doc-get-arg-width
243 . nr doc-width \w
\a\*[doc-arg\$1]
\a
244 . ie (\n[doc-width] >= \n[doc-fixed-width]) \{\
245 . ie (\n[doc-width] % \n[doc-fixed-width]) \
246 . nr doc-width ((\n[doc-width] / \n[doc-fixed-width]) + 1)
248 . nr doc-width (\n[doc-width] / \n[doc-fixed-width])
256 .\" NS quoted literal define
259 .\" NS doc-macro-name
260 .\" NS doc-quote-left
261 .\" NS doc-quote-right
263 .\" NS width register `Ql' set in doc-common
266 . if !\n[doc-arg-limit] \{\
268 . ds doc-macro-name Ql
270 . tm Usage: .Ql argument ... (#\n[.c])
273 . ds doc-quote-left "\*[doc-left-singlequote]
274 . ds doc-quote-right "\*[doc-right-singlequote]
276 . doc-enclose-string \$@