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.2 2003/06/17 04:29:25 dillon 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 a Ns Ar \&.x1.y1.x2.y2. ... \&.xn.yn
  45 .Op Fl c Ns Ar \&.x1.x2.x3 ... \&.xn
  46 .Op Fl s
  47 .Op Fl f
  48 .Ar file
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 utility 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
  61 checks the standard input.
  62 .Pp
  63 The following options are available:
  64 .Bl -tag -width indent
  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
  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 The
 103 .Nm
 104 utility is intended for use on documents that are prepared with
 105 .Nm
 106 in mind, much the same as
 107 .Xr lint 1 .
 108 It expects a certain document writing style for
 109 .Ql \ef
 110 and
 111 .Ql \es
 112 commands,
 113 in that each
 114 .Ql \efx
 115 must be terminated with
 116 .Ql \efP
 117 and
 118 each
 119 .Ql \esx
 120 must be terminated with
 121 .Ql \es0 .
 122 While it will work to directly go into the next font or explicitly
 123 specify the original font or point size,
 124 and many existing documents actually do this,
 125 such a practice will produce complaints from
 126 .Nm .
 127 Since it is probably better to use the
 128 .Ql \efP
 129 and
 130 .Ql \es0
 131 forms anyway,
 132 you should think of this as a contribution to your document
 133 preparation style.
 134 .Pp
 135 The
 136 .Nm
 137 utility knows about the
 138 .Xr ms 7
 139 and
 140 .Xr me 7
 141 macro packages.
 142 .Sh SEE ALSO
 143 .Xr nroff 1 ,
 144 .Xr troff 1 ,
 145 .Xr me 7 ,
 146 .Xr ms 7
 147 .\" .Xr checkeq 1 ,
 148 .Sh DIAGNOSTICS
 149 .Bd -ragged -compact
 150 Complaints about unmatched delimiters.
 151 Complaints about unrecognized commands.
 152 Various complaints about the syntax of commands.
 153 .Ed
 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 .Sh HISTORY
 161 The
 162 .Nm
 163 command appeared in
 164 .Bx 4.0 .