doc-nroff revision 302408
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. [Deleted. See
ftp://ftp.cs.berkeley.edu/pub/4bsd/README.Impt.License.Change]
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
%beginstrip%
. . .eo . use -rD=1 for double-sided printing
. . use -rcR=0 to have multiple pages instead of a single, very long page
. . the following switch is ignored in nroff mode
. .nr S 10 . the `doc-xx-font' strings must not be empty!
. . . 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.5i . . NS doc-footer-space global register
NS the space between body and footer
. .nr doc-footer-space 0.5i . . 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
. . ie r LL \ . ll \n[LL]u . el \ . ll 78n . . ie r LT \ . lt \n[LT]u . el \ . lt 78n . . po 0i . . nr doc-display-vertical 1v . ad l . na .. . . .ec . . the following strings are `official'
. Unicode TTYs have all glyph forms; for other TTY character sets we need
character representations which are different from GNU troff's standard
forms.
. ds Rq \[rq] . ds Lq \[lq] . ds ua \[ua] . ds Pi \[*p] . ds If \[if] .\} . 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
. . . NS doc-setup-header macro
NS install and initialize header and footer support
NS
NS modifies:
NS doc-header-string
. . 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 . \} . . 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
. . 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
. . 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
. . 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
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. [Deleted. See
ftp://ftp.cs.berkeley.edu/pub/4bsd/README.Impt.License.Change]
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
%beginstrip%
. . .eo . use -rD=1 for double-sided printing
. . use -rcR=0 to have multiple pages instead of a single, very long page
. . the following switch is ignored in nroff mode
. .nr S 10 . the `doc-xx-font' strings must not be empty!
. . . 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.5i . . NS doc-footer-space global register
NS the space between body and footer
. .nr doc-footer-space 0.5i . . 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
. . ie r LL \ . ll \n[LL]u . el \ . ll 78n . . ie r LT \ . lt \n[LT]u . el \ . lt 78n . . po 0i . . nr doc-display-vertical 1v . ad l . na .. . . .ec . . the following strings are `official'
. Unicode TTYs have all glyph forms; for other TTY character sets we need
character representations which are different from GNU troff's standard
forms.
. ds Rq \[rq] . ds Lq \[lq] . ds ua \[ua] . ds Pi \[*p] . ds If \[if] .\} . 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
. . . NS doc-setup-header macro
NS install and initialize header and footer support
NS
NS modifies:
NS doc-header-string
. . 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 . \} . . 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
. . 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
. . 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
. . 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