tmac/doc-nroff-u

   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
  11 .\"    the documentation and/or other materials provided with the
  12 .\"    distribution.
  13 .\" 3. [Deleted.  See
  14 .\"     ftp://ftp.cs.berkeley.edu/pub/4bsd/README.Impt.License.Change]
  15 .\" 4. Neither the name of the University nor the names of its
  16 .\"    contributors may be used to endorse or promote products derived
  17 .\"    from this software without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS"
  20 .\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  21 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  22 .\" PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR
  23 .\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25 .\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  26 .\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  27 .\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  28 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  29 .\" 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 for multiple pages instead of a single, very long page
  44 .
  45 .if !r cR .nr cR 1
  46 .
  47 .\" the following switch is ignored in nroff mode
  48 .
  49 .nr S 10
  50 .
  51 .\" the 'doc-xx-font' strings must not be empty!
  52 .
  53 .ds doc-caption-font \f[R]
  54 .ds doc-caption-font2 \f[R]
  55 .ds doc-Ad-font \f[I]
  56 .ds doc-Ar-font \f[I]
  57 .ds doc-Cm-font \f[B]
  58 .ds doc-Em-font \f[I]
  59 .ds doc-Er-font \f[R]
  60 .ds doc-Ev-font \f[R]
  61 .ds doc-Fa-font \f[I]
  62 .ds doc-Fd-font \f[B]
  63 .ds doc-Fl-font \f[B]
  64 .ds doc-Fn-font \f[B]
  65 .ds doc-Ft-font \f[I]
  66 .ds doc-Ic-font \f[B]
  67 .ds doc-Li-font \f[R]
  68 .ds doc-Me-font \f[B]
  69 .ds doc-Nm-font \f[B]
  70 .ds doc-No-font \f[R]
  71 .ds doc-Pa-font \f[I]
  72 .ds doc-Sh-font \f[B]
  73 .ds doc-Sy-font \f[B]
  74 .ds doc-Sx-font \f[I]
  75 .ds doc-Tn-font-shape \f[R]
  76 .ds doc-Tn-font-size
  77 .ds doc-Va-font \f[I]
  78 .ds doc-Xr-font \f[R]
  79 .
  80 .ds doc-left-parenthesis \f[R](\f[]
  81 .ds doc-right-parenthesis \f[R])\f[]
  82 .ds lp \f[R](\f[]
  83 .ds rp \f[R])\f[]
  84 .ds doc-left-bracket \f[R][\f[]
  85 .ds doc-right-bracket \f[R]]\f[]
  86 .
  87 .\" miscellaneous
  88 .nr doc-subheader-indent .5i
  89 .nr doc-paragraph-space 1v
  90 .
  91 .ec
  92 .nr doc-digit-width \w'\0\0'u
  93 .nr doc-fixed-width \w'0'
  94 .eo
  95 .
  96 .
  97 .\" NS doc-header-space global register
  98 .\" NS   the space between header and body
  99 .
 100 .nr doc-header-space 0.5i
 101 .
 102 .
 103 .\" NS doc-footer-space global register
 104 .\" NS   the space between body and footer
 105 .
 106 .nr doc-footer-space 0.5i
 107 .
 108 .
 109 .\" NS doc-display-vertical global register
 110 .\" NS   vertical space between list elements etc.
 111 .
 112 .nr doc-display-vertical 0
 113 .
 114 .
 115 .\" NS doc-setup-page-layout macro
 116 .\" NS   set up page layout
 117 .\" NS
 118 .\" NS modifies:
 119 .\" NS   doc-display-vertical
 120 .
 121 .de doc-setup-page-layout
 122 .  ie r LL \
 123 .    ll \n[LL]u
 124 .  el \
 125 .    ll 78n
 126 .
 127 .  ie r LT \
 128 .    lt \n[LT]u
 129 .  el \
 130 .    lt 78n
 131 .
 132 .  po 0i
 133 .
 134 .  nr doc-display-vertical 1v
 135 .  ad l
 136 .  na
 137 ..
 138 .
 139 .
 140 .ec
 141 .
 142 .ds doc-left-singlequote \[oq]
 143 .ds doc-right-singlequote \[cq]
 144 .
 145 .\" the following strings are 'official'
 146 .ds <= \[<=]
 147 .ds >= \[>=]
 148 .ds aa \[aa]
 149 .ds ga \[ga]
 150 .ds q \[dq]
 151 .ds Lq \[lq]
 152 .ds Rq \[rq]
 153 .ds Ne \[!=]
 154 .ds Le \[<=]
 155 .ds Ge \[>=]
 156 .ds Lt <
 157 .ds Gt >
 158 .ds Pm \[+-]
 159 .ds Na \f[I]NaN\f[]
 160 .ds Ba \f[R]|\f[]
 161 .ds Am &
 162 .
 163 .\" Unicode TTYs have all glyph forms; for other TTY character sets we
 164 .\" need character representations which are different from GNU troff's
 165 .\" standard forms.
 166 .ie '\*[.T]'utf8' \{\
 167 .  ds ua \[ua]
 168 .  ds Pi \[*p]
 169 .  ds If \[if]
 170 .\}
 171 .el \{\
 172 .  ds ua ^
 173 .  ds Pi pi
 174 .  ds If infinity
 175 .\}
 176 .
 177 .eo
 178 .
 179 .
 180 .\" NS doc-header-string global string
 181 .\" NS   the final string used for the manual page header
 182 .
 183 .ds doc-header-string
 184 .
 185 .
 186 .\" NS doc-setup-header macro
 187 .\" NS   install and initialize header and footer support
 188 .\" NS
 189 .\" NS modifies:
 190 .\" NS   doc-header-string
 191 .
 192 .de doc-setup-header
 193 .  ds doc-header-string "\*[doc-document-title]
 194 .  if !"\*[doc-section]"Null" \
 195 .    as doc-header-string (\*[doc-section])
 196 .
 197 .  ie \n[cR] \
 198 .    doc-header
 199 .  el \{\
 200 .    wh 0 doc-header
 201 .    wh -1.167i doc-footer
 202 .  \}
 203 .
 204 .  e@ doc-end-macro
 205 ..
 206 .
 207 .
 208 .\" NS doc-get-width macro
 209 .\" NS   computes the width of a string as a multiple of
 210 .\" NS   'doc-fixed-width': '.doc-get-width string'
 211 .\" NS
 212 .\" NS modifies:
 213 .\" NS   doc-width
 214 .
 215 .de doc-get-width
 216 .  nr doc-width \w\a\$1\a
 217 .  ie (\n[doc-width] >= \n[doc-fixed-width]) \{\
 218 .    ie (\n[doc-width] % \n[doc-fixed-width]) \
 219 .      nr doc-width ((\n[doc-width] / \n[doc-fixed-width]) + 1)
 220 .    el \
 221 .      nr doc-width (\n[doc-width] / \n[doc-fixed-width])
 222 .  \}
 223 .  el \
 224 .    nr doc-width 0
 225 ..
 226 .
 227 .
 228 .\" NS doc-get-arg-width macro
 229 .\" NS   computes the width of an argument as a multiple of
 230 .\" NS   'doc-fixed-width': '.doc-get-arg-width arg-index'
 231 .\" NS
 232 .\" NS modifies:
 233 .\" NS   doc-width
 234 .
 235 .de doc-get-arg-width
 236 .  nr doc-width \w\a\*[doc-arg\$1]\a
 237 .  ie (\n[doc-width] >= \n[doc-fixed-width]) \{\
 238 .    ie (\n[doc-width] % \n[doc-fixed-width]) \
 239 .      nr doc-width ((\n[doc-width] / \n[doc-fixed-width]) + 1)
 240 .    el \
 241 .      nr doc-width (\n[doc-width] / \n[doc-fixed-width])
 242 .  \}
 243 .  el \
 244 .    nr doc-width 0
 245 ..
 246 .
 247 .
 248 .\" NS Ql user macro
 249 .\" NS   quoted literal define
 250 .\" NS
 251 .\" NS modifies:
 252 .\" NS   doc-macro-name
 253 .\" NS   doc-quote-left
 254 .\" NS   doc-quote-right
 255 .\" NS
 256 .\" NS width register 'Ql' set in doc-common
 257 .
 258 .de Ql
 259 .  if !\n[doc-arg-limit] \{\
 260 .    ie \n[.$] \
 261 .      ds doc-macro-name Ql
 262 .    el \
 263 .      tm Usage: .Ql argument ... (#\n[.c])
 264 .  \}
 265 .
 266 .  ds doc-quote-left "\*[doc-left-singlequote]
 267 .  ds doc-quote-right "\*[doc-right-singlequote]
 268 .
 269 .  doc-enclose-string \$@
 270 ..
 271 .
 272 .
 273 .ec
 274 .
 275 .\" ====================================================================
 276 .\" Editor settings
 277 .\" ====================================================================
 278 .
 279 .\" Local Variables:
 280 .\" mode: nroff
 281 .\" fill-column: 72
 282 .\" End:
 283 .\" vim: set filetype=groff textwidth=72: