Return to checknr.1 CVS log

Up to [Research Unix] / researchv10dc / man / manb

Annotation of researchv10dc/man/manb/checknr.1, revision 1.1.1.1

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

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.