tmac/mdoc-nroff

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