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-ditroff 8.1 (Berkeley) 06/08/93
39 .\" use -rD=1 for double-sided printing
43 .\" use -rcR=1 to force the creation of a single, very long page
47 .\" use -rS={11,12} to change the font size from 10pt to 11pt or 12pt.
59 .el \{ .ie (\n[S] == 12) \{\
69 .\" the `doc-xx-font' strings must not be empty!
71 .ds doc-caption-font \f[R]\s[\n[.ps]u]
72 .ds doc-caption-font2 \f[R]\s[\n[.ps]u]
73 .ds doc-Ad-font \f[I]\s[\n[.ps]u]
74 .ds doc-Ar-font \f[CO]\s[\n[.ps]u]
75 .ds doc-Cm-font \f[CB]\s[\n[.ps]u]
76 .ds doc-Em-font \f[I]\s[\n[.ps]u]
77 .ds doc-Er-font \f[C]\s[\n[.ps]u]
78 .ds doc-Ev-font \f[C]\s[\n[.ps]u]
79 .ds doc-Fa-font \f[CO]\s[\n[.ps]u]
80 .ds doc-Fd-font \f[CB]\s[\n[.ps]u]
81 .ds doc-Fl-font \f[CB]\s[\n[.ps]u]
82 .ds doc-Fn-font \f[CB]\s[\n[.ps]u]
83 .ds doc-Ft-font \f[CO]\s[\n[.ps]u]
84 .ds doc-Ic-font \f[CB]\s[\n[.ps]u]
86 .ds doc-Me-font \f[B]\s[\n[.ps]u]
87 .ds doc-Nm-font \f[CB]\s[\n[.ps]u]
88 .ds doc-No-font \f[R]\s[\n[.ps]u]
89 .ds doc-Pa-font \f[C]\s[\n[.ps]u]
90 .ds doc-Sh-font \f[B]\s[\n[.ps]u]
91 .ds doc-Sy-font \f[B]\s[\n[.ps]u]
92 .ds doc-Sx-font \f[B]\s[\n[.ps]u]
93 .ds doc-Tn-font-shape \f[R]
94 \# XXX: adapt to discrete LaTeX font sizes
95 .ds doc-Tn-font-size \s[(\n[.ps]u - 1z)]
96 .ds doc-Va-font \f[I]\s[\n[.ps]u]
97 .ds doc-Xr-font \f[C]\s[\n[.ps]u]
99 .ds doc-left-parenthesis \f[R]\|(\|\f[]\s[\n[.ps]u]
100 .ds doc-right-parenthesis \f[R]\|)\|\f[]\s[\n[.ps]u]
101 .ds lp \f[R](\f[]\s[\n[.ps]u]
102 .ds rp \f[R])\f[]\s[\n[.ps]u]
103 .ds doc-left-bracket \f[R]\^[\^\f[]\s[\n[.ps]u]
104 .ds doc-right-bracket \f[R]\^]\f[]\s[\n[.ps]u]
109 .nr doc-subheader-indent (\w
\a\f[C],
\au * 5u)
110 .nr doc-paragraph-space .5v
112 .nr doc-digit-width \w'\0'u
113 .nr doc-fixed-width \w
\a\f[C]0
\a
118 .\" NS doc-header-space global register
119 .\" NS the space between header and body
121 .nr doc-header-space 0
124 .\" NS doc-footer-space global register
125 .\" NS the space between body and footer
127 .nr doc-footer-space 0
130 .\" NS doc-display-vertical global register
131 .\" NS vertical space between list elements etc.
133 .nr doc-display-vertical 0
136 .\" NS doc-setup-page-layout macro
137 .\" NS set up page layout
140 .\" NS doc-display-vertical
141 .\" NS doc-footer-space
142 .\" NS doc-header-space
144 .de doc-setup-page-layout
145 . nr doc-header-space .5i
146 . nr doc-footer-space .5i
160 . nr doc-display-vertical .5v
164 .ds doc-left-singlequote \[oq]
165 .ds doc-right-singlequote \[cq]
167 .\" the following strings are `official'
191 .\" NS doc-header-string global string
192 .\" NS the final string used for the manual page header
194 .ds doc-header-string
197 .\" NS doc-setup-header macro
198 .\" NS install and initialize header and footer support
201 .\" NS doc-header-string
204 . ds doc-header-string "\*[doc-document-title]
205 . if !"\*[doc-section]"Null" \
206 . as doc-header-string \|(\*[doc-section])
209 . wh -1.25i doc-footer
212 . ds doc-command-name
221 .\" NS doc-get-width macro
222 .\" NS computes the width of a string as a multiple of `doc-fixed-width':
223 .\" NS `.doc-get-width string'
229 . nr doc-width \w
\a\f[C]\$1
\a
230 . ie (\n[doc-width] >= \n[doc-fixed-width]) \{\
231 . ie (\n[doc-width] % \n[doc-fixed-width]) \
232 . nr doc-width ((\n[doc-width] / \n[doc-fixed-width]) + 1)
234 . nr doc-width (\n[doc-width] / \n[doc-fixed-width])
245 .\" NS doc-get-arg-width macro
246 .\" NS computes the width of an argument as a multiple of
247 .\" NS `doc-fixed-width': `.doc-get-arg-width arg-index'
252 .de doc-get-arg-width
253 . nr doc-width \w
\a\f[C]\*[doc-arg\$1]
\a
254 . ie (\n[doc-width] >= \n[doc-fixed-width]) \{\
255 . ie (\n[doc-width] % \n[doc-fixed-width]) \
256 . nr doc-width ((\n[doc-width] / \n[doc-fixed-width]) + 1)
258 . nr doc-width (\n[doc-width] / \n[doc-fixed-width])
270 .\" NS quoted literal define
276 .\" NS doc-macro-name
279 .\" NS doc-quote-left
280 .\" NS doc-quote-right
282 .\" NS local variables:
287 .\" NS width register `Ql' set in doc-common
290 . if !\n[doc-arg-limit] \{\
292 . ds doc-macro-name Ql
296 . tm Usage: .Ql argument ... (#\n[.c])
299 . nr doc-reg-Ql (\n[doc-arg-ptr] + 1)
300 . doc-get-arg-width \n[doc-reg-Ql]
302 . \" don't use quotes if we have more than two succeeding string arguments
304 . if (\n[doc-arg-limit] >= \n[doc-reg-Ql]) \
305 . if (\n[doc-type\n[doc-reg-Ql]] == 2) \
308 . \" make a difference in quotation style for strings longer
309 . \" than two characters
310 . ie (\n[doc-width] > 2) \
313 . ie \n[doc-arg-ptr] \{\
314 . \" we replace `Ql' with `Li'
315 . ds doc-arg\n[doc-arg-ptr] Li
319 . \" if .Ql has been called directly, we must shift all elements in
320 . \" the argument vector to the right so that we can insert `Li'
321 . nr doc-reg-Ql \n[doc-arg-limit]
322 . nr doc-reg-Ql1 (\n[doc-arg-limit] + 1)
323 . while \n[doc-reg-Ql] \{\
324 . rn doc-arg\n[doc-reg-Ql] doc-arg\n[doc-reg-Ql1]
325 . rnn doc-type\n[doc-reg-Ql] doc-type\n[doc-reg-Ql1]
326 . rn doc-space\n[doc-reg-Ql] doc-space\n[doc-reg-Ql1]
333 . nr doc-arg-limit +1
336 . ds doc-quote-left "\*[doc-left-singlequote]
337 . ds doc-quote-right "\*[doc-right-singlequote]