usr.bin/checknr/checknr.1

   1 .\" Copyright (c) 1980, 1990, 1993
   2 .\"     The Regents of the University of California.  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 .\"     @(#)checknr.1   8.1 (Berkeley) 6/6/93
  33 .\" $FreeBSD: src/usr.bin/checknr/checknr.1,v 1.5.2.5 2002/07/15 04:29:39 keramida Exp $
  34 .\" $DragonFly: src/usr.bin/checknr/checknr.1,v 1.4 2006/02/17 19:38:57 swildner Exp $
  35 .\"
  36 .Dd June 6, 1993
  37 .Dt CHECKNR 1
  38 .Os
  39 .Sh NAME
  40 .Nm checknr
  41 .Nd check nroff/troff files
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl fs
  45 .Op Fl a Ns Ar \&.x1.y1.x2.y2. ... \&.xn.yn
  46 .Op Fl c Ns Ar \&.x1.x2.x3 ... \&.xn
  47 .Ar file
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 utility checks a list of
  52 .Xr nroff 1
  53 or
  54 .Xr troff 1
  55 input files for certain kinds of errors
  56 involving mismatched opening and closing delimiters
  57 and unknown commands.
  58 If no files are specified,
  59 .Nm
  60 checks the standard input.
  61 .Pp
  62 The following options are available:
  63 .Bl -tag -width indent
  64 .It Fl a
  65 Add additional pairs of macros to the list of known macros.
  66 This must be followed by groups of six characters, each group defining
  67 a pair of macros.
  68 The six characters are
  69 a period,
  70 the first macro name,
  71 another period,
  72 and the second macro name.
  73 For example, to define a pair .BS and .ES, use
  74 .Sq Li \-a.BS.ES
  75 .It Fl c
  76 Define commands which would otherwise be complained about
  77 as undefined.
  78 .It Fl f
  79 Request
  80 .Nm
  81 to ignore
  82 .Ql \ef
  83 font changes.
  84 .It Fl s
  85 Ignore
  86 .Ql \es
  87 size changes.
  88 .El
  89 .Pp
  90 Delimiters checked are:
  91 .Bl -enum
  92 .It
  93 Font changes using \efx ... \efP.
  94 .It
  95 Size changes using \esx ... \es0.
  96 .It
  97 Macros that come in open ... close forms, for example,
  98 the .TS and .TE macros which must always come in pairs.
  99 .El
 100 .Pp
 101 The
 102 .Nm
 103 utility is intended for use on documents that are prepared with
 104 .Nm
 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 .
 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 The
 135 .Nm
 136 utility knows about the
 137 .Xr ms 7
 138 and
 139 .Xr me 7
 140 macro packages.
 141 .Sh DIAGNOSTICS
 142 .Bd -ragged -compact
 143 Complaints about unmatched delimiters.
 144 Complaints about unrecognized commands.
 145 Various complaints about the syntax of commands.
 146 .Ed
 147 .Sh SEE ALSO
 148 .Xr nroff 1 ,
 149 .Xr troff 1 ,
 150 .Xr me 7 ,
 151 .Xr ms 7
 152 .\" .Xr checkeq 1 ,
 153 .Sh HISTORY
 154 The
 155 .Nm
 156 command appeared in
 157 .Bx 4.0 .
 158 .Sh BUGS
 159 There is no way to define a 1 character macro name using
 160 .Fl a .
 161 .Pp
 162 Does not correctly recognize certain reasonable constructs,
 163 such as conditionals.