tmac/doc-ditroff.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-ditroff 5.8 (Berkeley) 8/5/91
  33 .\"
  34 .\" tmac.mdoc-ditroff
  35 .\"     %beginstrip%
  36 .
  37 .
  38 .\" use -rC=1 to number pages continuously
  39 .
  40 .if !rC .nr C 0
  41 .
  42 .\" use -rcR=1 to force the creation of a single, very long page
  43 .if !rcR .nr cR 0
  44 .
  45 .ds doc-caption-font \f[R]\s[10]
  46 .ds doc-caption-font2 \f[R]\s[10]
  47 .ds doc-Ad-font \f[I]\s[10]
  48 .ds doc-Ar-font \f[CO]\s[10]
  49 .ds doc-Cm-font \f[CB]\s[10]
  50 .ds doc-Em-font \f[I]\s[10]
  51 .ds doc-Er-font \f[C]\s[10]
  52 .ds doc-Ev-font \f[C]\s[10]
  53 .ds doc-Fa-font \f[CO]\s[10]
  54 .ds doc-Fd-font \f[CB]\s[10]
  55 .ds doc-Fl-font \f[CB]\s[10]
  56 .ds doc-Fn-font \f[CB]\s[10]
  57 .ds doc-Ft-font \f[CO]\s[10]
  58 .ds doc-Ic-font \f[CB]\s[10]
  59 .ds doc-Li-font \f[C]
  60 .ds doc-Nm-font \f[CB]\s[10]
  61 .ds doc-No-font \f[R]\s[10]
  62 .ds doc-Pa-font \f[C]\s[10]
  63 .ds doc-Sh-font \f[B]\s[10]
  64 .ds doc-Sy-font \f[B]\s[10]
  65 .ds doc-Sx-font \f[R]\s[10]
  66 .ds doc-Tn-font-shape \f[R]
  67 .ds doc-Tn-font-size \s[9]
  68 .ds doc-Va-font \f[I]\s[10]
  69 .ds doc-Xr-font \f[C]\s[10]
  70 .
  71 .ds doc-left-parenthesis \f[R]\|(\|\f[P]\s[10]
  72 .ds doc-right-parenthesis \f[R]\|)\|\f[P]\s[10]
  73 .ds lp \f[R](\f[P]\s[10]
  74 .ds rp \f[R])\f[P]\s[10]
  75 .ds doc-left-bracket \f[R]\^[\^\f[P]\s[10]
  76 .ds doc-right-bracket \f[R]\^]\f[P]\s[10]
  77 .
  78 .ec
  79 .
  80 .tr *\[**]
  81 .
  82 .ds doc-punct-chars \f[R]{\ .\ ,\ :\ ;\ (\ )\ [\ ]\ \f[R]}
  83 .nr doc-subheader-indent (\w\a\f[C],\au * 5u)
  84 .nr doc-paragraph-space .5v
  85 .
  86 .ds doc-digit-string \0
  87 .nr doc-digit-width \w'\0'u
  88 .nr doc-fixed-width \w\a\f[C]0\a
  89 .
  90 .eo
  91 .
  92 .
  93 .de doc-setup-page-layout
  94 .  nr doc-header-space .5i
  95 .  nr doc-footer-space .5i
  96 .
  97 .  ll 6.5i
  98 .  lt 6.5i
  99 .  po 1i
 100 .
 101 .  nr doc-display-vertical .5v
 102 ..
 103 .
 104 .
 105 .ds <= \[<=]
 106 .ds >= \[>=]
 107 .
 108 .\" Lq and Rq are `official'
 109 .ds Lq \[lq]
 110 .ds Rq \[rq]
 111 .ds ua \[ua]
 112 .ds aa \[aa]
 113 .ds ga \[ga]
 114 .ds doc-right-singlequote \&'
 115 .ds doc-left-singlequote \&`
 116 .\" q is `official'
 117 .ds q \&"
 118 .
 119 .\" Math stuff -- all macro names are `official'
 120 .ds Pi \[*p]
 121 .ds Ne \[!=]
 122 .ds Le \[<=]
 123 .ds Ge \[>=]
 124 .ds Lt <
 125 .ds Gt >
 126 .ds Pm \[+-]
 127 .ds If \[if]
 128 .ds Na \f[I]NaN\f[P]
 129 .ds Ba \f[R]|\f[P]
 130 .
 131 .nr gX 0
 132 .
 133 .
 134 .de doc-setup-header
 135 .  ds doc-header-string \*[doc-document-title]
 136 .  if !"\*[doc-section]"Null" \{\
 137 .    as doc-header-string \|(\|\*[doc-section]\|)
 138 .  \}
 139 .
 140 .  wh 0 doc-header
 141 .  wh -1.25i doc-footer
 142 .
 143 .  nr nL \n[nl]
 144 .  ie \n[gX] \{\
 145 .    ds doc-command-name
 146 .    bp
 147 .  \}
 148 .  el \
 149 '    bp
 150 .
 151 .  \" Don't set the page number if this is the first page,
 152 .  \" in case the user has used -n.
 153 .  if \n[nL] \{\
 154 .    if !\n[C] \{\
 155 .      nr % 1
 156 .    \}
 157 .  \}
 158 .
 159 .  nr gX 0
 160 .  em doc-end-macro
 161 ..
 162 .
 163 .
 164 .\" NS doc-get-width macro
 165 .\" NS   computes the width of a string as a multiple of `doc-fixed-width':
 166 .\" NS   `.doc-get-width string'
 167 .\" NS
 168 .\" NS modifies:
 169 .\" NS   doc-width
 170 .
 171 .de doc-get-width
 172 .  nr doc-width \w\a\f[C]\$1\a
 173 .  ie (\n[doc-width] >= \n[doc-fixed-width]) \{\
 174 .    ie (\n[doc-width] % \n[doc-fixed-width]) \{\
 175 .      nr doc-width ((\n[doc-width] / \n[doc-fixed-width]) + 1)
 176 .    \}
 177 .    el .nr doc-width (\n[doc-width] / \n[doc-fixed-width])
 178 .  \}
 179 .  el \{
 180 .    ie \n[doc-width] .nr doc-width 1
 181 .    el .nr doc-width 0
 182 .  \}
 183 ..
 184 .
 185 .
 186 .\" NS doc-get-arg-width macro
 187 .\" NS   computes the width of an argument as a multiple of
 188 .\" NS   `doc-fixed-width': `.doc-get-arg-width arg-index'
 189 .\" NS
 190 .\" NS modifies:
 191 .\" NS   doc-width
 192 .
 193 .de doc-get-arg-width
 194 .  nr doc-width \w\a\f[C]\*[doc-arg\$1]\a
 195 .  ie (\n[doc-width] >= \n[doc-fixed-width]) \{\
 196 .    ie (\n[doc-width] % \n[doc-fixed-width]) \{\
 197 .      nr doc-width ((\n[doc-width] / \n[doc-fixed-width]) + 1)
 198 .    \}
 199 .    el .nr doc-width (\n[doc-width] / \n[doc-fixed-width])
 200 .  \}
 201 .  el \{
 202 .    ie \n[doc-width] .nr doc-width 1
 203 .    el .nr doc-width 0
 204 .  \}
 205 ..
 206 .
 207 .
 208 .\" NS Ql macro
 209 .\" NS   quoted literal define
 210 .\" NS
 211 .\" NS width register `.Ql' set in doc-common
 212 .\" NS
 213 .\" NS local register:
 214 .\" NS   doc-reg-Ql
 215 .
 216 .de Ql
 217 .  if !\n[doc-args-processed] \{\
 218 .    ds doc-macro-name Ql
 219 .
 220 .    nr doc-reg-Ql 1
 221 .    while (\n[doc-reg-Ql] <= \n[.$]) \{\
 222 .      ds doc-arg\n[doc-reg-Ql] "\$[\n[doc-reg-Ql]]
 223 .      nr doc-reg-Ql +1
 224 .    \}
 225 .
 226 .    nr doc-num-args \n[.$]
 227 .    doc-parse-arg-vector
 228 .  \}
 229 .
 230 .  nr doc-arg-ptr +1
 231 .  doc-get-arg-width \n[doc-arg-ptr]
 232 .  nr doc-arg-ptr -1
 233 .
 234 .  ie (\n[doc-width] > 2) .Li
 235 .  el \{\
 236 .    \" Db on
 237 .    if \n[doc-arg-ptr] \{\
 238 .      ds doc-arg\n[doc-arg-ptr] Li
 239 .      nr doc-arg-ptr -1
 240 .    \}
 241 .
 242 .    if !\n[doc-arg-ptr] \{\
 243 .      rm doc-type0 doc-type1 doc-type2 doc-type3 doc-type4
 244 .      rm doc-type5 doc-type6 doc-type7 doc-type8 doc-type9
 245 .      rm doc-space1 doc-space2 doc-space3 doc-space4 doc-space5
 246 .      rm doc-space6 doc-space7 doc-space8 doc-space9
 247 .
 248 .      rn doc-arg8 doc-arg9
 249 .      rn doc-arg7 doc-arg8
 250 .      rn doc-arg6 doc-arg7
 251 .      rn doc-arg5 doc-arg6
 252 .      rn doc-arg4 doc-arg5
 253 .      rn doc-arg3 doc-arg4
 254 .      rn doc-arg2 doc-arg3
 255 .      rn doc-arg1 doc-arg2
 256 .
 257 .      ds doc-arg1 Li
 258 .      nr doc-num-args (\n[doc-args-processed] + 1)
 259 .      nr doc-args-processed 0
 260 .      doc-parse-arg-vector
 261 .    \}
 262 .
 263 .    ds doc-quote-left \&\*[doc-left-singlequote]
 264 .    ds doc-quote-right \&\*[doc-right-singlequote]
 265 .
 266 .    doc-enclose-string
 267 .    \" Db off
 268 .  \}
 269 ..
 270 .
 271 .
 272 .\" NS Sh macro
 273 .\" NS   section headers
 274 .\" NS
 275 .\" NS width register `.Sh' set in doc-common
 276 .
 277 .de Sh
 278 .  nr doc-in-synopsis-section 0
 279 .  nr doc-indent-synopsis 0
 280 .
 281 '  ad
 282 .
 283 .  ie "\$1"NAME" \{\
 284 .    doc-setup-header
 285 '    in 0
 286 .  \}
 287 .  el \{\
 288 .    nr doc-in-synopsis-section 0
 289 .    nr doc-in-see-also-section 0
 290 .    nr doc-in-files-section 0
 291 .    nr doc-in-standards-section 0
 292 .    nr doc-in-authors-section 0
 293 .
 294 .    if "\$1"SYNOPSIS" \{\
 295 .      na
 296 .      nr doc-in-synopsis-section 1
 297 .    \}
 298 .
 299 .    if "\$1"DESCRIPTION" \{\
 300 .      nr fY 0
 301 .      nr fZ 0
 302 .      nr fB 0
 303 .      nr Fb 0
 304 .      ds Fb
 305 .    \}
 306 .
 307 .    if "\$1"SEE" \{\
 308 .      nr doc-in-see-also-section 1
 309 .      na
 310 .    \}
 311 .
 312 .    if "\$1"FILES" .nr doc-in-files-section 1
 313 .    if "\$1"STANDARDS" .nr doc-in-standards-section 1
 314 .    if "\$1"AUTHORS" .nr doc-in-authors-section 1
 315 .
 316 .    in 0
 317 .    nr aN 0
 318 .  \}
 319 .
 320 .  doc-setup-page-layout
 321 '  sp
 322 .  ns
 323 .  ta .5i 1i 1.5i 2i 2.5i 3i 3.5i 4i 4.5i 5i 5.5i 6i 6.5i
 324 .  if !\n[cR] .ne 3
 325 '  fi
 326 .
 327 .  nop \&\*[doc-Sh-font]\$1 \|\$2 \|\$3 \|\$4 \|\$5 \|\$6 \|\$7 \|\$8 \|\$9
 328 .  nop \&\f[P]\s[0]\&
 329 .
 330 .  in (\n[.i]u + \n[doc-subheader-indent]u)
 331 .  ns
 332 ..
 333 .
 334 .\" EOF