Return to checknr.1 CVS log

Up to [local] / src / usr.bin / checknr

Annotation of src/usr.bin/checknr/checknr.1, Revision 1.2

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