README

   1           Splint - annotation-assisted static program checker
   2                          http://www.splint.org
   3
   4                         Copyright (C) 1994-2002
   5                         University of Virginia,
   6                  Massachusetts Institute of Technology
   7
   8                              Version 3.0.1
   9                              7 January 2001
  10
  11 Splint Documentation
  12 ====================
  13
  14 For documentation on Splint, please see http://www.splint.org
  15
  16 WARNING: this is an Alpha release - new features and changes are not
  17 reflected in the documentation.
  18
  19 Build Instructions
  20 ==================
  21
  22 To build Splint you need:
  23
  24    o a (hopefully ANSI-conforming) C compiler. On most modern Unix systems,
  25      cc will work fine. For older or less standard systems, gcc is
  26      recommended.
  27    o gmake, the GNU make utility. If you don't have gmake installed on your
  28      system, download it from prep.ai.mit.edu.
  29    o standard Unix tools: gzip, tar
  30
  31 You should also have:
  32
  33    o flex
  34    o bison version 1.28 or later - bison 1.27 and 1.25 are believed to
  35      have bugs that cause problems with Splint's parsers.
  36
  37 If these are unavailable, you may be able to build Splint anyway using
  38 the derived grammar files.  This is not recommended however.
  39
  40 1. Download the Splint source package (splint-<version>.src.tgz).
  41
  42    Copy this package to the directory where you want to build Splint.  When
  43    the tar file is extracted, it will create an splint-<version> subdirectory.
  44
  45 2. Extract files from the tar archive:
  46       tar xzf splint-<version>.src.tgz
  47
  48 3. Run: ./configure
  49
  50    This will create a Makefile with settings for your system. If you
  51    want to install Splint or associated libraries different
  52    directories, edit the Makefile.
  53
  54 4. Run: gmake
  55
  56    It is best to do this in an emacs shell or a buffered terminal,
  57    so you can scroll through the output.
  58
  59 6. Set environment variables
  60
  61    LARCH_PATH - path to search for splint libraries and
  62    initializations files. If you are using the standard directories, this
  63    should be .:<base-directory>/splint-<version>/lib.
  64
  65    LCLIMPORTDIR - directory containing lcl imports files. If you are using
  66    the standard directories, this is <base-directory>/splint-<version>/imports.
  67
  68    Put the commands to set these variables (the actual commands will depend
  69    on the shell you are using) in one of your initialization dotfiles
  70    (usually ~/.environment).
  71
  72    Set up your PATH to include the directory containing
  73    splint-<version>/bin/splint, or move the binary to a directory on
  74    your command path.
  75
  76 7. Run: gmake test
  77
  78    Examine the test output. If there are errors, send a bug
  79    report to splint-bug@cs.virginia.edu
  80
  81 To subscribe to announcements of new Splint releases, send a message to
  82 majordomo@virginia.edu containing the body:
  83
  84 subscribe lclint-announce
  85
  86 To participate in discussions related to Splint, send a message to
  87 majordomo@virginia.edu containing the body:
  88
  89 subscribe lclint-interest
  90
  91
  92
  93
  94
  95
  96
  97
  98