xref: /illumos-gate/usr/src/man/man1/checknr.1 (revision 3ce5372277f4657ad0e52d36c979527c4ca22de2)
te
Copyright (c) 1992, Sun Microsystems, Inc.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
CHECKNR 1 "Sep 14, 1992"
NAME
checknr - check nroff and troff input files; report possible errors
SYNOPSIS

checknr [-fs] [-a . x1 . y1 . x2 . y2 ... .xn .yn]
 [-c . x1 . x2 . x3 ... .xn] [filename]...
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. Delimiters checked are:

Font changes using \efx .\|.\|. \efP.

Size changes using \esx .\|.\|. \es0.

Macros that come in open .\|.\|. close forms, for example, the .TS and

checknr knows about the ms(5) and me(5) macro packages.

checknr is intended to be used on documents that are prepared with checknr in mind. It expects a certain document writing style for \ef and \es commands, in that each \efx must be terminated with \efP and each \esx must be terminated with \es0. 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 checknr. Since it is probably better to use the \efP and \es0 forms anyway, you should think of this as a contribution to your document preparation style.

OPTIONS
-f

Ignore \ef font changes.

-s

Ignore \es size changes.

-a .x1 .y1.\|.\|.

Add pairs of macros to the list. The pairs of macros are assumed to be those (such as .DS and .DE) that should be checked for balance. The -a option 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 `-a.BS.ES'

-c .x1\|.\|.\|.

Define commands which checknr would otherwise complain about as undefined.

SEE ALSO

eqn(1), nroff(1), troff(1), attributes(5), me(5), ms(5)

BUGS

There is no way to define a one-character macro name using the -a option.