CHECKNR(1)

πŸ“¦ version 191015, in alpine 3.24

🌸 NAME 🌸

okay bestie, this is checknr(1) β€” the manual for checknr, aka check nroff/troff files β€” part of BSD System Compatibility. It 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 standard input. periodt πŸ’…

✨ SYNOPSIS ✨

checknr [-fs] [-a.x1.y1.x2.y2. ... .xn.yn] [-c.x1.x2.x3 ... .xn] [file ...]

πŸ’– DESCRIPTION πŸ’–

The delimiters 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 knows about the ms(7) and me(7) macro packages. iykyk πŸ¦‹

Additional pairs of macros can be added to the list using the -a option. This must be followed by groups defining pairs of macros. The characters in each group 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.

  • -a.x1.y1.x2.y2. ... .xn.yn β€” adds extra macro pairs to the list; each group is a period, the first macro name, another period, and the second macro name. Example: -a.BS.ES defines the pair .BS and .ES πŸ’«
  • -c.x1.x2.x3 ... .xn β€” defines commands which would otherwise be complained about as undefined. no false alarms, bestie πŸ™ˆ
  • -f β€” requests checknr to ignore \f font changes.
  • -s β€” 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. 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 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 \fP and \s0 forms anyway, you should think of this as a contribution to your document preparation style. main character document-prep energy πŸ‘‘

πŸ” SEE ALSO πŸ”

😭 DIAGNOSTICS 😭

  • Complaints about unmatched delimiters.
  • Complaints about unrecognized commands.
  • Various complaints about the syntax of commands.

🫢 NOTES 🫢

⚠️ okay listen, it does not correctly recognize certain reasonable constructs, such as conditionals. not the vibe, but forewarned is forearmed πŸ’€

xoxo, 4th Berkeley Distribution β€” 11/6/05 β€” CHECKNR(1) signing off, mwah! πŸ’‹βœ¨

πŸ“¦ where this page comes from