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