utils/tex2rtf/tools/lacheck.txt

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