BSD 4_3_Tahoe development
[unix-history] / usr / man / cat1 / checknr.0
CHECKNR(1) UNIX Programmer's Manual CHECKNR(1)
N\bNA\bAM\bME\bE
checknr - check nroff/troff files
S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
c\bch\bhe\bec\bck\bkn\bnr\br [ -\b-s\bs ] [ -\b-f\bf ] [ -\b-a\ba.x1.y1.x2.y2. ... .xn.yn ] [
-\b-c\bc.x1.x2.x3 ... .xn ] [ _\bf_\bi_\bl_\be ... ]
D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
_\bC_\bh_\be_\bc_\bk_\bn_\br checks a list of _\bn_\br_\bo_\bf_\bf(1) or _\bt_\br_\bo_\bf_\bf(1) input files
for certain kinds of errors involving mismatched opening and
closing delimiters and unknown commands. If no files are
specified, _\bc_\bh_\be_\bc_\bk_\bn_\br checks the standard input. Delimeters
checked are:
(1) Font changes using \fx ... \fP.
(2) Size changes using \sx ... \s0.
(3) Macros that come in open ... close forms, for example,
the .TS and .TE macros which must always come in pairs.
_\bC_\bh_\be_\bc_\bk_\bn_\br knows about the _\bm_\bs(7) and _\bm_\be(7) macro packages.
Additional pairs of macros can be added to the list using
the -\b-a\ba option. This must be followed by groups of six char-
acters, each group defining a pair of macros. The six char-
acters are a period, the first macro name, another period,
and the second macro name. For example, to define a pair
.BS and .ES, use -a\ba.BS.ES
The -\b-c\bc option defines commands which would otherwise be com-
plained about as undefined.
The -\b-f\bf option requests _\bc_\bh_\be_\bc_\bk_\bn_\br to ignore \f font changes.
The -\b-s\bs option requests _\bc_\bh_\be_\bc_\bk_\bn_\br to ignore \s size changes.
_\bC_\bh_\be_\bc_\bk_\bn_\br is intended to be used on documents that are
prepared with _\bc_\bh_\be_\bc_\bk_\bn_\br in mind, much the same as _\bl_\bi_\bn_\bt. It
expects a certain document writing style for \f and \s com-
mands, in that each \fx must be terminated with \fP and each
\sx must be terminated with \s0. While it will work to
directly go into the next font or explicitly specify the
original font or point size, and many existing documents
actually do this, such a practice will produce complaints
from _\bc_\bh_\be_\bc_\bk_\bn_\br. Since it is probably better to use the \fP and
\s0 forms anyway, you should think of this as a contribution
to your document preparation style.
S\bSE\bEE\bE A\bAL\bLS\bSO\bO
nroff(1), troff(1), checkeq(1), ms(7), me(7)
Printed 7/9/88 May 7, 1986 1
CHECKNR(1) UNIX Programmer's Manual CHECKNR(1)
D\bDI\bIA\bAG\bGN\bNO\bOS\bST\bTI\bIC\bCS\bS
Complaints about unmatched delimiters.
Complaints about unrecognized commands.
Various complaints about the syntax of commands.
B\bBU\bUG\bGS\bS
There is no way to define a 1 character macro name using -\b-a\ba.
Does not correctly recognize certain reasonable constructs,
such as conditionals.
Printed 7/9/88 May 7, 1986 2