Return to checknr.1 CVS log

Up to [CSRG BSD Unix] / 43BSDReno / usr.bin / checknr

Annotation of 43BSDReno/usr.bin/checknr/checknr.1, revision 1.1.1.1

1.1       root        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 are permitted provided
                      5: .\" that: (1) source distributions retain this entire copyright notice and
                      6: .\" comment, and (2) distributions including binaries display the following
                      7: .\" acknowledgement:  ``This product includes software developed by the
                      8: .\" University of California, Berkeley and its contributors'' in the
                      9: .\" documentation or other materials provided with the distribution and in
                     10: .\" all advertising materials mentioning features or use of this software.
                     11: .\" Neither the name of the University nor the names of its contributors may
                     12: .\" be used to endorse or promote products derived from this software without
                     13: .\" specific prior written permission.
                     14: .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
                     15: .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
                     16: .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
                     17: .\"
                     18: .\"     @(#)checknr.1  6.5 (Berkeley) 7/24/90
                     19: .\"
                     20: .Dd July 24, 1990
                     21: .Dt CHECKNR 1
                     22: .Os BSD 4
                     23: .Sh NAME
                     24: .Nm checknr
                     25: .Nd check nroff/troff files
                     26: .Sh SYNOPSIS
                     27: .Nm checknr
                     28: .Op Fl s
                     29: .Op Fl f
                     30: .Op Fl \&a Ar \&.x1.y1.x2.y2. ... \&.xn.yn
                     31: .Op Fl \&c Ar \&.x1.x2.x3 ... \&.xn
                     32: .Ar file
                     33: .Sh DESCRIPTION
                     34: .Nm Checknr
                     35: checks a list of
                     36: .Xr nroff 1
                     37: or
                     38: .Xr troff 1
                     39: input files for certain kinds of errors
                     40: involving mismatched opening and closing delimiters
                     41: and unknown commands.
                     42: If no files are specified,
                     43: .Nm checknr
                     44: checks the standard input.
                     45: Delimeters checked are:
                     46: .Pp
                     47: .Df I
                     48: .Bu
                     49: Font changes using \efx ... \efP.
                     50: .Bu
                     51: Size changes using \esx ... \es0.
                     52: .Bu
                     53: Macros that come in open ... close forms, for example,
                     54: the .TS and .TE macros which must always come in pairs.
                     55: .Tp
                     56: .De
                     57: .Pp
                     58: Options:
                     59: .Tw Ds
                     60: .Tp Fl a
                     61: Add additional pairs of macros to the list of known macros.
                     62: This must be followed by groups of six characters, each group defining
                     63: a pair of macros.
                     64: The six characters are
                     65: a period,
                     66: the first macro name,
                     67: another period,
                     68: and the second macro name.
                     69: For example, to define a pair .BS and .ES, use
                     70: .Ql \-a.BS.ES
                     71: .Pp
                     72: .Tp Fl c
                     73: Define commands which would otherwise be complained about
                     74: as undefined.
                     75: .Tp Fl f
                     76: Request
                     77: .Nm checknr
                     78: to ignore \ef font changes.
                     79: .Tp Fl s
                     80: Ignore \es size changes.
                     81: .Tp
                     82: .Pp
                     83: .Nm Checknr
                     84: is intended for use on documents that are prepared with
                     85: .Nm checknr
                     86: in mind, much the same as
                     87: .Xr lint 1 .
                     88: It expects a certain document writing style for \ef and \es commands,
                     89: in that each \efx must be terminated with \efP and
                     90: each \esx must be terminated with \es0.
                     91: While it will work to directly go into the next font or explicitly
                     92: specify the original font or point size,
                     93: and many existing documents actually do this,
                     94: such a practice will produce complaints from
                     95: .Nm checknr .
                     96: Since it is probably better to use the \efP and \es0 forms anyway,
                     97: you should think of this as a contribution to your document
                     98: preparation style.
                     99: .Pp
                    100: .Nm Checknr
                    101: knows about the
                    102: .Xr ms 7
                    103: and
                    104: .Xr me 7
                    105: macro packages.
                    106: .Sh SEE ALSO
                    107: .Xr nroff 1 ,
                    108: .Xr troff 1 ,
                    109: .Xr checkeq 1 ,
                    110: .Xr ms 7 ,
                    111: .Xr me 7
                    112: .Sh DIAGNOSTICS
                    113: .Ds L
                    114: Complaints about unmatched delimiters.
                    115: Complaints about unrecognized commands.
                    116: Various complaints about the syntax of commands.
                    117: .De
                    118: .Sh BUGS
                    119: There is no way to define a 1 character macro name using
                    120: .Fl a .
                    121: .Pp
                    122: Does not correctly recognize certain reasonable constructs,
                    123: such as conditionals.
                    124: .Sh HISTORY
                    125: .Nm
                    126: appeared in 4.0 BSD.

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.