home *** CD-ROM | disk | FTP | other *** search
/ Mega Top 1 / os2_top1.zip / os2_top1 / DOS_GG / TXT / LACHEC18.DAT < prev    next >
Text File  |  1995-05-20  |  7KB  |  173 lines
  1. This archive contains OS/2 and DOS versions of LaCheck, a "lint"
  2. for LaTeX (see below). New files:
  3.  
  4.  ./ 
  5.   lacheck.exe     OS/2 1.x--2.x and DOS executable
  6.   lacheck-32.exe  OS/2 2.x executable
  7.   lacheck.1       man-page (see text version below)
  8.  src/
  9.   makefile.os2    makefile for EMX/gcc 0.8g and MSC 6.00A
  10.   lacheck.def     linker-definition file
  11.   lacheck-32.def
  12.  
  13. The 32-bit OS/2 executable will need the DLLs from the EMX distribution.
  14. These are currently available as 
  15.   ftp-os2.cdrom.com:pub/os2/2_x/unix/gnu/emx08g/emxrt.zip
  16.  
  17. --
  18. Darrel Hankerson hankedr@mail.auburn.edu
  19. 8 August 1993
  20.  
  21. =================== LaCheck 1.8 Announcement ===============================
  22. Newsgroups: comp.text.tex
  23. From: abraham@research.att.com (Per Abrahamsen)
  24. Subject: LaCheck 1.8 available for anonymous ftp
  25. Content-Type: text/plain; charset=iso-8859-1
  26. Message-ID: <ABRAHAM.93Aug8171213@steinhaus.iesd.auc.dk>
  27. Sender: news@iesd.auc.dk (UseNet News)
  28. Reply-To: auc-tex_mgr@iesd.auc.dk
  29. Content-Transfer-Encoding: 8bit
  30. Organization: AT&T Bell Laboratories, Murray Hill
  31. Date: 08 Aug 1993 15:12:13 GMT
  32.  
  33.  
  34. LaCheck is a tool for finding potential errors in LaTeX documents.
  35. LaCheck catches many errors LaTeX will ignore, and LaCheck generally
  36. gives better error messages.  Think of it as lint for LaTeX.  However,
  37. it may also give warning for correct documents.
  38.  
  39. LaCheck should work on any Unix system that `flex' has been ported
  40. to.  It may also work on other systems, I wouldn't know.  In
  41. particular, no DOS binary of this version is currently available, and
  42. I cannot create one.  LaCheck is available for anonymous ftp from:
  43.  
  44. host: ftp.iesd.auc.dk
  45. file: /pub/TeX/LaTeX/lacheck.tar.gz
  46.  
  47. New in this version is check for italic correction:
  48.  
  49. alpha% cat test.tex
  50. {\it Say {\sl goodbye {\em evil, cruel\/} world\/}\/}.
  51. alpha% lacheck test.tex
  52. "test.tex", line 1: you may need a \/ before "evil"
  53. "test.tex", line 1: \/ not needed after non-italic text " cruel"
  54. "test.tex", line 1: \/ not needed before italic text "world"
  55. "test.tex", line 1: double \/ found "\/"
  56. "test.tex", line 1: do not use \/ before "."
  57.  
  58. Also line numbers should be more correct in this version.
  59.  
  60. Man page follows:
  61.  
  62. LaCheck(1)               USER COMMANDS                 LaCheck(1)
  63.  
  64. NAME
  65.      LaCheck - A consistency checker for LaTeX documents.
  66.  
  67. SYNOPSIS
  68.      lacheck filename [ .tex ]
  69.  
  70. DESCRIPTION
  71.      LaCheck is a general purpose consistency checker  for  LaTeX
  72.      documents.   It  reads a LaTeX document and displays warning
  73.      messages, if it finds bad sequences.  It  should  be  noted,
  74.      that the badness is very subjective.  LaCheck is designed to
  75.      help find common mistakes  in  LaTeX  documents,  especially
  76.      those made by beginners.
  77.  
  78.      The things checked are:
  79.  
  80.      Mismatched groups (braces), environments and math mode  del-
  81.      imiters.   When  a  mismatch is found, line numbers for both
  82.      start and end of the mismatch is given. The  error  messages
  83.      comes in pairs, one for the end match and one for the begin-
  84.      ning, marked with `<-' and `->' respectively.
  85.  
  86.      Bad spacing including missing a `\ ' after an  abbreviation,
  87.      missing  an  `\@'  before  a punctuation mark in a paragraph
  88.      that is ended by an capital letter, double spaces like ` ~',
  89.      bad  usage of ellipsis (like using ... instead of \ldots, or
  90.      using \ldots where \cdots should be used), missing ~  before
  91.      a  \cite  or  \ref  commands, space before footnotes, italic
  92.      corrections before comma,  point,  or  italic  text,  italic
  93.      correction after normal text, missing italic correction when
  94.      switching from italic to  normal  text,  and  double  italic
  95.      correction.
  96.  
  97.      Badly placed punctuation marks around end of math mode  del-
  98.      imiters.  This  is,  pucktuators  placed right after display
  99.      math end or punctuators placed right before text  math  end.
  100.      Sequences  of  whitespace  followed by punctuation marks are
  101.      also caught.
  102.  
  103.      Bad  use  of  quotation  characters,  i.e.  constructs  like
  104.      "'word"  or  "word`"  are  warned  about,  tabs  in verbatim
  105.      environments are caught, certain TeX primitives are  frowned
  106.      upon,  attempts  to  give  font specifiers arguments such as
  107.      \em{text} are noted, and  use  of  @  in  LaTeX  macros  are
  108.      reported.
  109.  
  110.      LaCheck will read files  that  are  input  using  \input  or
  111.      \include.   Files  with  suffix  `.sty' are omitted, as they
  112.      probably will cause LaCheck to crash.
  113.  
  114.      LaCheck may be invoked from within Emacs(1) using compile:
  115.  
  116.      To run: M-x compile RET lacheck RET ,  and  then  C-x  `  to
  117.      parse the messages
  118.  
  119. OUTPUT
  120.      The output is UNIX-error  like,  and  may  be  parsed  using
  121.      Emacs(1) compile mode. Here is a sample:
  122.  
  123.      lacheck compiler
  124.      "/usr/mef/compiler.tex", line 34: missing `\ ' after "etc."
  125.      "/usr/mef/compiler.tex", line 179: double space at " ~"
  126.      "/usr/mef/compiler.tex", line 186: <- unmatched "}"
  127.      "/usr/mef/compiler.tex", line 181: -> unmatched "$$"
  128.  
  129.      A control space `\ ' should  be  inserted  at  line  34,  to
  130.      prevent  an  end-of-sentence  space.  Also, at line 179, the
  131.      first space of the sequence " ~" should probably be deleted.
  132.      The  last  two lines is an example, where the user mistyped,
  133.      and probably inserted an extra "}" somewhere.
  134.  
  135. DIAGNOSTICS
  136.      Some special cases should be explained.  In  cases  where  a
  137.      sentence  ends  with  something  that  LaCheck  thinks is an
  138.      abbreviation an missing `\ ' error may also  occur,  if  the
  139.      following sentence begins with a lowercase letter.
  140.  
  141.      A mismatch error may cause more to follow, due to the chosen
  142.      algorithm.  In  such  cases just correct the first error and
  143.      run LaCheck again
  144.  
  145.      Braces, environments and math mode must be balanced within a
  146.      file.
  147.  
  148.      LaCheck may be confused by  unmatched  stuff  placed  inside
  149.      verbatim-like   environments   called  something  else  than
  150.      exactly `verbatim'.
  151.  
  152. FILES
  153.      /usr/local/bin/lacheck
  154.  
  155. SEE ALSO
  156.      tex(1), emacs(1), latex(1)
  157.  
  158. BUGS
  159.      LaCheck gets confused by advanced macros, is fooled by  sim-
  160.      ple  macros,  can't figure out if you use a non-standard way
  161.      to switch italic on or off, does not like TeX at  all,  does
  162.      not  provide  any options to turn off specific warnings, and
  163.      is at best a crude approximation.
  164.  
  165.      Ideas for improvements and bug  reports  are  very  welcome.
  166.      Such  should  be  directed  to  the maintainers, their email
  167.      address is <auc-tex_mgr@iesd.auc.dk>.
  168.  
  169. AUTHOR
  170.      Kresten Krab Thorup with modifications by Per Abrahamsen.
  171.  
  172. Release 1.8           Last change: 08/05/93                     3
  173.