README 5.13 KB
Newer Older
1 2 3 4
GENERAL INFORMATION
===================

Armed Bear Common Lisp is an implementation of ANSI Common Lisp that
5 6
runs in a Java virtual machine.  It compiles its code to Java byte
code.
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35


LICENSE
=======

Armed Bear Common Lisp is distributed under the GNU General Public
License with classpath exception (described below).

A copy of GNU General Public License (GPL) is included in this
distribution, in the file COPYING.

Linking this software statically or dynamically with other modules is
making a combined work based on this software. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this software give
you permission to link this software with independent modules to
produce an executable, regardless of the license terms of these
independent modules, and to copy and distribute the resulting
executable under terms of your choice, provided that you also meet,
for each linked independent module, the terms and conditions of the
license of that module. An independent module is a module which is not
derived from or based on this software. If you modify this software,
you may extend this exception to your version of the software, but you
are not obligated to do so. If you do not wish to do so, delete this
exception statement from your version.


36 37 38 39 40
RUNNING FROM BINARY RELEASE
===========================

After you have downloaded a binary release archive, unzip or untar it
into its own directory. To run ABCL directly from this directory, make
41 42
sure Java (version 1.5 or up) is in your shell's path. Then issue following
command under UNIX
43

44
    unix$ ./abcl
45

46
or under Windows
47

48 49 50 51
    dos$ abcl.bat
    
To start from within Java, one can specify the use of the JAR file
directly via:
52

53 54 55 56 57 58 59 60 61 62 63
   cmd$ java -jar abcl.jar

Any of these method should result in output like the following:

    Armed Bear Common Lisp 0.19.1
    Java 1.6.0_14 Sun Microsystems Inc.
    Java HotSpot(TM) Client VM
    Low-level initialization completed in 0.9 seconds.
    Startup completed in 2.294 seconds.
    Type ":help" for a list of available commands.
    CL-USER(1):
64 65


66 67 68
BUILDING
========

69 70
If you want to build ABCL the preferred (and most tested way) is to
use the Ant build tool.
71

72
1. Use the Ant build tool for Java environments.  
73

74
2. Use the Netbeans 6.x IDE to open ABCL as a project.
75

76 77 78
3. Bootstrap ABCL using a Common Lisp implementation. Supported
   implementations for this process: SBCL, CMUCL, OpenMCL, Allegro
   CL, LispWorks or CLISP.
79 80 81


In both cases you need a supported JDK version (1.5 and 1.6 have been
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
tested).  Just the JRE isn't enough, as you need javac to compile
files.


Using Ant
---------

Download a binary distribution [Ant version 1.7.1 or greater][1].
Unpack the files somewhere convenient, ensuring that the 'ant' (or
'ant.bat' under Windows) executable is in your path and executable.

[1]: XXX

Then simply executing

    unix$  ant 

or
    cmd$ ant.bat    

from the directory containing this README file will create an
executable wrapper ('abcl' under UNIX, 'abcl.bat' under Windows).  Use
this wrapper to start ABCL.
105 106


107 108
Using NetBeans
--------------
109

110 111 112 113 114 115 116
Obtain the [Netbeans IDE][2] One should be able to open the ABCL directory
as a project in Netbeans 6.x via the appropiate menu.

[2]: XXX

Building from Lisp
------------------
117 118 119

Copy the file 'customizations.lisp.in' to customization.lisp', in the
directory containing this README file, editing to suit your situation,
120 121
paying attention to the comments in the file.  The ciritical point is
to have **JDK** point to the root of the Java Development Kit.  
122

123
Use ./build-from-lisp.sh <lisp-of-choice>, e.g.
124

125
  ./build-from-lisp.sh sbcl
126 127 128 129 130

Use abcl.bat on Windows or ./abcl on Unix to start ABCL.
Note: abcl.bat and abcl contain absolute paths, so you'll need
to edit them if you move things around after the build.

131 132 133 134 135 136 137 138

If you're developing on ABCL, you may want to use

  ./build-from-lisp.sh <implementation> --clean=nil

to not do a full rebuild.


139 140
In case of failure in the javac stage, you might try this:

141
  ./build-from-lisp.sh <implementation> --full=t --clean=t --batch=nil
142 143 144 145 146

This invokes javac separately for each .java file, which avoids running
into limitations on command line length (but is a lot slower).


147

148 149 150 151 152
BUGS
====

A lot of (renewed) energy has been spent to make ABCL a compliant
and practically useable Common Lisp implementation.  Because of this,
153
ABCL 0.19.1 now fails only 29 out of 21702 tests in the ANSI CL test
154
suite.  Next to that, the fail count of the Maxima test suite has been
155
reduced to only 5 - rounding errors.
156 157

ABCL's CLOS does not handle on-the-fly redefinition of classes
158 159 160 161
correctly. Quite a bit of energy has been spent in versions 0.16.0 and
0.17.0 to improve CLOS performance. There is no support for the long
form of DEFINE-METHOD-COMBINATION, and certain other required CLOS
features are also missing. Enough CLOS is there to run
162
ASDF2 and CL-PPCRE.
163 164 165

There is no MOP worth mentioning.

166 167
Patches to address any of the issues mentioned above will be gladly
accepted.
168

169
Please report problems to the development mailing list:
170

171
    armedbear-devel@common-lisp.net
172 173 174 175 176

Have fun!

On behalf of all ABCL development team and contributors,
Erik Huelsmann
177
March 20, 2010