[splint.git] / README

			 LCLint Version 3.0.0.9
			     Alpha Release
			     19 August 2001

LCLint Documentation
====================

For documentation on LCLint, please see http://lclint.cs.virginia.edu.

WARNING: this is an Alpha release - new features and changes are not
reflected in the documentation.  The file BUFFERCHECKING contains
preliminary documentation on the array bounds checking.

Build Instructions
==================

To build LCLint you need:

   o a (hopefully ANSI-conforming) C compiler. On most modern Unix systems,
     cc will work fine. For older or less standard systems, gcc is
     recommended.
   o gmake, the GNU make utility. If you don't have gmake installed on your
     system, download it from prep.ai.mit.edu.
   o standard Unix tools: gzip, tar

1. Download the LCLint source package (lclint.src.tar.gz).

   Copy this package to the directory where you want to build LCLint.  When
   the tar file is extracted, it will create an lclint-3.0.0.9 subdirectory.

2. Uncompress the package:
      gzip -d lclint.src.tar.gz 

3. Extract files from the tar archive:
      tar xf lclint.src.tar

4. Run: configure
  
   This will create a Makefile with settings for your system. If you 
   want to install LCLint or associated libraries different
   directories, edit the Makefile.

5. Run: gmake

   It is best to do this in an emacs shell or a buffered terminal,
   so you can scroll through the output.

6. Set environment variables

   LARCH_PATH - path to search for lclint libraries and
   initializations files. If you are using the standard directories, this
   should be .:<base-directory>/lclint-3.0.0.9/lib.

   LCLIMPORTDIR - directory containing lcl imports files. If you are using
   the standard directories, this is <base-directory>/lclint-3.0.0.9/imports.

   Put the commands to set these variables (the actual commands will depend
   on the shell you are using) in one of your initialization dotfiles
   (usually ~/.environment). 

   Set up your PATH to include the directory containing
   lclint-3.0.0.9/bin/lclint, or move the binary to a directory on
   your command path.

7. Run: gmake test

   Examine the test output. If there are errors, send a bug
   report to lclint-bug@cs.virginia.edu

To subscribe to announcements of new lclint releases, send a message to
majordomo@virginia.edu containing the body:

subscribe lclint-announce

To participate in discussions related to lclint, send a message to
majordomo@virginia.edu containing the body:

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