Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

checknr(1) [netbsd man page]

CHECKNR(1)						    BSD General Commands Manual 						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 standard input.

     Recognized options are:
	   -a	Add additional pairs of macros to the list of known macros.  This must be followed by groups of six characters, each group defin-
		ing 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'.
	   -c	Define commands which would otherwise be complained about as undefined.
	   -f	Request checknr to ignore 'f' font changes.
	   -s	Ignore 's' size changes.

     Delimiters 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 is intended for use on documents that are prepared with checknr 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 actu-
     ally 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.

     checknr knows about the ms(7) and me(7) macro packages, as well as the macros from mdoc(7).

DIAGNOSTICS

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

SEE ALSO

     nroff(1), troff(1), mdoc(7), me(7), ms(7)

HISTORY

     The checknr command appeared in 4.0BSD.  Basic mdoc(7) support appeared in NetBSD 1.6.

BUGS

     There is no way to define a 1 character macro name using -a.

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

     mdoc(7) macros that are not at the beginning of the line are not recognized.  Among others, this results in too many 'Unmatched Zz' errors.

BSD
								 January 21, 2002							       BSD

Check Out this Related Man Page

DEROFF(1)						    BSD General Commands Manual 						 DEROFF(1)

NAME

     deroff -- remove nroff/troff, eqn, pic and tbl constructs

SYNOPSIS

     deroff [-ikpw] [-m a | e | l | m | s] [file ...]

DESCRIPTION

     deroff reads each file in sequence and removes all nroff(1) and troff(1) command lines, backslash constructions, macro definitions, eqn(1)
     constructs (between ``.EQ'' and ``.EN'' lines or between delimiters), pic(1) pictures, and table descriptions and writes the remainder to the
     standard output.  deroff follows chains of included files (``.so'' and ``.nx'' commands); if a file has already been included, a ``.so'' is
     ignored and a ``.nx'' terminates execution.  If no input file is given, deroff reads from the standard input.

     The options are as follows:

     -i      Ignore ``.so'' and ``.nx'' commands.

     -k      Keep blocks of text intact.  This is the default behavior unless the -m option is given.

     -m      Enable support for common macro packages.	The -m option takes the following arguments:
		   a	   recognize man(7) macros.
		   e	   recognize me(7) macros.
		   l	   remove list constructs.
		   m	   recognize mm(7) macros.
		   s	   recognize ms(7) macros.

     -p      Preserve paragraph macros.  This option only has an effect if the -m option is also specified.

     -w      Output a word list, one 'word' (string of letters, digits, and apostrophes, beginning with a letter; apostrophes are removed) per
	     line, and all other characters ignored.  Normally, the output follows the original, with the deletions mentioned above.

SEE ALSO

     eqn(1), nroff(1), pic(1), tbl(1), troff(1)

HISTORY

     deroff appeared in Version 7 AT&T UNIX.

BUGS

     deroff is not a complete troff(1) interpreter, so it can be confused by subtle constructs.  Most errors result in too much rather than too
     little output.

     The -ml option does not correctly handle nested lists.

BSD
								   June 6, 1993 							       BSD
Man Page