Commands Reference, Volume 1

checknr Command

Purpose

Checks nroff and troff files.

Syntax

checknr [ -a.Macro1.Macro2 ... ] [ -c.Command1.Command2 ... ] [ -f ] [ -s ] [ File ... ]

Description

The checknr command checks a list of nroff or troff input files for certain kinds of errors involving mismatched opening and closing delimiters and unknown commands. If no files are specified, the checknr command checks standard input.

Delimiters checked are:

Font changes using the \fNewfont ... \fP.
Size changes using the \sNewsize ... \s0.
Macros that come in open and close forms (such as the .TS and .TE macros) that must always come in pairs.

The checknr command can handle both the ms and me macro packages.

The checknr command is intended to be used on documents that are prepared with the checknr command in mind, much the same as the lint command. The checknr command requires a certain document writing style for the \f and \s commands, in that each \fNewfont must be terminated with \fP and each \sNewsize must be terminated with \s0. While it works to go directly into the next font or to explicitly specify the original font or point size, such a practice produces error messages from the checknr command.

File specifies nroff or troff input files for errors involving mismatched opening and closing delimiters and unknown commands. The default is standard input.

Flags

-a.Macro1.Macro2	Adds pairs of macros to the list. This flag must be followed by groups of six characters, each group defining a pair of macros. The six characters are a period, Macro1, another period, and Macro2. For example, to define the pair, .BS and .ES, use -a.BS.ES. Note: There is no way to define a 1-character macro name using the -a flag.
-c.Command1.Command2
	Defines otherwise undefined commands that would get error messages from the checknr command.
-f	Causes the checknr command to ignore \f font changes.
-s	Causes the checknr command to ignore \s size changes.

Note: The checknr command does not correctly recognize certain reasonable constructs, such as conditionals.

Related Information

The checkeq command, lint command, nroff command, troff command.

The me macro package, ms macro package.