freebsd-dev/contrib/groff/tmac/doc-nroff

.\" Copyright (c) 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"      This product includes software developed by the University of
.\"      California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)doc-nroff	8.1 (Berkeley) 06/08/93
.\"	$FreeBSD$
.\"
.\"     %beginstrip%
.
.
.eo
.
.\" use -rD=1 for double-sided printing
.
.if !r D .nr D 0
.
.\" use -rcR=0 to have multiple pages instead of a single, very long page
.
.if !r cR .nr cR 1
.
.\" the following switches are ignored in nroff mode
.
.nr S 10
.nr C 0
.
.\" the `doc-xx-font' strings must not be empty!
.
.ds doc-caption-font \f[R]
.ds doc-caption-font2 \f[R]
.ds doc-Ad-font \f[I]
.ds doc-Ar-font \f[I]
.ds doc-Cm-font \f[B]
.ds doc-Em-font \f[I]
.ds doc-Er-font \f[R]
.ds doc-Ev-font \f[R]
.ds doc-Fa-font \f[I]
.ds doc-Fd-font \f[B]
.ds doc-Fl-font \f[B]
.ds doc-Fn-font \f[B]
.ds doc-Ft-font \f[I]
.ds doc-Ic-font \f[B]
.ds doc-Li-font \f[R]
.ds doc-Me-font \f[B]
.ds doc-Nm-font \f[B]
.ds doc-No-font \f[R]
.ds doc-Pa-font \f[I]
.ds doc-Sh-font \f[B]
.ds doc-Sy-font \f[B]
.ds doc-Sx-font \f[I]
.ds doc-Tn-font-shape \f[R]
.ds doc-Tn-font-size
.ds doc-Va-font \f[I]
.ds doc-Xr-font \f[R]
.
.ds doc-left-parenthesis \f[R](\f[P]
.ds doc-right-parenthesis \f[R])\f[P]
.ds lp \f[R](\f[P]
.ds rp \f[R])\f[P]
.ds doc-left-bracket \f[R][\f[P]
.ds doc-right-bracket \f[R]]\f[P]
.
.\" miscellaneous
.nr doc-subheader-indent .5i
.nr doc-paragraph-space 1v
.
.ec
.nr doc-digit-width \w'\0\0'u
.nr doc-fixed-width \w'0'
.eo
.
.
.\" NS doc-header-space global register
.\" NS   the space between header and body
.
.nr doc-header-space 0
.
.
.\" NS doc-footer-space global register
.\" NS   the space between body and footer
.
.nr doc-footer-space 0
.
.
.\" NS doc-display-vertical global register
.\" NS   vertical space between list elements etc.
.
.nr doc-display-vertical 0
.
.
.\" NS doc-setup-page-layout macro
.\" NS   set up page layout
.\" NS
.\" NS modifies:
.\" NS   doc-display-vertical
.\" NS   doc-footer-space
.\" NS   doc-header-space
.
.de doc-setup-page-layout
.  ie \n[cR] \
.    nr doc-header-space 0
.  el \
.    nr doc-header-space .5i
.  nr doc-footer-space .5i
.
.  ll 78n
.  lt 78n
.  po 0i
.
.  nr doc-display-vertical 1v
.  ad l
.  na
..
.
.
.ec
.
.ds doc-left-singlequote \[oq]
.ds doc-right-singlequote \[cq]
.
.\" the following strings are `official'
.ds <= \[<=]
.ds >= \[>=]
.ds aa \[aa]
.ds ga \[ga]
.ds q \[dq]
.ds Ne \[!=]
.ds Le \[<=]
.ds Ge \[>=]
.ds Lt <
.ds Gt >
.ds Pm \[+-]
.ds Na \f[I]NaN\f[P]
.ds Ba \f[R]|\f[P]
.
.\" Unicode TTYs have all glyph forms; for other TTY character sets we need
.\" character representations which are different from GNU troff's standard
.\" forms.
.ie '\*[.T]'utf8' \{\
.  ds Rq \[rq]
.  ds Lq \[lq]
.  ds ua \[ua]
.  ds Pi \[*p]
.  ds If \[if]
.\}
.el \{\
.  ds Rq ''
.  ds Lq ``
.  ds ua ^
.  ds Pi pi
.  ds If infinity
.\}
.
.eo
.
.
.\" NS doc-header-string global string
.\" NS   the final string used for the manual page header
.
.ds doc-header-string
.
.
.\" NS doc-setup-header macro
.\" NS   install and initialize header and footer support
.\" NS
.\" NS modifies:
.\" NS   doc-header-string
.
.de doc-setup-header
.  nr % 1
.  ds doc-header-string "\*[doc-document-title]
.  if !"\*[doc-section]"Null" \
.    as doc-header-string (\*[doc-section])
.
.  ie \n[cR] \
.    doc-header
.  el \{\
.    wh 0 doc-header
.    wh -1.167i doc-footer
.  \}
.
.  if ((\n[nl] == 0) : (\n[nl] == -1)) \
'    bp
.
.  e@ doc-end-macro
..
.
.
.\" NS doc-get-width macro
.\" NS   computes the width of a string as a multiple of `doc-fixed-width':
.\" NS   `.doc-get-width string'
.\" NS
.\" NS modifies:
.\" NS   doc-width
.
.de doc-get-width
.  nr doc-width \w\$1
.  ie (\n[doc-width] >= \n[doc-fixed-width]) \{\
.    ie (\n[doc-width] % \n[doc-fixed-width]) \
.      nr doc-width ((\n[doc-width] / \n[doc-fixed-width]) + 1)
.    el \
.      nr doc-width (\n[doc-width] / \n[doc-fixed-width])
.  \}
.  el \
.    nr doc-width 0
..
.
.
.\" NS doc-get-arg-width macro
.\" NS   computes the width of an argument as a multiple of
.\" NS   `doc-fixed-width': `.doc-get-arg-width arg-index'
.\" NS
.\" NS modifies:
.\" NS   doc-width
.
.de doc-get-arg-width
.  nr doc-width \w\*[doc-arg\$1]
.  ie (\n[doc-width] >= \n[doc-fixed-width]) \{\
.    ie (\n[doc-width] % \n[doc-fixed-width]) \
.      nr doc-width ((\n[doc-width] / \n[doc-fixed-width]) + 1)
.    el \
.      nr doc-width (\n[doc-width] / \n[doc-fixed-width])
.  \}
.  el \
.    nr doc-width 0
..
.
.
.\" NS Ql user macro
.\" NS   quoted literal define
.\" NS
.\" NS modifies:
.\" NS   doc-macro-name
.\" NS   doc-quote-left
.\" NS   doc-quote-right
.\" NS
.\" NS width register `Ql' set in doc-common
.
.de Ql
.  if !\n[doc-arg-limit] \{\
.    ie \n[.$] \
.      ds doc-macro-name Ql
.    el \
.      tm Usage: .Ql argument ... (#\n[.c])
.  \}
.
.  ds doc-quote-left "\*[doc-left-singlequote]
.  ds doc-quote-right "\*[doc-right-singlequote]
.
.  doc-enclose-string \$@
..
.
.
.ec
.
.\" EOF