[unix-history] / usr / share / man / cat1 / checknr.0

CHECKNR(1)		    UNIX Reference Manual		    CHECKNR(1)

N\bNA\bAM\bME\bE
     c\bch\bhe\bec\bck\bkn\bnr\br - check nroff/troff files

S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
     c\bch\bhe\bec\bck\bkn\bnr\br [-\b-s\bs] [-\b-f\bf] [-\b-a\ba ._\bx_\b1._\by_\b1._\bx_\b2._\by_\b2. ... ._\bx_\bn._\by_\bn] [-\b-c\bc ._\bx_\b1._\bx_\b2._\bx_\b3 ... ._\bx_\bn]
	     _\bf_\bi_\bl_\be

D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
     C\bCh\bhe\bec\bck\bkn\bnr\br checks a list of nroff(1) or troff(1) input files for certain
     kinds of errors involving mismatched opening and closing delimiters and
     unknown commands.	If no files are specified, c\bch\bhe\bec\bck\bkn\bnr\br checks the standard
     input.  Delimeters checked are:

	   o\bo\b\b\b+\b+	 Font changes using \fx ... \fP.

	   o\bo\b\b\b+\b+	 Size changes using \sx ... \s0.

	   o\bo\b\b\b+\b+	 Macros that come in open ... close forms, for example, the
		 .TS and .TE macros which must always come in pairs.

     Options:

     -\b-a\ba    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.  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 `-a.BS.ES'

     -\b-c\bc    Define commands which would otherwise be complained about as unde-
	   fined.

     -\b-f\bf    Request c\bch\bhe\bec\bck\bkn\bnr\br to ignore \f font changes.

     -\b-s\bs    Ignore \s size changes.

     C\bCh\bhe\bec\bck\bkn\bnr\br is intended for use on documents that are prepared with c\bch\bhe\bec\bck\bkn\bnr\br
     in mind, much the same as lint(1).  It expects a certain document writing
     style for \f and \s commands, in that each \fx must be terminated with
     \fP and each \sx must be terminated with \s0.  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 c\bch\bhe\bec\bck\bkn\bnr\br.  Since it is probably better to use
     the \fP and \s0 forms anyway, you should think of this as a contribution
     to your document preparation style.

     C\bCh\bhe\bec\bck\bkn\bnr\br knows about the ms(7) and me(7) macro packages.

S\bSE\bEE\bE A\bAL\bLS\bSO\bO
     nroff(1), troff(1), checkeq(1), ms(7), me(7)

D\bDI\bIA\bAG\bGN\bNO\bOS\bST\bTI\bIC\bCS\bS
     Complaints about unmatched delimiters.
     Complaints about unrecognized commands.
     Various complaints about the syntax of commands.

B\bBU\bUG\bGS\bS
     There is no way to define a 1 character macro name using -\b-a\ba.

     Does not correctly recognize certain reasonable constructs, such as con-
     ditionals.

H\bHI\bIS\bST\bTO\bOR\bRY\bY
     c\bch\bhe\bec\bck\bkn\bnr\br appeared in 4.0 BSD.
Commit	Line	Data
b2cd844e C	1	CHECKNR(1) UNIX Reference Manual CHECKNR(1)
	2
	3	N\bNA\bAM\bME\bE
	4	c\bch\bhe\bec\bck\bkn\bnr\br - check nroff/troff files
	5
	6	S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
	7	c\bch\bhe\bec\bck\bkn\bnr\br [-\b-s\bs] [-\b-f\bf] [-\b-a\ba ._\bx_\b1._\by_\b1._\bx_\b2._\by_\b2. ... ._\bx_\bn._\by_\bn] [-\b-c\bc ._\bx_\b1._\bx_\b2._\bx_\b3 ... ._\bx_\bn]
	8	_\bf_\bi_\bl_\be
	9
	10	D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
	11	C\bCh\bhe\bec\bck\bkn\bnr\br checks a list of nroff(1) or troff(1) input files for certain
	12	kinds of errors involving mismatched opening and closing delimiters and
	13	unknown commands. If no files are specified, c\bch\bhe\bec\bck\bkn\bnr\br checks the standard
	14	input. Delimeters checked are:
	15
	16	o\bo\b\b\b+\b+ Font changes using \fx ... \fP.
	17
	18	o\bo\b\b\b+\b+ Size changes using \sx ... \s0.
	19
	20	o\bo\b\b\b+\b+ Macros that come in open ... close forms, for example, the
	21	.TS and .TE macros which must always come in pairs.
	22
	23	Options:
	24
	25	-\b-a\ba Add additional pairs of macros to the list of known macros. This
	26	must be followed by groups of six characters, each group defining a
	27	pair of macros. The six characters are a period, the first macro
	28	name, another period, and the second macro name. For example, to
	29	define a pair .BS and .ES, use `-a.BS.ES'
	30
	31	-\b-c\bc Define commands which would otherwise be complained about as unde-
	32	fined.
	33
	34	-\b-f\bf Request c\bch\bhe\bec\bck\bkn\bnr\br to ignore \f font changes.
	35
	36	-\b-s\bs Ignore \s size changes.
	37
	38	C\bCh\bhe\bec\bck\bkn\bnr\br is intended for use on documents that are prepared with c\bch\bhe\bec\bck\bkn\bnr\br
	39	in mind, much the same as lint(1). It expects a certain document writing
	40	style for \f and \s commands, in that each \fx must be terminated with
	41	\fP and each \sx must be terminated with \s0. While it will work to
	42	directly go into the next font or explicitly specify the original font or
	43	point size, and many existing documents actually do this, such a practice
	44	will produce complaints from c\bch\bhe\bec\bck\bkn\bnr\br. Since it is probably better to use
	45	the \fP and \s0 forms anyway, you should think of this as a contribution
	46	to your document preparation style.
	47
	48	C\bCh\bhe\bec\bck\bkn\bnr\br knows about the ms(7) and me(7) macro packages.
	49
	50	S\bSE\bEE\bE A\bAL\bLS\bSO\bO
	51	nroff(1), troff(1), checkeq(1), ms(7), me(7)
	52
	53	D\bDI\bIA\bAG\bGN\bNO\bOS\bST\bTI\bIC\bCS\bS
	54	Complaints about unmatched delimiters.
	55	Complaints about unrecognized commands.
	56	Various complaints about the syntax of commands.
	57
	58	B\bBU\bUG\bGS\bS
	59	There is no way to define a 1 character macro name using -\b-a\ba.
	60
	61	Does not correctly recognize certain reasonable constructs, such as con-
	62	ditionals.
	63
	64	H\bHI\bIS\bST\bTO\bOR\bRY\bY
65	c\bch\bhe\bec\bck\bkn\bnr\br appeared in 4.0 BSD.