Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.git] / contrib / groff / tmac / doc-nroff
CommitLineData
984263bc
MD
1.\" Copyright (c) 1991, 1993
2.\" The Regents of the University of California. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
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.
19.\"
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
30.\" SUCH DAMAGE.
31.\"
32.\" @(#)doc-nroff 8.1 (Berkeley) 06/08/93
33.\" $FreeBSD: src/contrib/groff/tmac/doc-nroff,v 1.1.1.1.8.6 2003/02/14 15:22:11 ru Exp $
1de703da 34.\" $DragonFly: src/contrib/groff/tmac/Attic/doc-nroff,v 1.2 2003/06/17 04:24:02 dillon Exp $
984263bc
MD
35.\"
36.\" %beginstrip%
37.
38.
39.eo
40.
41.\" use -rD=1 for double-sided printing
42.
43.if !r D .nr D 0
44.
45.\" use -rcR=0 to have multiple pages instead of a single, very long page
46.
47.if !r cR .nr cR 1
48.
49.\" the following switches are ignored in nroff mode
50.
51.nr S 10
52.nr C 0
53.
54.\" the `doc-xx-font' strings must not be empty!
55.
56.ds doc-caption-font \f[R]
57.ds doc-caption-font2 \f[R]
58.ds doc-Ad-font \f[I]
59.ds doc-Ar-font \f[I]
60.ds doc-Cm-font \f[B]
61.ds doc-Em-font \f[I]
62.ds doc-Er-font \f[R]
63.ds doc-Ev-font \f[R]
64.ds doc-Fa-font \f[I]
65.ds doc-Fd-font \f[B]
66.ds doc-Fl-font \f[B]
67.ds doc-Fn-font \f[B]
68.ds doc-Ft-font \f[I]
69.ds doc-Ic-font \f[B]
70.ds doc-Li-font \f[R]
71.ds doc-Me-font \f[B]
72.ds doc-Nm-font \f[B]
73.ds doc-No-font \f[R]
74.ds doc-Pa-font \f[I]
75.ds doc-Sh-font \f[B]
76.ds doc-Sy-font \f[B]
77.ds doc-Sx-font \f[I]
78.ds doc-Tn-font-shape \f[R]
79.ds doc-Tn-font-size
80.ds doc-Va-font \f[I]
81.ds doc-Xr-font \f[R]
82.
83.ds doc-left-parenthesis \f[R](\f[]
84.ds doc-right-parenthesis \f[R])\f[]
85.ds lp \f[R](\f[]
86.ds rp \f[R])\f[]
87.ds doc-left-bracket \f[R][\f[]
88.ds doc-right-bracket \f[R]]\f[]
89.
90.\" miscellaneous
91.nr doc-subheader-indent .5i
92.nr doc-paragraph-space 1v
93.
94.ec
95.nr doc-digit-width \w'\0\0'u
96.nr doc-fixed-width \w'0'
97.eo
98.
99.
100.\" NS doc-header-space global register
101.\" NS the space between header and body
102.
103.nr doc-header-space 0
104.
105.
106.\" NS doc-footer-space global register
107.\" NS the space between body and footer
108.
109.nr doc-footer-space 0
110.
111.
112.\" NS doc-display-vertical global register
113.\" NS vertical space between list elements etc.
114.
115.nr doc-display-vertical 0
116.
117.
118.\" NS doc-setup-page-layout macro
119.\" NS set up page layout
120.\" NS
121.\" NS modifies:
122.\" NS doc-display-vertical
123.\" NS doc-footer-space
124.\" NS doc-header-space
125.
126.de doc-setup-page-layout
127. ie \n[cR] \
128. nr doc-header-space 0
129. el \
130. nr doc-header-space .5i
131. nr doc-footer-space .5i
132.
133. ie r LL \
134. ll \n[LL]u
135. el \
136. ll 78n
137.
138. ie r LT \
139. lt \n[LT]u
140. el \
141. lt 78n
142.
143. po 0i
144.
145. nr doc-display-vertical 1v
146. ad l
147. na
148..
149.
150.
151.ec
152.
153.ds doc-left-singlequote \[oq]
154.ds doc-right-singlequote \[cq]
155.
156.\" the following strings are `official'
157.ds <= \[<=]
158.ds >= \[>=]
159.ds aa \[aa]
160.ds ga \[ga]
161.ds q \[dq]
162.ds Ne \[!=]
163.ds Le \[<=]
164.ds Ge \[>=]
165.ds Lt <
166.ds Gt >
167.ds Pm \[+-]
168.ds Na \f[I]NaN\f[]
169.ds Ba \f[R]|\f[]
170.ds Am &
171.
172.\" Unicode TTYs have all glyph forms; for other TTY character sets we need
173.\" character representations which are different from GNU troff's standard
174.\" forms.
175.ie '\*[.T]'utf8' \{\
176. ds Rq \[rq]
177. ds Lq \[lq]
178. ds ua \[ua]
179. ds Pi \[*p]
180. ds If \[if]
181.\}
182.el \{\
183. ds Rq ''
184. ds Lq ``
185. ds ua ^
186. ds Pi pi
187. ds If infinity
188.\}
189.
190.eo
191.
192.
193.\" NS doc-header-string global string
194.\" NS the final string used for the manual page header
195.
196.ds doc-header-string
197.
198.
199.\" NS doc-setup-header macro
200.\" NS install and initialize header and footer support
201.\" NS
202.\" NS modifies:
203.\" NS doc-header-string
204.
205.de doc-setup-header
206. nr % 1
207. ds doc-header-string "\*[doc-document-title]
208. if !"\*[doc-section]"Null" \
209. as doc-header-string (\*[doc-section])
210.
211. ie \n[cR] \
212. doc-header
213. el \{\
214. wh 0 doc-header
215. wh -1.167i doc-footer
216. \}
217.
218. if ((\n[nl] == 0) : (\n[nl] == -1)) \
219' bp
220.
221. e@ doc-end-macro
222..
223.
224.
225.\" NS doc-get-width macro
226.\" NS computes the width of a string as a multiple of `doc-fixed-width':
227.\" NS `.doc-get-width string'
228.\" NS
229.\" NS modifies:
230.\" NS doc-width
231.
232.de doc-get-width
233. nr doc-width \w\a\$1\a
234. ie (\n[doc-width] >= \n[doc-fixed-width]) \{\
235. ie (\n[doc-width] % \n[doc-fixed-width]) \
236. nr doc-width ((\n[doc-width] / \n[doc-fixed-width]) + 1)
237. el \
238. nr doc-width (\n[doc-width] / \n[doc-fixed-width])
239. \}
240. el \
241. nr doc-width 0
242..
243.
244.
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'
248.\" NS
249.\" NS modifies:
250.\" NS doc-width
251.
252.de doc-get-arg-width
253. nr doc-width \w\a\*[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)
257. el \
258. nr doc-width (\n[doc-width] / \n[doc-fixed-width])
259. \}
260. el \
261. nr doc-width 0
262..
263.
264.
265.\" NS Ql user macro
266.\" NS quoted literal define
267.\" NS
268.\" NS modifies:
269.\" NS doc-macro-name
270.\" NS doc-quote-left
271.\" NS doc-quote-right
272.\" NS
273.\" NS width register `Ql' set in doc-common
274.
275.de Ql
276. if !\n[doc-arg-limit] \{\
277. ie \n[.$] \
278. ds doc-macro-name Ql
279. el \
280. tm Usage: .Ql argument ... (#\n[.c])
281. \}
282.
283. ds doc-quote-left "\*[doc-left-singlequote]
284. ds doc-quote-right "\*[doc-right-singlequote]
285.
286. doc-enclose-string \$@
287..
288.
289.
290.ec
291.
292.\" EOF