utils/tex2rtf/tools/lacheck.1

   1 .TH "LaCheck" "1" "May 23, 1991"
   2 .SH NAME
   3 lacheck - A consistency checker for LaTeX documents.
   4 .SH SYNOPSIS
   5 .B "lacheck "
   6 .I "filename"
   7 [
   8 .I .tex
   9 ]
  10 .SH DESCRIPTION
  11 lacheck is a general purpose consistency checker for LaTeX documents.
  12 It reads a LaTeX document and displays warning messages, if it finds
  13 bad sequences. It should be noted, that the badness is
  14 .I "very "
  15 subjective.
  16 .LP
  17 The things checked are:
  18 .LP
  19 Mismatched groups (braces), environments and math mode
  20 delimiters.  When a mismatch is found, line numbers for
  21 .I "both"
  22 start and end of the mismatch is given. The error messages comes in
  23 pairs, one for the end match and one for the beginning, marked with
  24 \`<-\' and \`->\' respectively.
  25 .LP
  26 Bad spacing. This is: missing a \`\\ \' after an abbreviation, missing
  27 an \`\\@\' before a punctuation mark in a paragraph that is ended by an
  28 capital letter, double spaces like \` \~\', bad usage of ellipsis
  29 (like using ... instead of \\ldots, or using \\ldots where \\cdots
  30 should be used)
  31 .LP
  32 lacheck will read files that are input using \\input or \\include.
  33 Files with suffix \`.sty\' are omitted, as they probably will cause
  34 errors.
  35 .LP
  36 lacheck may be invoked from within Emacs(1) using compile:
  37
  38 To run:
  39 .B "M-x compile <ret>"
  40 , and then
  41 .B "C-x `"
  42 to parse the messages
  43
  44 .SH OUTPUT
  45 The output is UNIX-error like, and may be parsed using Emacs(1)
  46 compile mode. Here is a sample:
  47
  48 .PD 0
  49 lacheck compiler
  50 .TP
  51 "/usr/mef/compiler.tex", line 34: missing \`\\\\\\\\ \' after "etc."
  52 .TP
  53 "/usr/mef/compiler.tex", line 179: double space at " ~"
  54 .TP
  55 "/usr/mef/compiler.tex", line 186: <- unmatched "}"
  56 .TP
  57 "/usr/mef/compiler.tex", line 181: -> unmatched "$$"
  58 .PD 1
  59 .LP
  60 A control space \`\\ \' should be inserted at line 34, to prevent an
  61 end-of-sentence space.
  62 Also, at line 179, the first space of the sequence " ~" should
  63 probably be deleted.
  64 The last two lines is an example, where the user mistyped, and
  65 probably inserted an extra "}" somewhere.
  66
  67 .SH DIAGNOSTICS
  68 Some special cases should be explained. In cases where a sentence ends
  69 with something that lacheck thinks is an abbreviation an missing \`\\
  70 \' error may also occur, if the following sentence begins with a
  71 capital letter.
  72 .LP
  73 A mismatch error may cause more to follow, due to the chosen
  74 algorithm. In such cases just correct the
  75 .I "first"
  76 error and run lacheck again
  77 .LP
  78 Braces, environments and math mode must be balanced within a file.
  79 .SH SEE ALSO
  80 tex(1), Emacs(1), latex(1)
  81 .SH BUGS
  82 Lots... Ideas for improvements and bug reports are very welcome.
  83 Such should be
  84 directed to the author.
  85 .SH AUTHOR
  86 Kresten Krab Thorup,  Email <krab@iesd.auc.dk>