tmac/doc-nroff.new

   1 .\" Copyright (c) 1991 The Regents of the University of California.
   2 .\" 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 5.6 (Berkeley) 8/5/91
  33 .\"
  34 .\"     %beginstrip%
  35 .
  36 .
  37 .\" use -rcR=0 to have multiple pages instead of a single, very long page
  38 .
  39 .if !r cR .nr cR 1
  40 .
  41 .\" the `doc-xx-font' strings must not be empty!
  42 .
  43 .ds doc-caption-font \f[R]
  44 .ds doc-caption-font2 \f[R]
  45 .ds doc-Ad-font \f[I]
  46 .ds doc-Ar-font \f[I]
  47 .ds doc-Cm-font \f[B]
  48 .ds doc-Em-font \f[I]
  49 .ds doc-Er-font \f[R]
  50 .ds doc-Ev-font \f[R]
  51 .ds doc-Fa-font \f[I]
  52 .ds doc-Fd-font \f[B]
  53 .ds doc-Fl-font \f[B]
  54 .ds doc-Fn-font \f[B]
  55 .ds doc-Ft-font \f[I]
  56 .ds doc-Ic-font \f[B]
  57 .ds doc-Li-font \f[R]
  58 .ds doc-Me-font \f[B]
  59 .ds doc-Nm-font \f[B]
  60 .ds doc-No-font \f[R]
  61 .ds doc-Pa-font \f[I]
  62 .ds doc-Sh-font \f[B]
  63 .ds doc-Sy-font \f[B]
  64 .ds doc-Sx-font \f[I]
  65 .ds doc-Tn-font-shape \f[R]
  66 .ds doc-Tn-font-size
  67 .ds doc-Va-font \f[I]
  68 .ds doc-Xr-font \f[R]
  69 .
  70 .ds doc-left-parenthesis \f[R](\f[P]
  71 .ds doc-right-parenthesis \f[R])\f[P]
  72 .ds lp \f[R](\f[P]
  73 .ds rp \f[R])\f[P]
  74 .ds doc-left-bracket \f[R][\f[P]
  75 .ds doc-right-bracket \f[R]]\f[P]
  76 .
  77 .\" miscellaneous
  78 .ds doc-punct-chars {. , : ; ( ) [ ]}
  79 .nr doc-subheader-indent .5i
  80 .nr doc-paragraph-space 1v
  81 .
  82 .ec
  83 .ds doc-digit-string \0\0
  84 .nr doc-digit-width \w'\0\0'u
  85 .nr doc-fixed-width \w'0'
  86 .eo
  87 .
  88 .
  89 .\" NS doc-header-space global register
  90 .\" NS   the space between header and body
  91 .
  92 .nr doc-header-space 0
  93 .
  94 .
  95 .\" NS doc-footer-space global register
  96 .\" NS   the space between body and footer
  97 .
  98 .nr doc-footer-space 0
  99 .
 100 .
 101 .\" NS doc-display-vertical global register
 102 .\" NS   vertical space between list elements etc.
 103 .
 104 .nr doc-display-vertical 0
 105 .
 106 .
 107 .\" NS doc-setup-page-layout macro
 108 .\" NS   set up page layout
 109 .\" NS
 110 .\" NS modifies:
 111 .\" NS   doc-header-space, doc-footer-space, doc-display-vertical
 112 .
 113 .de doc-setup-page-layout
 114 .  ie \n[cR] \
 115 .    nr doc-header-space 0
 116 .  el \
 117 .    nr doc-header-space .5i
 118 .  nr doc-footer-space .5i
 119 .
 120 .  ll 78n
 121 .  lt 78n
 122 .  po 0i
 123 .
 124 .  nr doc-display-vertical 1v
 125 .  ad l
 126 .  na
 127 ..
 128 .
 129 .
 130 .ds <= \&<\&=
 131 .ds >= \&>\&=
 132 .
 133 .\" Lq and Rq are `official'
 134 .ds Rq ''
 135 .ds Lq ``
 136 .ds ua ^
 137 .ds aa \'
 138 .ds ga \`
 139 .ds doc-left-singlequote `
 140 .ds doc-right-singlequote '
 141 .\" q is `official'
 142 .ds q \[dq]
 143 .
 144 .\" math stuff -- all macro names are `official'
 145 .ds Pi pi
 146 .ds Ne !=
 147 .ds Le <=
 148 .ds Ge >=
 149 .ds Lt <
 150 .ds Gt >
 151 .ds Pm +-
 152 .ds If infinity
 153 .ds Na \f[I]NaN\f[P]
 154 .ds Ba \f[R]|\f[P]
 155 .
 156 .
 157 .\" NS doc-header-string global string
 158 .\" NS   the final string used for the manual page header
 159 .
 160 .ds doc-header-string
 161 .
 162 .
 163 .\" NS doc-setup-header macro
 164 .\" NS   install and initialize header and footer support
 165 .\" NS
 166 .\" NS modifies:
 167 .\" NS   doc-header-string
 168 .
 169 .de doc-setup-header
 170 .  nr % 1
 171 .  ds doc-header-string "\*[doc-document-title]
 172 .  if !"\*[doc-section]"Null" \
 173 .    as doc-header-string (\*[doc-section])
 174 .
 175 .  ie \n[cR] \
 176 .    doc-header
 177 .  el \{\
 178 .    wh 0 doc-header
 179 .    wh -1.167i doc-footer
 180 .  \}
 181 .
 182 .  if ((\n[nl] == 0) : (\n[nl] == -1)) \
 183 '    bp
 184 .
 185 .  e@ doc-end-macro
 186 ..
 187 .
 188 .
 189 .\" NS doc-get-width macro
 190 .\" NS   computes the width of a string as a multiple of `doc-fixed-width':
 191 .\" NS   `.doc-get-width string'
 192 .\" NS
 193 .\" NS modifies:
 194 .\" NS   doc-width
 195 .
 196 .de doc-get-width
 197 .  nr doc-width \w\a\$1\a
 198 .  ie (\n[doc-width] >= \n[doc-fixed-width]) \{\
 199 .    ie (\n[doc-width] % \n[doc-fixed-width]) \
 200 .      nr doc-width ((\n[doc-width] / \n[doc-fixed-width]) + 1)
 201 .    el \
 202 .      nr doc-width (\n[doc-width] / \n[doc-fixed-width])
 203 .  \}
 204 .  el \
 205 .    nr doc-width 0
 206 ..
 207 .
 208 .
 209 .\" NS doc-get-arg-width macro
 210 .\" NS   computes the width of an argument as a multiple of
 211 .\" NS   `doc-fixed-width': `.doc-get-arg-width arg-index'
 212 .\" NS
 213 .\" NS modifies:
 214 .\" NS   doc-width
 215 .
 216 .de doc-get-arg-width
 217 .  nr doc-width \w\a\*[doc-arg\$1]\a
 218 .  ie (\n[doc-width] >= \n[doc-fixed-width]) \{\
 219 .    ie (\n[doc-width] % \n[doc-fixed-width]) \
 220 .      nr doc-width ((\n[doc-width] / \n[doc-fixed-width]) + 1)
 221 .    el \
 222 .      nr doc-width (\n[doc-width] / \n[doc-fixed-width])
 223 .  \}
 224 .  el \
 225 .    nr doc-width 0
 226 ..
 227 .
 228 .
 229 .\" NS Ql user macro
 230 .\" NS   quoted literal define
 231 .\" NS
 232 .\" NS modifies:
 233 .\" NS   doc-macro-name, doc-quote-left, doc-quote-right
 234 .\" NS
 235 .\" NS width register `Ql' set in doc-common
 236 .
 237 .de Ql
 238 .  if !\n[doc-arg-limit] \{\
 239 .    ie \n[.$] \
 240 .      ds doc-macro-name Ql
 241 .    el \
 242 .      tm Usage: .Ql argument ... \*[doc-punct-chars] (#\n[.c])
 243 .  \}
 244 .
 245 .  ds doc-quote-left "\*[doc-left-singlequote]
 246 .  ds doc-quote-right "\*[doc-right-singlequote]
 247 .
 248 .  doc-enclose-string \$@
 249 ..
 250 .
 251 .
 252 .\" NS doc-in-see-also-section global register (bool)
 253 .\" NS   whether we are in the `see also' section
 254 .
 255 .nr doc-in-see-also-section 0
 256 .
 257 .
 258 .\" NS doc-in-files-section global register (bool)
 259 .\" NS   whether we are in the `files' section
 260 .
 261 .nr doc-in-files-section 0
 262 .
 263 .
 264 .\" NS doc-in-authors-section global register (bool)
 265 .\" NS   whether we are in the `authors' section
 266 .
 267 .nr doc-in-authors-section 0
 268 .
 269 .
 270 .\" NS Sh user macro (not parsed, not callable)
 271 .\" NS   section headers
 272 .\" NS
 273 .\" NS modifies:
 274 .\" NS   doc-in-synopsis-count, doc-indent-synopsis, doc-in-files-section,
 275 .\" NS   doc-in-see-also-section, doc-in-authors-section, doc-is-func,
 276 .\" NS   doc-func-count, doc-func-args-processed, doc-num-func-args,
 277 .\" NS   doc-func-arg
 278 .\" NS
 279 .\" NS local variable:
 280 .\" NS   doc-reg-Sh
 281 .\" NS
 282 .\" NS width register `Sh' set in doc-common
 283 .
 284 .de Sh
 285 .  nr doc-in-synopsis-count 0
 286 .  nr doc-indent-synopsis 0
 287 .
 288 .  ie "\$1"NAME" \{\
 289 .    doc-setup-header
 290 '    in 0
 291 .  \}
 292 .  el \{\
 293 .    nr doc-in-see-also-section 0
 294 .    nr doc-in-files-section 0
 295 .    nr doc-in-authors-section 0
 296 .
 297 .    if "\$1"SYNOPSIS" \
 298 .      nr doc-in-synopsis-count 1
 299 .    if "\$1"DESCRIPTION" \{\
 300 .      nr doc-is-func 0
 301 .      nr doc-func-count 0
 302 .      nr doc-func-args-processed 0
 303 .      nr doc-num-func-args 0
 304 .      ds doc-func-arg
 305 .    \}
 306 .    if "\$1"SEE" \
 307 .      nr doc-in-see-also-section 1
 308 .    if "\$1"FILES" \
 309 .      nr doc-in-files-section 1
 310 .    if "\$1"AUTHORS" \
 311 .      nr doc-in-authors-section 1
 312 .
 313 .    in 0
 314 .    nr doc-have-author 0
 315 .  \}
 316 .
 317 .  doc-setup-page-layout
 318 '  sp
 319 .  ns
 320 .  ta T .5i
 321 .  if !\n[cR] \
 322 .    ne 3
 323 '  fi
 324 .
 325 .  ie \n[.$] \{\
 326 .    nop \*[doc-Sh-font]\$1\c
 327 .    nr doc-reg-Sh 2
 328 .    while (\n[doc-reg-Sh] <= \n[.$]) \{\
 329 .      nop \& \$[\n[doc-reg-Sh]]\c
 330 .      nr doc-reg-Sh +1
 331 .    \}
 332 .    nop \f[P]\s[0]
 333 .  \}
 334 .  el \
 335 .    tm Usage: .Sh section_name ... (#\n[.c])
 336 .
 337 .  in (\n[.i]u + \n[doc-subheader-indent]u)
 338 .  ns
 339 ..
 340 .
 341 .\" EOF