1.\" Copyright (c) 1980, 1990, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" %sccs.include.redist.man% 5.\" 6.\" @(#)checknr.1 8.1 (Berkeley) 06/06/93 7.\" 8.Dd 9.Dt CHECKNR 1 10.Os BSD 4 11.Sh NAME 12.Nm checknr 13.Nd check nroff/troff files 14.Sh SYNOPSIS 15.Nm checknr 16.Op Fl a Ns Ar \&.x1.y1.x2.y2. ... \&.xn.yn 17.Op Fl c Ns Ar \&.x1.x2.x3 ... \&.xn 18.Op Fl s 19.Op Fl f 20.Ar file 21.Sh DESCRIPTION 22.Nm Checknr 23checks a list of 24.Xr nroff 1 25or 26.Xr troff 1 27input files for certain kinds of errors 28involving mismatched opening and closing delimiters 29and unknown commands. 30If no files are specified, 31.Nm checknr 32checks the standard input. 33.Pp 34Options: 35.Bl -tag -width Ds 36.It Fl a 37Add additional pairs of macros to the list of known macros. 38This must be followed by groups of six characters, each group defining 39a pair of macros. 40The six characters are 41a period, 42the first macro name, 43another period, 44and the second macro name. 45For example, to define a pair .BS and .ES, use 46.Sq Li \-a.BS.ES 47.It Fl c 48Define commands which would otherwise be complained about 49as undefined. 50.It Fl f 51Request 52.Nm checknr 53to ignore 54.Ql \ef 55font changes. 56.It Fl s 57Ignore 58.Ql \es 59size changes. 60.El 61.Pp 62Delimiters checked are: 63.Bl -enum 64.It 65Font changes using \efx ... \efP. 66.It 67Size changes using \esx ... \es0. 68.It 69Macros that come in open ... close forms, for example, 70the .TS and .TE macros which must always come in pairs. 71.El 72.Pp 73.Nm Checknr 74is intended for use on documents that are prepared with 75.Nm checknr 76in mind, much the same as 77.Xr lint 1 . 78It expects a certain document writing style for 79.Ql \ef 80and 81.Ql \es 82commands, 83in that each 84.Ql \efx 85must be terminated with 86.Ql \efP 87and 88each 89.Ql \esx 90must be terminated with 91.Ql \es0 . 92While it will work to directly go into the next font or explicitly 93specify the original font or point size, 94and many existing documents actually do this, 95such a practice will produce complaints from 96.Nm checknr . 97Since it is probably better to use the 98.Ql \efP 99and 100.Ql \es0 101forms anyway, 102you should think of this as a contribution to your document 103preparation style. 104.Pp 105.Nm Checknr 106knows about the 107.Xr ms 7 108and 109.Xr me 7 110macro packages. 111.Sh SEE ALSO 112.Xr nroff 1 , 113.Xr troff 1 , 114.Xr checkeq 1 , 115.Xr ms 7 , 116.Xr me 7 117.Sh DIAGNOSTICS 118.Bd -ragged -compact 119Complaints about unmatched delimiters. 120Complaints about unrecognized commands. 121Various complaints about the syntax of commands. 122.Ed 123.Sh BUGS 124There is no way to define a 1 character macro name using 125.Fl a . 126.Pp 127Does not correctly recognize certain reasonable constructs, 128such as conditionals. 129.Sh HISTORY 130The 131.Nm 132command appeared in 133.Bx 4.0 . 134