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