This is the LISP DEBUG 0.6 release.


1. DIFFERENCES WITH THE 0.5 RELEASE
===================================

1.1 Fixed numerous bugs from the 0.6 release.
1.2 Added support for CMUCL , LISP DEBUG will now work with GCL 2.2 and CMUCL.
1.3 Added support for features ( #+ and #- constructs)
1.4 Added support for WITH- forms.
1.5 Improved macro support (handling of macros in 0.5 was wrong)
1.6 Better evaluation support for watching and eval (will not crash the debugger
    anymore).
1.7 Changed watch point interface , it only works now for variables but is
    simpler to use.
1.8 Added support for CLOS.


2. What is LISP DEBUG.

LISP DEBUG is a lisp source debugger , designed to work with GCL (GNU COMMON LISP)
and CMUCL (Both must use TCL/TK).
LISP DEBUG has the following functionality :
	- Graphical interface.
	- Breakpoints (conditional or not) can be set using point and click in the
	  source.
	- Watchpoints on variables can be set using point and click.
	- You can step through your code.
	- Profiling of code is possible.
	- Highlighting of executing code.
LISP DEBUG is developped and tested with the following code :
	- GCL-2.2 , GCL-2.2.2 using the TCL/TK extensions.
	- CMUCL 18b using TCL/TK extensions. Make sure you have the correct version of CMUCL , some of 
          the functions I use caused a core dump in previous versions.
	- TCL 7.6 or higher , TK 4.2 or higher.
	- I'm only able to test LISP DEBUG on my 'linux' system but because it is fully implemented in lisp
	  it should work on other platforms as well.


3.Installing.

3.1 Automatic installation.

Unpack the distribution files in an empty directory , make this directory current and 
use 'su' to give you adminstrative rights.
To install the 'GCL' version of the debugger , type 'make gcl'.
To install the 'CMUCL' version of the debugger , type 'make cmucl'.



Note :	- The installation routines search for the lisp installations from /usr , 
	if lisp is installed somewhere else , please modify 'TOPSEARCH' in 
	install-gcl (or install-cmucl).
        - The installation routines for 'GCL' search for 'gcl' if the command
	to start lisp is called otherwise , change 'LISP' in install-gcl.
	- The installation routines make a save of 'gcl' , 'lisp.core' ,
	'dlisp.core' and 'saved-debug' to 'gcl.old' , 'lisp.core.old' ,
	'dlisp.core.old' and 'saved-debug.old'. You can return to the old
	situation by dooing make deinstall-gcl or make deinstall-cmucl or manual
	resetting these files (remark : This will not work after two installations
	because I don't save the .old versions).


3.2 Manual installation.

3.2.1 GCL

	- Unpack the distribution files in a empty directory using 'tar -xvzf lisp-debug-0.6.tar.gz'.
	- Start lisp in this directory using 'gcl'.
	- At the lisp prompt type the following :
		- (load "debugger.lsp")
		- (compile-file "debugger.lsp")
		- (bye)
	- Start lisp again , and type :
		- (use-package "PCL") (if you want support for PCL and this is compiled in)
		- (load "debugger.x86f")
		- (gbc)
		- (si::save-system "saved-debug")
	- The 'save-debug' file should be copied to a directory like '/usr/local/lib/gcl-2.2'.
	- You should modify the 'gcl' command in '/usr/local/bin' to refer to this file (modify the 
	  'saved-... ' entry after the 'exec' command.


3.2.2 CMUCL
	- Unpack the distribution files in a empty directory using 'tar -xvzf lisp-debug-0.6.tar.gz'.
 	- Start lisp in this directory by typing 'lisp' or 'nlisp'.
	- At the lisp prompt type the following :
		- (load "debugger.lsp")
		- (compile-file "debugger.lsp")
		- (gc-off)
		- (load "debugger.x86f")
		- #-gengc (setf lisp::*need-to-collect-garbage* NIL)
		- (gc-on)
		- (save-lisp "dlisp.core")
	- This will generate a file "dlisp.core" which must replace the 'lisp.core' file of cmucl.
	- The lisp.core file is generally installed in '/usr/lib/cmucl' or '/usr/lib/ncmucl'.

4. BUGS.
	- Sometimes during selection of a source , debug will crash for no apperent raison. 
	  This is intermediant and up to this moment I have not found the cause of this.
	- I don't know of any other bugs but I'm sure that there are other bugs. If you 
	  use this product and found a bug (maybe even corrected it) send than a note to
	  me with a description of the bug and if possible your solution. I can then try
	  to correct the bug or merge your solution in my code.
	- If you think of improvements of this product please send them to me.

5. FILES.

	- Makefile  		: Makefile to install and compile the debugger.
	- README		: This file
	- debug.lyx		: LYX version of the manual.
	- debug.ps		: Postscript version of the manual.
	- debug.text		: TeX version of the manual.
	- fig1.ps		: Postscript code of the figures.
	- fig2.ps		: Postscript code of the figures.
	- fig3.ps		: Postscript code of the figures.
	- fig4.ps 		: Postscript code of the figures.
	- fig6.ps 		: Postscript code of the figures.
	- debugger.lsp		: Lisp code of the debugger.
	- filter		: Shell script filter used during the installation.
	- install-cmucl		: Shell script to install the cmucl version of the debugger.
	- install-gcl 		: Shell script to install the gcl version of the debugger.
	- test01.lsp		: Test functions to test the debugger.




Happy lisping.



Marc Mertens
mmeertens@akam.be
mmertens@akam.be




