README

   1                            LCLint Version 2.5m
   2                               23 May 2000
   3
   4                               David Evans
   5                          evans@cs.virginia.edu
   6
   7
   8 LCLint Documentation
   9 ====================
  10
  11 For documentation on LCLint, please see http://lclint.cs.virginia.edu.
  12
  13 Build Instructions
  14 ==================
  15
  16 To build LCLint you need:
  17
  18    o a (hopefully ANSI-conforming) C compiler. On most modern Unix systems,
  19      cc will work fine. For older or less standard systems, gcc is
  20      recommended.
  21    o gmake, the GNU make utility. If you don't have gmake installed on your
  22      system, download it from prep.ai.mit.edu.
  23    o standard Unix tools: gzip, tar
  24
  25 1. Download the LCLint source package (lclint.src.tar.gz).
  26
  27    Copy this package to the directory where you want to build LCLint.  When
  28    the tar file is extracted, it will create an lclint-2.5m subdirectory.
  29
  30 2. Uncompress the package:
  31       gzip -d lclint.src.tar.gz
  32
  33 3. Extract files from the tar archive:
  34       tar xf lclint.src.tar
  35
  36 4. Run: configure
  37
  38    This will create a Makefile with settings for your system. If you
  39    want to install LCLint or associated libraries different
  40    directories, edit the Makefile.
  41
  42 5. Run: gmake
  43
  44    It is best to do this in an emacs shell or a buffered terminal,
  45    so you can scroll through the output.
  46
  47 6. Set environment variables
  48
  49    LARCH_PATH - path to search for lclint libraries and
  50    initializations files. If you are using the standard directories, this
  51    should be .:<base-directory>/lclint-2.5m/lib.
  52
  53    LCLIMPORTDIR - directory containing lcl imports files. If you are using
  54    the standard directories, this is <base-directory>/lclint-2.5m/imports.
  55
  56    Put the commands to set these variables (the actual commands will depend
  57    on the shell you are using) in one of your initialization dotfiles
  58    (usually ~/.environment).
  59
  60    Set up your PATH to include the directory containing
  61    lclint-2.5m/bin/lclint, or move the binary to a directory on
  62    your command path.
  63
  64 7. Run: gmake test
  65
  66    Examine the test output. If there are errors, send a bug
  67    report to lclint-bug@cs.virginia.edu
  68
  69 To subscribe to announcements of new lclint releases, send a message to
  70 majordomo@virginia.edu containing the body:
  71
  72 subscribe lclint-announce
  73
  74 To participate in discussions related to lclint, send a message to
  75 majordomo@virginia.edu containing the body:
  76
  77 subscribe lclint-interest
  78