contrib/groff-1.19/tmac/doc-ditroff

   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-ditroff 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=1 to force the creation of a single, very long page
  44 .
  45 .if !r cR .nr cR 0
  46 .
  47 .\" use -rS={11,12} to change the font size from 10pt to 11pt or 12pt.
  48 .
  49 .if !r S .nr S 10
  50 .
  51 .
  52 .ec
  53 .
  54 .
  55 .ie        (\n[S] == 11) \{\
  56 .  ps 10.95z
  57 .  vs 13.6p
  58 .\}
  59 .el \{ .ie (\n[S] == 12) \{\
  60 .  ps 12z
  61 .  vs 14.5p
  62 .\}
  63 .el \{\
  64 .  ps 10z
  65 .  vs 12p
  66 .\}\}
  67 .
  68 .
  69 .\" the `doc-xx-font' strings must not be empty!
  70 .
  71 .ds doc-caption-font \f[R]\s[\n[.ps]u]
  72 .ds doc-caption-font2 \f[R]\s[\n[.ps]u]
  73 .ds doc-Ad-font \f[I]\s[\n[.ps]u]
  74 .ds doc-Ar-font \f[CO]\s[\n[.ps]u]
  75 .ds doc-Cm-font \f[CB]\s[\n[.ps]u]
  76 .ds doc-Em-font \f[I]\s[\n[.ps]u]
  77 .ds doc-Er-font \f[C]\s[\n[.ps]u]
  78 .ds doc-Ev-font \f[C]\s[\n[.ps]u]
  79 .ds doc-Fa-font \f[CO]\s[\n[.ps]u]
  80 .ds doc-Fd-font \f[CB]\s[\n[.ps]u]
  81 .ds doc-Fl-font \f[CB]\s[\n[.ps]u]
  82 .ds doc-Fn-font \f[CB]\s[\n[.ps]u]
  83 .ds doc-Ft-font \f[CO]\s[\n[.ps]u]
  84 .ds doc-Ic-font \f[CB]\s[\n[.ps]u]
  85 .ds doc-Li-font \f[C]
  86 .ds doc-Me-font \f[B]\s[\n[.ps]u]
  87 .ds doc-Nm-font \f[CB]\s[\n[.ps]u]
  88 .ds doc-No-font \f[R]\s[\n[.ps]u]
  89 .ds doc-Pa-font \f[C]\s[\n[.ps]u]
  90 .ds doc-Sh-font \f[B]\s[\n[.ps]u]
  91 .ds doc-Sy-font \f[B]\s[\n[.ps]u]
  92 .ds doc-Sx-font \f[B]\s[\n[.ps]u]
  93 .ds doc-Tn-font-shape \f[R]
  94 \# XXX: adapt to discrete LaTeX font sizes
  95 .ds doc-Tn-font-size \s[(\n[.ps]u - 1z)]
  96 .ds doc-Va-font \f[I]\s[\n[.ps]u]
  97 .ds doc-Xr-font \f[C]\s[\n[.ps]u]
  98 .
  99 .ds doc-left-parenthesis \f[R]\|(\|\f[]\s[\n[.ps]u]
 100 .ds doc-right-parenthesis \f[R]\|)\|\f[]\s[\n[.ps]u]
 101 .ds lp \f[R](\f[]\s[\n[.ps]u]
 102 .ds rp \f[R])\f[]\s[\n[.ps]u]
 103 .ds doc-left-bracket \f[R]\^[\^\f[]\s[\n[.ps]u]
 104 .ds doc-right-bracket \f[R]\^]\f[]\s[\n[.ps]u]
 105 .
 106 .tr *\[**]
 107 .
 108 .\" miscellaneous
 109 .nr doc-subheader-indent (\w\a\f[C],\au * 5u)
 110 .nr doc-paragraph-space .5v
 111 .
 112 .nr doc-digit-width \w'\0'u
 113 .nr doc-fixed-width \w\a\f[C]0\a
 114 .
 115 .eo
 116 .
 117 .
 118 .\" NS doc-header-space global register
 119 .\" NS   the space between header and body
 120 .
 121 .nr doc-header-space .5i
 122 .
 123 .
 124 .\" NS doc-footer-space global register
 125 .\" NS   the space between body and footer
 126 .
 127 .nr doc-footer-space .5i
 128 .
 129 .
 130 .\" NS doc-display-vertical global register
 131 .\" NS   vertical space between list elements etc.
 132 .
 133 .nr doc-display-vertical 0
 134 .
 135 .
 136 .\" NS doc-setup-page-layout macro
 137 .\" NS   set up page layout
 138 .\" NS
 139 .\" NS modifies:
 140 .\" NS   doc-display-vertical
 141 .
 142 .de doc-setup-page-layout
 143 .  ie r LL \
 144 .    ll \n[LL]u
 145 .  el \
 146 .    ll 6.5i
 147 .
 148 .  ie r LT \
 149 .    lt \n[LT]u
 150 .  el \
 151 .    lt 6.5i
 152 .
 153 .  po 1i
 154 .
 155 .  nr doc-display-vertical .5v
 156 ..
 157 .
 158 .
 159 .ds doc-left-singlequote \[oq]
 160 .ds doc-right-singlequote \[cq]
 161 .
 162 .\" the following strings are `official'
 163 .ds <= \[<=]
 164 .ds >= \[>=]
 165 .ds Lq \[lq]
 166 .ds Rq \[rq]
 167 .ds ua \[ua]
 168 .ds aa \[aa]
 169 .ds ga \[ga]
 170 .ds q \[dq]
 171 .ds Pi \[*p]
 172 .ds Ne \[!=]
 173 .ds Le \[<=]
 174 .ds Ge \[>=]
 175 .ds Lt <
 176 .ds Gt >
 177 .ds Pm \[+-]
 178 .ds If \[if]
 179 .ds Na \f[I]NaN\f[]
 180 .ds Ba \f[R]|\f[]
 181 .ds Am &
 182 .
 183 .nr gX 0
 184 .
 185 .
 186 .\" NS doc-header-string global string
 187 .\" NS   the final string used for the manual page header
 188 .
 189 .ds doc-header-string
 190 .
 191 .
 192 .\" NS doc-setup-header macro
 193 .\" NS   install and initialize header and footer support
 194 .\" NS
 195 .\" NS modifies:
 196 .\" NS   doc-header-string
 197 .
 198 .de doc-setup-header
 199 .  ds doc-header-string "\*[doc-document-title]
 200 .  if !"\*[doc-section]"Null" \
 201 .    as doc-header-string \|(\*[doc-section])
 202 .
 203 .  wh 0 doc-header
 204 .  wh -1.25i doc-footer
 205 .
 206 .  if \n[gX] \
 207 .    ds doc-command-name
 208 .
 209 .  br
 210 .
 211 .  nr gX 0
 212 .  e@ doc-end-macro
 213 ..
 214 .
 215 .
 216 .\" NS doc-get-width macro
 217 .\" NS   computes the width of a string as a multiple of `doc-fixed-width':
 218 .\" NS   `.doc-get-width string'
 219 .\" NS
 220 .\" NS modifies:
 221 .\" NS   doc-width
 222 .
 223 .de doc-get-width
 224 .  nr doc-width \w\a\f[C]\$1\a
 225 .  ie (\n[doc-width] >= \n[doc-fixed-width]) \{\
 226 .    ie (\n[doc-width] % \n[doc-fixed-width]) \
 227 .      nr doc-width ((\n[doc-width] / \n[doc-fixed-width]) + 1)
 228 .    el \
 229 .      nr doc-width (\n[doc-width] / \n[doc-fixed-width])
 230 .  \}
 231 .  el \{\
 232 .    ie \n[doc-width] \
 233 .      nr doc-width 1
 234 .    el \
 235 .      nr doc-width 0
 236 .  \}
 237 ..
 238 .
 239 .
 240 .\" NS doc-get-arg-width macro
 241 .\" NS   computes the width of an argument as a multiple of
 242 .\" NS   `doc-fixed-width': `.doc-get-arg-width arg-index'
 243 .\" NS
 244 .\" NS modifies:
 245 .\" NS   doc-width
 246 .
 247 .de doc-get-arg-width
 248 .  nr doc-width \w\a\f[C]\*[doc-arg\$1]\a
 249 .  ie (\n[doc-width] >= \n[doc-fixed-width]) \{\
 250 .    ie (\n[doc-width] % \n[doc-fixed-width]) \
 251 .      nr doc-width ((\n[doc-width] / \n[doc-fixed-width]) + 1)
 252 .    el \
 253 .      nr doc-width (\n[doc-width] / \n[doc-fixed-width])
 254 .  \}
 255 .  el \{\
 256 .    ie \n[doc-width] \
 257 .      nr doc-width 1
 258 .    el \
 259 .      nr doc-width 0
 260 .  \}
 261 ..
 262 .
 263 .
 264 .\" NS Ql user macro
 265 .\" NS   quoted literal define
 266 .\" NS
 267 .\" NS modifies:
 268 .\" NS   doc-argXXX
 269 .\" NS   doc-arg-limit
 270 .\" NS   doc-arg-ptr
 271 .\" NS   doc-macro-name
 272 .\" NS   doc-spaceXXX
 273 .\" NS   doc-typeXXX
 274 .\" NS   doc-quote-left
 275 .\" NS   doc-quote-right
 276 .\" NS
 277 .\" NS local variables:
 278 .\" NS   doc-reg-Ql
 279 .\" NS   doc-reg-Ql1
 280 .\" NS   doc-reg-Ql2
 281 .\" NS
 282 .\" NS width register `Ql' set in doc-common
 283 .
 284 .de Ql
 285 .  if !\n[doc-arg-limit] \{\
 286 .    ie \n[.$] \{\
 287 .      ds doc-macro-name Ql
 288 .      doc-parse-args \$@
 289 .    \}
 290 .    el \
 291 .      tm Usage: .Ql argument ... (#\n[.c])
 292 .  \}
 293 .
 294 .  nr doc-reg-Ql (\n[doc-arg-ptr] + 1)
 295 .  doc-get-arg-width \n[doc-reg-Ql]
 296 .
 297 .  \" don't use quotes if we have more than two succeeding string arguments
 298 .  nr doc-reg-Ql +1
 299 .  if (\n[doc-arg-limit] >= \n[doc-reg-Ql]) \
 300 .    if (\n[doc-type\n[doc-reg-Ql]] == 2) \
 301 .      nr doc-width 3
 302 .
 303 .  \" make a difference in quotation style for strings longer
 304 .  \" than two characters
 305 .  ie (\n[doc-width] > 2) \
 306 .    Li
 307 .  el \{\
 308 .    ie \n[doc-arg-ptr] \{\
 309 .      \" we replace `Ql' with `Li'
 310 .      ds doc-arg\n[doc-arg-ptr] Li
 311 .      nr doc-arg-ptr -1
 312 .    \}
 313 .    el \{\
 314 .      \" if .Ql has been called directly, we must shift all elements in
 315 .      \" the argument vector to the right so that we can insert `Li'
 316 .      nr doc-reg-Ql \n[doc-arg-limit]
 317 .      nr doc-reg-Ql1 (\n[doc-arg-limit] + 1)
 318 .      while \n[doc-reg-Ql] \{\
 319 .        rn doc-arg\n[doc-reg-Ql] doc-arg\n[doc-reg-Ql1]
 320 .        rnn doc-type\n[doc-reg-Ql] doc-type\n[doc-reg-Ql1]
 321 .        rn doc-space\n[doc-reg-Ql] doc-space\n[doc-reg-Ql1]
 322 .        nr doc-reg-Ql -1
 323 .        nr doc-reg-Ql1 -1
 324 .      \}
 325 .      ds doc-arg1 Li
 326 .      nr doc-type1 1
 327 .      ds doc-space1
 328 .      nr doc-arg-limit +1
 329 .    \}
 330 .
 331 .    ds doc-quote-left "\*[doc-left-singlequote]
 332 .    ds doc-quote-right "\*[doc-right-singlequote]
 333 .    doc-enclose-string
 334 .  \}
 335 ..
 336 .
 337 .
 338 .ec
 339 .
 340 .\" EOF