BSD 4_3_Net_2 release

[unix-history] / usr / src / usr.bin / checknr / checknr.1

diff --git a/usr/src/usr.bin/checknr/checknr.1 b/usr/src/usr.bin/checknr/checknr.1
index 9ab6a57..1f6a660 100644 (file)
--- a/usr/src/usr.bin/checknr/checknr.1
+++ b/usr/src/usr.bin/checknr/checknr.1
@@ -1,23 +1,37 @@
 .\" Copyright (c) 1980, 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" Copyright (c) 1980, 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" be used to endorse or promote products derived from this software without
-.\" specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"     @(#)checknr.1  6.5 (Berkeley) 7/24/90
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.Dd July 24, 1990
+.\"     @(#)checknr.1  6.6 (Berkeley) 3/14/91
+.\"
+.Dd March 14, 1991

 .Dt CHECKNR 1
 .Os BSD 4
 .Sh NAME
 .Dt CHECKNR 1
 .Os BSD 4
 .Sh NAME


@@ -25,10 +39,10 @@
 .Nd check nroff/troff files
 .Sh SYNOPSIS
 .Nm checknr
 .Nd check nroff/troff files
 .Sh SYNOPSIS
 .Nm checknr

+.Op Fl a Ns Ar \&.x1.y1.x2.y2. ... \&.xn.yn
+.Op Fl c Ns Ar \&.x1.x2.x3 ... \&.xn

 .Op Fl s
 .Op Fl f
 .Op Fl s
 .Op Fl f

-.Op Fl \&a Ar \&.x1.y1.x2.y2. ... \&.xn.yn
-.Op Fl \&c Ar \&.x1.x2.x3 ... \&.xn

 .Ar file
 .Sh DESCRIPTION
 .Nm Checknr
 .Ar file
 .Sh DESCRIPTION
 .Nm Checknr


@@ -42,22 +56,10 @@ and unknown commands.
 If no files are specified,
 .Nm checknr
 checks the standard input.
 If no files are specified,
 .Nm checknr
 checks the standard input.

-Delimeters checked are:
-.Pp
-.Df I
-.Bu
-Font changes using \efx ... \efP.
-.Bu
-Size changes using \esx ... \es0.
-.Bu
-Macros that come in open ... close forms, for example,
-the .TS and .TE macros which must always come in pairs.
-.Tp
-.De

 .Pp
 Options:
 .Pp
 Options:

-.Tw Ds
-.Tp Fl a
+.Bl -tag -width Ds
+.It Fl a

 Add additional pairs of macros to the list of known macros.
 This must be followed by groups of six characters, each group defining
 a pair of macros.
 Add additional pairs of macros to the list of known macros.
 This must be followed by groups of six characters, each group defining
 a pair of macros.


@@ -67,33 +69,62 @@ the first macro name,
 another period,
 and the second macro name.
 For example, to define a pair .BS and .ES, use
 another period,
 and the second macro name.
 For example, to define a pair .BS and .ES, use

-.Ql \-a.BS.ES
-.Pp
-.Tp Fl c
+.Sq Li \-a.BS.ES
+.It Fl c

 Define commands which would otherwise be complained about
 as undefined.
 Define commands which would otherwise be complained about
 as undefined.

-.Tp Fl f
+.It Fl f

 Request
 .Nm checknr
 Request
 .Nm checknr

-to ignore \ef font changes.
-.Tp Fl s
-Ignore \es size changes.
-.Tp
+to ignore
+.Ql\ef
+font changes.
+.It Fl s
+Ignore
+.Ql \es
+size changes.
+.El
+.Pp
+Delimeters checked are:
+.Bl -enum
+.It
+Font changes using \efx ... \efP.
+.It
+Size changes using \esx ... \es0.
+.It
+Macros that come in open ... close forms, for example,
+the .TS and .TE macros which must always come in pairs.
+.El

 .Pp
 .Nm Checknr
 is intended for use on documents that are prepared with
 .Nm checknr
 in mind, much the same as
 .Xr lint 1 .
 .Pp
 .Nm Checknr
 is intended for use on documents that are prepared with
 .Nm checknr
 in mind, much the same as
 .Xr lint 1 .

-It expects a certain document writing style for \ef and \es commands,
-in that each \efx must be terminated with \efP and
-each \esx must be terminated with \es0.
+It expects a certain document writing style for
+.Ql \ef
+and
+.Ql \es
+commands,
+in that each
+.Ql \efx
+must be terminated with
+.Ql \efP
+and
+each
+.Ql \esx
+must be terminated with
+.Ql \es0 .

 While it will work to directly go into the next font or explicitly
 specify the original font or point size,
 and many existing documents actually do this,
 such a practice will produce complaints from
 .Nm checknr .
 While it will work to directly go into the next font or explicitly
 specify the original font or point size,
 and many existing documents actually do this,
 such a practice will produce complaints from
 .Nm checknr .

-Since it is probably better to use the \efP and \es0 forms anyway,
+Since it is probably better to use the
+.Ql \efP
+and
+.Ql \es0
+forms anyway,

 you should think of this as a contribution to your document
 preparation style.
 .Pp
 you should think of this as a contribution to your document
 preparation style.
 .Pp


@@ -110,11 +141,11 @@ macro packages.
 .Xr ms 7 ,
 .Xr me 7
 .Sh DIAGNOSTICS
 .Xr ms 7 ,
 .Xr me 7
 .Sh DIAGNOSTICS

-.Ds L
+.Bd -ragged -compact

 Complaints about unmatched delimiters.
 Complaints about unrecognized commands.
 Various complaints about the syntax of commands.
 Complaints about unmatched delimiters.
 Complaints about unrecognized commands.
 Various complaints about the syntax of commands.

-.De
+.Ed

 .Sh BUGS
 There is no way to define a 1 character macro name using
 .Fl a .
 .Sh BUGS
 There is no way to define a 1 character macro name using
 .Fl a .


@@ -122,5 +153,7 @@ There is no way to define a 1 character macro name using
 Does not correctly recognize certain reasonable constructs,
 such as conditionals.
 .Sh HISTORY
 Does not correctly recognize certain reasonable constructs,
 such as conditionals.
 .Sh HISTORY

+The

 .Nm
 .Nm

-appeared in 4.0 BSD.
+command appeared in 
+.Bx 4.0 .