2 .\"@ Definitions used for a tty output device.
3 .\"@ See doc.tmac for more on the mdoc semantic markup language.
5 .\" Copyright (c) 1991, 1993
6 .\" The Regents of the University of California. All rights reserved.
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\" notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\" notice, this list of conditions and the following disclaimer in the
15 .\" documentation and/or other materials provided with the distribution.
17 .\" ftp://ftp.cs.berkeley.edu/pub/4bsd/README.Impt.License.Change]
18 .\" 4. Neither the name of the University nor the names of its contributors
19 .\" may be used to endorse or promote products derived from this software
20 .\" without specific prior written permission.
22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 .\" @(#)doc-nroff 8.1 (Berkeley) 06/08/93
35 .\" Adapted to S-roff by Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
42 .\" use -rD=1 for double-sided printing
46 .\" use -rcR=0 to have multiple pages instead of a single, very long page
50 .\" the following switch is ignored in nroff mode
54 .\" the `doc-xx-font' strings must not be empty!
56 .ds doc-caption-font \f[R]
57 .ds doc-caption-font2 \f[R]
78 .ds doc-Tn-font-shape \f[R]
83 .ds doc-left-parenthesis \f[R](\f[]
84 .ds doc-right-parenthesis \f[R])\f[]
87 .ds doc-left-bracket \f[R][\f[]
88 .ds doc-right-bracket \f[R]]\f[]
91 .nr doc-subheader-indent .5i
92 .nr doc-paragraph-space 1v
95 .nr doc-digit-width \w'\0\0'u
96 .nr doc-fixed-width \w'0'
100 .\" NS doc-header-space global register
101 .\" NS the space between header and body
103 .nr doc-header-space 0.5i
106 .\" NS doc-footer-space global register
107 .\" NS the space between body and footer
109 .nr doc-footer-space 0.5i
112 .\" NS doc-display-vertical global register
113 .\" NS vertical space between list elements etc.
115 .nr doc-display-vertical 0
118 .\" NS doc-setup-page-layout macro
119 .\" NS set up page layout
122 .\" NS doc-display-vertical
124 .de doc-setup-page-layout
137 . nr doc-display-vertical 1v
145 .ds doc-left-singlequote \[oq]
146 .ds doc-right-singlequote \[cq]
148 .\" the following strings are `official'
164 .\" Unicode TTYs have all glyph forms; for other TTY character sets we need
165 .\" character representations which are different from GNU troff's standard
167 .ie '\*[.T]'utf8' \{\
185 .\" NS doc-header-string global string
186 .\" NS the final string used for the manual page header
188 .ds doc-header-string
191 .\" NS doc-setup-header macro
192 .\" NS install and initialize header and footer support
195 .\" NS doc-header-string
198 . ds doc-header-string "\*[doc-document-title]
199 . if !"\*[doc-section]"Null" \
200 . as doc-header-string (\*[doc-section])
206 . wh -1.167i doc-footer
213 .\" NS doc-get-width macro
214 .\" NS computes the width of a string as a multiple of `doc-fixed-width':
215 .\" NS `.doc-get-width string'
221 . nr doc-width \w
\a\$1
\a
222 . ie (\n[doc-width] >= \n[doc-fixed-width]) \{\
223 . ie (\n[doc-width] % \n[doc-fixed-width]) \
224 . nr doc-width ((\n[doc-width] / \n[doc-fixed-width]) + 1)
226 . nr doc-width (\n[doc-width] / \n[doc-fixed-width])
233 .\" NS doc-get-arg-width macro
234 .\" NS computes the width of an argument as a multiple of
235 .\" NS `doc-fixed-width': `.doc-get-arg-width arg-index'
240 .de doc-get-arg-width
241 . nr doc-width \w
\a\*[doc-arg\$1]
\a
242 . ie (\n[doc-width] >= \n[doc-fixed-width]) \{\
243 . ie (\n[doc-width] % \n[doc-fixed-width]) \
244 . nr doc-width ((\n[doc-width] / \n[doc-fixed-width]) + 1)
246 . nr doc-width (\n[doc-width] / \n[doc-fixed-width])
254 .\" NS quoted literal define
257 .\" NS doc-macro-name
258 .\" NS doc-quote-left
259 .\" NS doc-quote-right
261 .\" NS width register `Ql' set in doc-common
264 . if !\n[doc-arg-limit] \{\
266 . ds doc-macro-name Ql
268 . tm Usage: .Ql argument ... (#\n[.c])
271 . ds doc-quote-left "\*[doc-left-singlequote]
272 . ds doc-quote-right "\*[doc-right-singlequote]
274 . doc-enclose-string \$@