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 -rC=1 to number pages continuously
43
.\" use -rD=1 for double-sided printing
47
.\" use -rcR=1 to force the creation of a single, very long page
51
.\" use -rS={11,12} to change the font size from 10pt to 11pt or 12pt.
63
.el \{ .ie (\n[S] == 12) \{\
73
.\" the `doc-xx-font' strings must not be empty!
75
.ds doc-caption-font \f[R]\s[\n[.ps]u]
76
.ds doc-caption-font2 \f[R]\s[\n[.ps]u]
77
.ds doc-Ad-font \f[I]\s[\n[.ps]u]
78
.ds doc-Ar-font \f[CO]\s[\n[.ps]u]
79
.ds doc-Cm-font \f[CB]\s[\n[.ps]u]
80
.ds doc-Em-font \f[I]\s[\n[.ps]u]
81
.ds doc-Er-font \f[C]\s[\n[.ps]u]
82
.ds doc-Ev-font \f[C]\s[\n[.ps]u]
83
.ds doc-Fa-font \f[CO]\s[\n[.ps]u]
84
.ds doc-Fd-font \f[CB]\s[\n[.ps]u]
85
.ds doc-Fl-font \f[CB]\s[\n[.ps]u]
86
.ds doc-Fn-font \f[CB]\s[\n[.ps]u]
87
.ds doc-Ft-font \f[CO]\s[\n[.ps]u]
88
.ds doc-Ic-font \f[CB]\s[\n[.ps]u]
90
.ds doc-Me-font \f[B]\s[\n[.ps]u]
91
.ds doc-Nm-font \f[CB]\s[\n[.ps]u]
92
.ds doc-No-font \f[R]\s[\n[.ps]u]
93
.ds doc-Pa-font \f[C]\s[\n[.ps]u]
94
.ds doc-Sh-font \f[B]\s[\n[.ps]u]
95
.ds doc-Sy-font \f[B]\s[\n[.ps]u]
96
.ds doc-Sx-font \f[B]\s[\n[.ps]u]
97
.ds doc-Tn-font-shape \f[R]
98
\# XXX: adapt to discrete LaTeX font sizes
99
.ds doc-Tn-font-size \s[(\n[.ps]u - 1z)]
100
.ds doc-Va-font \f[I]\s[\n[.ps]u]
101
.ds doc-Xr-font \f[C]\s[\n[.ps]u]
103
.ds doc-left-parenthesis \f[R]\|(\|\f[P]\s[\n[.ps]u]
104
.ds doc-right-parenthesis \f[R]\|)\|\f[P]\s[\n[.ps]u]
105
.ds lp \f[R](\f[P]\s[\n[.ps]u]
106
.ds rp \f[R])\f[P]\s[\n[.ps]u]
107
.ds doc-left-bracket \f[R]\^[\^\f[P]\s[\n[.ps]u]
108
.ds doc-right-bracket \f[R]\^]\f[P]\s[\n[.ps]u]
113
.nr doc-subheader-indent (\w\f[C],u * 5u)
114
.nr doc-paragraph-space .5v
116
.nr doc-digit-width \w'\0'u
117
.nr doc-fixed-width \w\f[C]0
122
.\" NS doc-header-space global register
123
.\" NS the space between header and body
125
.nr doc-header-space 0
128
.\" NS doc-footer-space global register
129
.\" NS the space between body and footer
131
.nr doc-footer-space 0
134
.\" NS doc-display-vertical global register
135
.\" NS vertical space between list elements etc.
137
.nr doc-display-vertical 0
140
.\" NS doc-setup-page-layout macro
141
.\" NS set up page layout
144
.\" NS doc-display-vertical
145
.\" NS doc-footer-space
146
.\" NS doc-header-space
148
.de doc-setup-page-layout
149
. nr doc-header-space .5i
150
. nr doc-footer-space .5i
156
. nr doc-display-vertical .5v
160
.ds doc-left-singlequote \[oq]
161
.ds doc-right-singlequote \[cq]
163
.\" the following strings are `official'
186
.\" NS doc-header-string global string
187
.\" NS the final string used for the manual page header
189
.ds doc-header-string
192
.\" NS doc-setup-header macro
193
.\" NS install and initialize header and footer support
196
.\" NS doc-header-string
199
. ds doc-header-string "\*[doc-document-title]
200
. if !"\*[doc-section]"Null" \
201
. as doc-header-string \|(\*[doc-section])
204
. wh -1.25i doc-footer
208
. ds doc-command-name
212
. \" Don't set the page number if this is the first page,
213
. \" in case the user has used -n.
223
.\" NS doc-get-width macro
224
.\" NS computes the width of a string as a multiple of `doc-fixed-width':
225
.\" NS `.doc-get-width string'
231
. nr doc-width \w\f[C]\$1
232
. ie (\n[doc-width] >= \n[doc-fixed-width]) \{\
233
. ie (\n[doc-width] % \n[doc-fixed-width]) \
234
. nr doc-width ((\n[doc-width] / \n[doc-fixed-width]) + 1)
236
. nr doc-width (\n[doc-width] / \n[doc-fixed-width])
247
.\" NS doc-get-arg-width macro
248
.\" NS computes the width of an argument as a multiple of
249
.\" NS `doc-fixed-width': `.doc-get-arg-width arg-index'
254
.de doc-get-arg-width
255
. nr doc-width \w\f[C]\*[doc-arg\$1]
256
. ie (\n[doc-width] >= \n[doc-fixed-width]) \{\
257
. ie (\n[doc-width] % \n[doc-fixed-width]) \
258
. nr doc-width ((\n[doc-width] / \n[doc-fixed-width]) + 1)
260
. nr doc-width (\n[doc-width] / \n[doc-fixed-width])
272
.\" NS quoted literal define
278
.\" NS doc-macro-name
281
.\" NS doc-quote-left
282
.\" NS doc-quote-right
284
.\" NS local variables:
289
.\" NS width register `Ql' set in doc-common
292
. if !\n[doc-arg-limit] \{\
294
. ds doc-macro-name Ql
298
. tm Usage: .Ql argument ... (#\n[.c])
301
. nr doc-reg-Ql (\n[doc-arg-ptr] + 1)
302
. doc-get-arg-width \n[doc-reg-Ql]
304
. \" don't use quotes if we have more than two succeeding string arguments
306
. if (\n[doc-arg-limit] >= \n[doc-reg-Ql]) \
307
. if (\n[doc-type\n[doc-reg-Ql]] == 2) \
310
. \" make a difference in quotation style for strings longer
311
. \" than two characters
312
. ie (\n[doc-width] > 2) \
315
. ie \n[doc-arg-ptr] \{\
316
. \" we replace `Ql' with `Li'
317
. ds doc-arg\n[doc-arg-ptr] Li
321
. \" if .Ql has been called directly, we must shift all elements in
322
. \" the argument vector to the right so that we can insert `Li'
323
. nr doc-reg-Ql \n[doc-arg-limit]
324
. nr doc-reg-Ql1 (\n[doc-arg-limit] + 1)
325
. while \n[doc-reg-Ql] \{\
326
. rn doc-arg\n[doc-reg-Ql] doc-arg\n[doc-reg-Ql1]
327
. rnn doc-type\n[doc-reg-Ql] doc-type\n[doc-reg-Ql1]
328
. rn doc-space\n[doc-reg-Ql] doc-space\n[doc-reg-Ql1]
335
. nr doc-arg-limit +1
338
. ds doc-quote-left "\*[doc-left-singlequote]
339
. ds doc-quote-right "\*[doc-right-singlequote]
added
removed
tmac/doc-ditroff
