[unix-history] / usr / man / man1 / checknr.1

.\" Copyright (c) 1980 Regents of the University of California.
.\" All rights reserved.  The Berkeley software License Agreement
.\" specifies the terms and conditions for redistribution.
.\"
.\"	@(#)checknr.1	6.2 (Berkeley) 5/7/86
.\"
.TH CHECKNR 1 "May 7, 1986"
.UC 4
.SH NAME
checknr \- check nroff/troff files
.SH SYNOPSIS
.B checknr
[
.B \-s
] [
.B \-f
] [
.BR \-a ".x1.y1.x2.y2. ... .xn.yn"
] [
.BR \-c ".x1.x2.x3 ... .xn"
] [
\fIfile\fP ...
]
.SH DESCRIPTION
.I Checknr
checks a list of
.IR nroff (1)
or
.IR troff (1)
input files for certain kinds of errors
involving mismatched opening and closing delimiters
and unknown commands.
If no files are specified,
.I checknr
checks the standard input.
Delimeters checked are:
.IP (1)
Font changes using \efx ... \efP.
.IP (2)
Size changes using \esx ... \es0.
.IP (3)
Macros that come in open ... close forms, for example,
the .TS and .TE macros which must always come in pairs.
.PP
.I Checknr
knows about the
.IR ms (7)
and
.IR me (7)
macro packages.
.PP
Additional pairs of macros can be added to the list using the
.B \-a
option.
This must be followed by groups of six characters, each group defining
a pair of macros.
The six characters are
a period,
the first macro name,
another period,
and the second macro name.
For example, to define a pair .BS and .ES, use \-\fBa\fP.BS.ES
.PP
The
.B \-c
option defines commands which would otherwise be complained about
as undefined.
.PP
The
.B \-f
option requests
.I checknr
to ignore \ef font changes.
.PP
The
.B \-s
option requests
.I checknr
to ignore \es size changes.
.PP
.I Checknr
is intended to be used on documents that are prepared with
.I checknr
in mind, much the same as
.I lint.
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.
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
.I checknr.
Since it is probably better to use the \efP and \es0 forms anyway,
you should think of this as a contribution to your document
preparation style.
.SH SEE\ ALSO
nroff(1), troff(1), checkeq(1), ms(7), me(7)
.SH DIAGNOSTICS
Complaints about unmatched delimiters.
.br
Complaints about unrecognized commands.
.br
Various complaints about the syntax of commands.
.SH BUGS
There is no way to define a 1 character macro name using
.BR \-a .
.br
Does not correctly recognize certain reasonable constructs,
such as conditionals.
Commit	Line	Data
9138d903 KM	1	.\" Copyright (c) 1980 Regents of the University of California.
	2	.\" All rights reserved. The Berkeley software License Agreement
	3	.\" specifies the terms and conditions for redistribution.
	4	.\"
95f51977	5	.\" @(#)checknr.1 6.2 (Berkeley) 5/7/86
9138d903	6	.\"
95f51977	7	.TH CHECKNR 1 "May 7, 1986"
9138d903 KM	8	.UC 4
	9	.SH NAME
	10	checknr \- check nroff/troff files
	11	.SH SYNOPSIS
	12	.B checknr
	13	[
	14	.B \-s
	15	] [
	16	.B \-f
	17	] [
	18	.BR \-a ".x1.y1.x2.y2. ... .xn.yn"
	19	] [
	20	.BR \-c ".x1.x2.x3 ... .xn"
e94dc177	21	] [
9138d903	22	\fIfile\fP ...
e94dc177	23	]
9138d903 KM	24	.SH DESCRIPTION
	25	.I Checknr
	26	checks a list of
	27	.IR nroff (1)
	28	or
	29	.IR troff (1)
	30	input files for certain kinds of errors
	31	involving mismatched opening and closing delimiters
	32	and unknown commands.
e94dc177 KM	33	If no files are specified,
	34	.I checknr
	35	checks the standard input.
b6f64eb4	36	Delimeters checked are:
9138d903 KM	37	.IP (1)
	38	Font changes using \efx ... \efP.
	39	.IP (2)
	40	Size changes using \esx ... \es0.
	41	.IP (3)
	42	Macros that come in open ... close forms, for example,
	43	the .TS and .TE macros which must always come in pairs.
	44	.PP
	45	.I Checknr
	46	knows about the
	47	.IR ms (7)
	48	and
	49	.IR me (7)
	50	macro packages.
	51	.PP
	52	Additional pairs of macros can be added to the list using the
	53	.B \-a
	54	option.
	55	This must be followed by groups of six characters, each group defining
	56	a pair of macros.
	57	The six characters are
	58	a period,
	59	the first macro name,
	60	another period,
	61	and the second macro name.
	62	For example, to define a pair .BS and .ES, use \-\fBa\fP.BS.ES
	63	.PP
	64	The
	65	.B \-c
	66	option defines commands which would otherwise be complained about
	67	as undefined.
	68	.PP
	69	The
	70	.B \-f
	71	option requests
	72	.I checknr
	73	to ignore \ef font changes.
	74	.PP
	75	The
	76	.B \-s
	77	option requests
	78	.I checknr
	79	to ignore \es size changes.
	80	.PP
	81	.I Checknr
	82	is intended to be used on documents that are prepared with
	83	.I checknr
	84	in mind, much the same as
	85	.I lint.
	86	It expects a certain document writing style for \ef and \es commands,
	87	in that each \efx must be terminated with \efP and
	88	each \esx must be terminated with \es0.
	89	While it will work to directly go into the next font or explicitly
	90	specify the original font or point size,
	91	and many existing documents actually do this,
	92	such a practice will produce complaints from
	93	.I checknr.
	94	Since it is probably better to use the \efP and \es0 forms anyway,
	95	you should think of this as a contribution to your document
	96	preparation style.
	97	.SH SEE\ ALSO
e94dc177	98	nroff(1), troff(1), checkeq(1), ms(7), me(7)
9138d903 KM	99	.SH DIAGNOSTICS
	100	Complaints about unmatched delimiters.
	101	.br
	102	Complaints about unrecognized commands.
	103	.br
	104	Various complaints about the syntax of commands.
9138d903 KM	105	.SH BUGS
9138d903 KM	106	There is no way to define a 1 character macro name using
e94dc177 KM	107	.BR \-a .
	108	.br
	109	Does not correctly recognize certain reasonable constructs,
	110	such as conditionals.