On Unix-like operating systems, the checknr command checks nroff and troff input files and reports possible errors.

Description

checknr 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, checknr checks the standard input. Delimiters checked are:

  • Description

  • Syntax

  • Options

  • Examples

  • Related commands

  • Linux commands help

  • Font changes using \fx … \fP.

  • Size changes using \sx … \s0.

  • Macros that come in open … close forms, for example, the .TS and .TE macros which must always come in pairs.

checknr knows about the “ms” and “me” macro packages, and is intended to be used on documents that are prepared with checknr in mind. 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 works 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 produces complaints from checknr. Since it is probably better to use the \fP and \s0 forms, think of this as a contribution to your document preparation style.

Syntax

checknr [-f] [-s ] [ -a . x1 . y1 . x2 . y2 … . xn . yn ] [ -c . x1 . x2 . x3 … .xn ] [file name]

Options

Examples

checknr myfile

Check the file myfile for possible errors.

eqn — Language processor for describing equations.nroff — Format documents for terminal display or line-printer.troff — Typeset or format documents for terminal display or line-printer.