README

   1                         Splint Version 3.0.0.20
   2                              Alpha Release
   3                             29 December 2001
   4
   5 LCLint Documentation
   6 ====================
   7
   8 For documentation on LCLint, please see http://www.splint.org
   9
  10 WARNING: this is an Alpha release - new features and changes are not
  11 reflected in the documentation.
  12
  13 Build Instructions
  14 ==================
  15
  16 To build Splint 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 You should also have:
  26
  27    o flex
  28    o bison version 1.28 or later - bison 1.27 and 1.25 are believed to
  29      have bugs that cause problems with Splint's parsers.
  30
  31 If these are unavailable, you may be able to build Splint anyway using
  32 the derived grammar files.  This is not recommended however.
  33
  34 1. Download the Splint source package (splint-<version>.src.tgz).
  35
  36    Copy this package to the directory where you want to build Splint.  When
  37    the tar file is extracted, it will create an splint-<version> subdirectory.
  38
  39 2. Extract files from the tar archive:
  40       tar xzf splint-<version>.src.tgz
  41
  42 3. Run: ./configure
  43
  44    This will create a Makefile with settings for your system. If you
  45    want to install Splint or associated libraries different
  46    directories, edit the Makefile.
  47
  48 4. Run: gmake
  49
  50    It is best to do this in an emacs shell or a buffered terminal,
  51    so you can scroll through the output.
  52
  53 6. Set environment variables
  54
  55    LARCH_PATH - path to search for splint libraries and
  56    initializations files. If you are using the standard directories, this
  57    should be .:<base-directory>/splint-3.0.0.9/lib.
  58
  59    LCLIMPORTDIR - directory containing lcl imports files. If you are using
  60    the standard directories, this is <base-directory>/splint-3.0.0.9/imports.
  61
  62    Put the commands to set these variables (the actual commands will depend
  63    on the shell you are using) in one of your initialization dotfiles
  64    (usually ~/.environment).
  65
  66    Set up your PATH to include the directory containing
  67    splint-<version>/bin/splint, or move the binary to a directory on
  68    your command path.
  69
  70 7. Run: gmake test
  71
  72    Examine the test output. If there are errors, send a bug
  73    report to splint-bug@cs.virginia.edu
  74
  75 To subscribe to announcements of new Splint releases, send a message to
  76 majordomo@virginia.edu containing the body:
  77
  78 subscribe lclint-announce
  79
  80 To participate in discussions related to Splint, send a message to
  81 majordomo@virginia.edu containing the body:
  82
  83 subscribe lclint-interest
  84
  85
  86
  87
  88
  89
  90
  91
  92