1.\" $NetBSD: checknr.1,v 1.5 1995/03/26 04:10:14 glass Exp $ 2.\" 3.\" Copyright (c) 1980, 1990, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" @(#)checknr.1 8.1 (Berkeley) 6/6/93 35.\" 36.Dd June 6, 1993 37.Dt CHECKNR 1 38.Os BSD 4 39.Sh NAME 40.Nm checknr 41.Nd check nroff/troff files 42.Sh SYNOPSIS 43.Nm checknr 44.Op Fl a Ns Ar \&.x1.y1.x2.y2. ... \&.xn.yn 45.Op Fl c Ns Ar \&.x1.x2.x3 ... \&.xn 46.Op Fl s 47.Op Fl f 48.Ar file 49.Sh DESCRIPTION 50.Nm Checknr 51checks a list of 52.Xr nroff 1 53or 54.Xr troff 1 55input files for certain kinds of errors 56involving mismatched opening and closing delimiters 57and unknown commands. 58If no files are specified, 59.Nm checknr 60checks the standard input. 61.Pp 62Options: 63.Bl -tag -width Ds 64.It Fl a 65Add additional pairs of macros to the list of known macros. 66This must be followed by groups of six characters, each group defining 67a pair of macros. 68The six characters are 69a period, 70the first macro name, 71another period, 72and the second macro name. 73For example, to define a pair .BS and .ES, use 74.Sq Li \-a.BS.ES 75.It Fl c 76Define commands which would otherwise be complained about 77as undefined. 78.It Fl f 79Request 80.Nm checknr 81to ignore 82.Ql \ef 83font changes. 84.It Fl s 85Ignore 86.Ql \es 87size changes. 88.El 89.Pp 90Delimiters checked are: 91.Bl -enum 92.It 93Font changes using \efx ... \efP. 94.It 95Size changes using \esx ... \es0. 96.It 97Macros that come in open ... close forms, for example, 98the .TS and .TE macros which must always come in pairs. 99.El 100.Pp 101.Nm Checknr 102is intended for use on documents that are prepared with 103.Nm checknr 104in mind, much the same as 105.Xr lint 1 . 106It expects a certain document writing style for 107.Ql \ef 108and 109.Ql \es 110commands, 111in that each 112.Ql \efx 113must be terminated with 114.Ql \efP 115and 116each 117.Ql \esx 118must be terminated with 119.Ql \es0 . 120While it will work to directly go into the next font or explicitly 121specify the original font or point size, 122and many existing documents actually do this, 123such a practice will produce complaints from 124.Nm checknr . 125Since it is probably better to use the 126.Ql \efP 127and 128.Ql \es0 129forms anyway, 130you should think of this as a contribution to your document 131preparation style. 132.Pp 133.Nm Checknr 134knows about the 135.Xr ms 7 136and 137.Xr me 7 138macro packages. 139.Sh SEE ALSO 140.Xr nroff 1 , 141.Xr troff 1 , 142.Xr checkeq 1 , 143.Xr ms 7 , 144.Xr me 7 145.Sh DIAGNOSTICS 146.Bd -ragged -compact 147Complaints about unmatched delimiters. 148Complaints about unrecognized commands. 149Various complaints about the syntax of commands. 150.Ed 151.Sh BUGS 152There is no way to define a 1 character macro name using 153.Fl a . 154.Pp 155Does not correctly recognize certain reasonable constructs, 156such as conditionals. 157.Sh HISTORY 158The 159.Nm 160command appeared in 161.Bx 4.0 . 162