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