1.\" Copyright (c) 1980, 1990 The Regents of the University of California. 2.\" All rights reserved. 3.\" 4.\" %sccs.include.redist.man% 5.\" 6.\" @(#)checknr.1 6.5 (Berkeley) 07/24/90 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 s 17.Op Fl f 18.Op Fl \&a Ar \&.x1.y1.x2.y2. ... \&.xn.yn 19.Op Fl \&c Ar \&.x1.x2.x3 ... \&.xn 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. 33Delimiters checked are: 34.Pp 35.Df I 36.Bu 37Font changes using \efx ... \efP. 38.Bu 39Size changes using \esx ... \es0. 40.Bu 41Macros that come in open ... close forms, for example, 42the .TS and .TE macros which must always come in pairs. 43.Tp 44.De 45.Pp 46Options: 47.Tw Ds 48.Tp Fl a 49Add additional pairs of macros to the list of known macros. 50This must be followed by groups of six characters, each group defining 51a pair of macros. 52The six characters are 53a period, 54the first macro name, 55another period, 56and the second macro name. 57For example, to define a pair .BS and .ES, use 58.Ql \-a.BS.ES 59.Pp 60.Tp Fl c 61Define commands which would otherwise be complained about 62as undefined. 63.Tp Fl f 64Request 65.Nm checknr 66to ignore \ef font changes. 67.Tp Fl s 68Ignore \es size changes. 69.Tp 70.Pp 71.Nm Checknr 72is intended for use on documents that are prepared with 73.Nm checknr 74in mind, much the same as 75.Xr lint 1 . 76It expects a certain document writing style for \ef and \es commands, 77in that each \efx must be terminated with \efP and 78each \esx must be terminated with \es0. 79While it will work to directly go into the next font or explicitly 80specify the original font or point size, 81and many existing documents actually do this, 82such a practice will produce complaints from 83.Nm checknr . 84Since it is probably better to use the \efP and \es0 forms anyway, 85you should think of this as a contribution to your document 86preparation style. 87.Pp 88.Nm Checknr 89knows about the 90.Xr ms 7 91and 92.Xr me 7 93macro packages. 94.Sh SEE ALSO 95.Xr nroff 1 , 96.Xr troff 1 , 97.Xr checkeq 1 , 98.Xr ms 7 , 99.Xr me 7 100.Sh DIAGNOSTICS 101.Ds L 102Complaints about unmatched delimiters. 103Complaints about unrecognized commands. 104Various complaints about the syntax of commands. 105.De 106.Sh BUGS 107There is no way to define a 1 character macro name using 108.Fl a . 109.Pp 110Does not correctly recognize certain reasonable constructs, 111such as conditionals. 112.Sh HISTORY 113.Nm 114appeared in 4.0 BSD. 115