tmac/doc-nroff

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