Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
CHECKNR(1)		   BSD System Compatibility		    CHECKNR(1)

NAME
       checknr - check nroff/troff files

SYNOPSIS
       checknr [-fs] [-a.x1.y1.x2.y2. ... .xn.yn] [-c.x1.x2.x3 ... .xn]	[file
	      ...]

DESCRIPTION
       Checknr 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, checknr checks the	 stan-
       dard input.  Delimeters checked are:

       (1)    Font changes using \fx ... \fP.

       (2)    Size changes using \sx ... \s0.

       (3)    Macros  that  come in open ... close forms, for example, the .TS
	      and .TE macros which must	always come in pairs.

       Checknr knows about the ms(7) and me(7) macro packages.

       Additional pairs	of macros can be added to the list using  the  -a  op-
       tion.   This  must be followed by groups	defining pairs of macros.  The
       characters in each group	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

       The -c option defines commands  which  would  otherwise	be  complained
       about as	undefined.

       The -f option requests checknr to ignore	\f font	changes.

       The -s option requests checknr to ignore	\s size	changes.

       Checknr	is  intended  to  be  used on documents	that are prepared with
       checknr in mind,	much the same as lint.	It expects a certain  document
       writing	style  for \f and \s commands, in that each \fx	must be	termi-
       nated 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	origi-
       nal font	or point size, and many	existing documents actually  do	 this,
       such  a	practice  will	produce	 complaints from checknr.  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.

SEE ALSO
       nroff(1), troff(1), checkeq(1), ms(7), me(7)

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

NOTES
       Does  not  correctly  recognize	certain	reasonable constructs, such as
       conditionals.

4th Berkeley Distribution	    11/6/05			    CHECKNR(1)

NAME | SYNOPSIS | DESCRIPTION | SEE ALSO | DIAGNOSTICS | NOTES

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=checknr&sektion=1&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help