4.3BSD-Reno/src/usr.bin/checknr/checknr.1

.\" Copyright (c) 1980, 1990 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms are permitted provided
.\" that: (1) source distributions retain this entire copyright notice and
.\" comment, and (2) distributions including binaries display the following
.\" acknowledgement:  ``This product includes software developed by the
.\" University of California, Berkeley and its contributors'' in the
.\" documentation or other materials provided with the distribution and in
.\" all advertising materials mentioning features or use of this software.
.\" Neither the name of the University nor the names of its contributors may
.\" be used to endorse or promote products derived from this software without
.\" specific prior written permission.
.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
.\"
.\"     @(#)checknr.1	6.5 (Berkeley) 7/24/90
.\"
.Dd July 24, 1990
.Dt CHECKNR 1
.Os BSD 4
.Sh NAME
.Nm checknr
.Nd check nroff/troff files
.Sh SYNOPSIS
.Nm checknr
.Op Fl s
.Op Fl f
.Op Fl \&a Ar \&.x1.y1.x2.y2. ... \&.xn.yn
.Op Fl \&c Ar \&.x1.x2.x3 ... \&.xn
.Ar file
.Sh DESCRIPTION
.Nm Checknr
checks a list of
.Xr nroff 1
or
.Xr troff 1
input files for certain kinds of errors
involving mismatched opening and closing delimiters
and unknown commands.
If no files are specified,
.Nm checknr
checks the standard input.
Delimeters checked are:
.Pp
.Df I
.Bu
Font changes using \efx ... \efP.
.Bu
Size changes using \esx ... \es0.
.Bu
Macros that come in open ... close forms, for example,
the .TS and .TE macros which must always come in pairs.
.Tp
.De
.Pp
Options:
.Tw Ds
.Tp Fl a
Add additional pairs of macros to the list of known macros.
This must be followed by groups of six characters, each group defining
a pair of macros.
The six characters are
a period,
the first macro name,
another period,
and the second macro name.
For example, to define a pair .BS and .ES, use
.Ql \-a.BS.ES
.Pp
.Tp Fl c
Define commands which would otherwise be complained about
as undefined.
.Tp Fl f
Request
.Nm checknr
to ignore \ef font changes.
.Tp Fl s
Ignore \es size changes.
.Tp
.Pp
.Nm Checknr
is intended for use on documents that are prepared with
.Nm checknr
in mind, much the same as
.Xr lint 1 .
It expects a certain document writing style for \ef and \es commands,
in that each \efx must be terminated with \efP and
each \esx must be terminated with \es0.
While it will work to directly go into the next font or explicitly
specify the original font or point size,
and many existing documents actually do this,
such a practice will produce complaints from
.Nm checknr .
Since it is probably better to use the \efP and \es0 forms anyway,
you should think of this as a contribution to your document
preparation style.
.Pp
.Nm Checknr
knows about the
.Xr ms 7
and
.Xr me 7
macro packages.
.Sh SEE ALSO
.Xr nroff 1 ,
.Xr troff 1 ,
.Xr checkeq 1 ,
.Xr ms 7 ,
.Xr me 7
.Sh DIAGNOSTICS
.Ds L
Complaints about unmatched delimiters.
Complaints about unrecognized commands.
Various complaints about the syntax of commands.
.De
.Sh BUGS
There is no way to define a 1 character macro name using
.Fl a .
.Pp
Does not correctly recognize certain reasonable constructs,
such as conditionals.
.Sh HISTORY
.Nm
appeared in 4.0 BSD.