xref: /386bsd/usr/share/man/cat1/checknr.0 (revision a2142627)
1CHECKNR(1)                  386BSD Reference Manual                 CHECKNR(1)
2
3NNAAMMEE
4     cchheecckknnrr - check nroff/troff files
5
6SSYYNNOOPPSSIISS
7     cchheecckknnrr [--aa._x_1._y_1._x_2._y_2. ... ._x_n._y_n] [--cc._x_1._x_2._x_3 ... ._x_n] [--ss] [--ff] _f_i_l_e
8
9DDEESSCCRRIIPPTTIIOONN
10     CChheecckknnrr checks a list of nroff(1) or troff(1) input files for certain
11     kinds of errors involving mismatched opening and closing delimiters and
12     unknown commands.  If no files are specified, cchheecckknnrr checks the standard
13     input.
14
15     Options:
16
17     --aa      Add additional pairs of macros to the list of known macros.  This
18             must be followed by groups of six characters, each group defining
19             a pair of macros.  The six characters are a period, the first
20             macro name, another period, and the second macro name.  For
21             example, to define a pair .BS and .ES, use `-a.BS.ES'
22
23     --cc      Define commands which would otherwise be complained about as
24             undefined.
25
26     --ff      Request cchheecckknnrr to ignore `f' font changes.
27
28     --ss      Ignore `\s' size changes.
29
30     Delimeters checked are:
31
32     1.   Font changes using \fx ... \fP.
33
34     2.   Size changes using \sx ... \s0.
35
36     3.   Macros that come in open ... close forms, for example, the .TS and
37          .TE macros which must always come in pairs.
38
39     CChheecckknnrr is intended for use on documents that are prepared with cchheecckknnrr
40     in mind, much the same as lint(1).  It expects a certain document writing
41     style for `\f' and `\s' commands, in that each `\fx' must be terminated
42     with `\fP' and each `\sx' must be terminated with `\s0'. While it will
43     work to directly go into the next font or explicitly specify the original
44     font or point size, and many existing documents actually do this, such a
45     practice will produce complaints from cchheecckknnrr. Since it is probably
46     better to use the `\fP' and `\s0' forms anyway, you should think of this
47     as a contribution to your document preparation style.
48
49     CChheecckknnrr knows about the ms(7) and me(7) macro packages.
50
51SSEEEE AALLSSOO
52     nroff(1),  troff(1),  checkeq(1),  ms(7),  me(7)
53
54DDIIAAGGNNOOSSTTIICCSS
55     Complaints about unmatched delimiters.  Complaints about unrecognized
56     commands.  Various complaints about the syntax of commands.
57
58BBUUGGSS
59     There is no way to define a 1 character macro name using --aa.
60
61     Does not correctly recognize certain reasonable constructs, such as
62     conditionals.
63
64HHIISSTTOORRYY
65     The cchheecckknnrr command appeared in 4.0BSD.
66
67