checknr(1) checknr(1)
NAME
checknr - check nroff/troff files
SYNOPSIS
checknr [-s] [-f] [-a.x1.y1.x2.y2. . ..xn.yn]
[-c.x1.x2.x3. . ..xn] [file. . . ]
DESCRIPTION
checknr checks a list of nroff(1) or troff(1) input files
for certain kinds of errors involving mismatched opening and
closing delimiters and unknown commands. If no files are
specified, checknr 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.
checknr operates on the ms(5) macro package only.
Additional pairs of macros may be added to the list using
the -a flag option. This must be followed by groups of six
characters, each group defining a pair of macros. The six
characters are a period, the first macro name, another
period, and the second macro name. For example, to define a
pair .BS and .ES, use:
checknr -a.BS.ES
The -c flag option causes commands (macros) to be considered
``defined'' which would otherwise be complained about as
undefined. For instance, user-defined macros are not part
of the ms macro package, and thus would be considered
undefined. Any macros to be defined for checknr follow the
-c with no spaces. For example, to define the macros .XX
and .YY, use:
checknr -c.XX.YY
The -f flag option requests checknr to ignore \f font
changes.
The -s flag option requests checknr to ignore \s size
changes.
checknr is intended to be used on documents that are
prepared with checknr in mind, much the same as lint(1). It
expects a certain document writing style for \f and \s
commands, in that each \fx must be terminated with \fP and
each \sx must be terminated with \s0. While it will work to
Page 1 (last mod. 1/20/87)
checknr(1) checknr(1)
go directly into the next font or to specify the original
font or point size explicitly, and many existing documents
actually do this, such a practice will produce complaints
from checknr. 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.
FILES
/usr/ucb/checknr
SEE ALSO
nroff(1), troff(1), checkeq(1), ms(5).
``Other text processing tools'' and ``ms Reference'' in Oreo
Text Processing Tools.
DIAGNOSTICS
Complains about unmatched delimiters.
Complains about unrecognized commands.
Various complaints about the syntax of commands.
BUGS
There is no way to define a 1-character macro name using -a.
Does not recognize certain reasonable constructs correctly,
such as conditionals.
Page 2 (last mod. 1/20/87)