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