head     1.1;
branch   1.1.1;
access   ;
symbols  start:1.1.1.1 project:1.1.1;
locks    ; strict;
comment  @# @;


1.1
date     2009.07.09.02.51.48;  author yo2dh;  state Exp;
branches 1.1.1.1;
next     ;

1.1.1.1
date     2009.07.09.02.51.48;  author yo2dh;  state Exp;
branches ;
next     ;


desc
@@



1.1
log
@Initial revision
@
text
@First, you need SML/NJ.  See
  http://cm.bell-labs.com/cm/cs/what/smlnj/software.html
Probably any recent version will work, but I've successfully used the
RPM for version 110.07-4 from
  ftp://ftp.research.bell-labs.com/dist/smlnj/release/110/RPMS/
on a Redhat Linux 7.2 machine.  110.0.3 also works.

If you installed SML/NJ by hand, edit sources.cm to reflect the path where
you installed SML/NJ.  Look for the "EDIT ME" comments; you'll replace
"/usr/share/smlnj/lib/" with the path to the SML/NJ libraries that you
installed above.

Next, set your PATH.  Make sure your path includes the directory that
sml was installed in (e.g., /usr/share/smlnj/bin/), as well as the
directory you're installing this tool in.  Note that, due to limitations
in the current version of this tool, it can only be run from within the
directory where it's installed, but the install directory needs to be
in the PATH anyway.

Compile the software by running `make install`.  It will spew lots of
debugging messages while compiling, but you can ignore them unless
you see an error.  With any luck, this will create a file called
boonheap.x86-linux (on my Linux box, anyway; it may have a different
suffix on other OS's).

Now you can use the script `boon` to check programs for buffer overruns.
Usage is `boon source.i [source2.i ...]`; the inputs must be pre-processed
with cpp (see the `preproc` script, documented in EXAMPLES).  Error
messages are sparse.  There is currently a bug that prevents the tool from
working if you are in any directory other than the one with the source
code, so only use it from the directory containing this INSTALL file.
For a few worked examples and details, see the file EXAMPLES.

This distribution is built on top of an older version of the BANE toolkit.
The bane/ directory includes the required source, for your benefit only.
Do NOT re-distribute this, and realize that this is only a small section
of the real BANE toolkit.  We warmly thank the BANE researchers for allowing
us to use their code.  The BANE web page is listed below.
  http://www.cs.berkeley.edu/Research/Aiken/bane.html
@


1.1.1.1
log
@CVS TEST
@
text
@@
