1 | GENERAL INFORMATION |
---|
2 | =================== |
---|
3 | |
---|
4 | Armed Bear Common Lisp is an implementation of ANSI Common Lisp that |
---|
5 | runs in a Java virtual machine. It compiles its code to Java byte |
---|
6 | code. |
---|
7 | |
---|
8 | |
---|
9 | LICENSE |
---|
10 | ======= |
---|
11 | |
---|
12 | Armed Bear Common Lisp is distributed under the GNU General Public |
---|
13 | License with classpath exception (described below). |
---|
14 | |
---|
15 | A copy of GNU General Public License (GPL) is included in this |
---|
16 | distribution, in the file COPYING. |
---|
17 | |
---|
18 | Linking this software statically or dynamically with other modules is |
---|
19 | making a combined work based on this software. Thus, the terms and |
---|
20 | conditions of the GNU General Public License cover the whole |
---|
21 | combination. |
---|
22 | |
---|
23 | As a special exception, the copyright holders of this software give |
---|
24 | you permission to link this software with independent modules to |
---|
25 | produce an executable, regardless of the license terms of these |
---|
26 | independent modules, and to copy and distribute the resulting |
---|
27 | executable under terms of your choice, provided that you also meet, |
---|
28 | for each linked independent module, the terms and conditions of the |
---|
29 | license of that module. An independent module is a module which is not |
---|
30 | derived from or based on this software. If you modify this software, |
---|
31 | you may extend this exception to your version of the software, but you |
---|
32 | are not obligated to do so. If you do not wish to do so, delete this |
---|
33 | exception statement from your version. |
---|
34 | |
---|
35 | |
---|
36 | RUNNING FROM BINARY RELEASE |
---|
37 | =========================== |
---|
38 | |
---|
39 | After you have downloaded a binary release archive, unzip or untar it |
---|
40 | into its own directory. To run ABCL directly from this directory, make |
---|
41 | sure Java (version 1.5 or up) is in your shell's path. Then issue |
---|
42 | following command |
---|
43 | |
---|
44 | cmd$ java -jar abcl.jar |
---|
45 | |
---|
46 | which should result in output like the following |
---|
47 | |
---|
48 | Armed Bear Common Lisp 0.19.1 |
---|
49 | Java 1.6.0_14 Sun Microsystems Inc. |
---|
50 | Java HotSpot(TM) Client VM |
---|
51 | Low-level initialization completed in 0.9 seconds. |
---|
52 | Startup completed in 2.294 seconds. |
---|
53 | Type ":help" for a list of available commands. |
---|
54 | CL-USER(1): |
---|
55 | |
---|
56 | |
---|
57 | BUILDING FROM SOURCE RELEASE |
---|
58 | ============================ |
---|
59 | |
---|
60 | If you want to build ABCL forom source the preferred (and most tested |
---|
61 | way) is to use the Ant build tool. |
---|
62 | |
---|
63 | 1. Use the Ant build tool for Java environments. |
---|
64 | |
---|
65 | 2. Use the Netbeans 6.x IDE to open ABCL as a project. |
---|
66 | |
---|
67 | 3. Bootstrap ABCL using a Common Lisp implementation. Supported |
---|
68 | implementations for this process: SBCL, CMUCL, OpenMCL, Allegro |
---|
69 | CL, LispWorks or CLISP. |
---|
70 | |
---|
71 | |
---|
72 | In both cases you need a supported JDK version (1.5 and 1.6 have been |
---|
73 | tested). Just the JRE isn't enough, as you need javac to compile |
---|
74 | files. |
---|
75 | |
---|
76 | |
---|
77 | Using Ant |
---|
78 | --------- |
---|
79 | |
---|
80 | Download a binary distribution [Ant version 1.7.1 or greater][1]. |
---|
81 | Unpack the files somewhere convenient, ensuring that the 'ant' (or |
---|
82 | 'ant.bat' under Windows) executable is in your path and executable. |
---|
83 | |
---|
84 | [1]: http://ant.apache.org/bindownload.cgi |
---|
85 | |
---|
86 | Then simply executing |
---|
87 | |
---|
88 | unix$ ant |
---|
89 | |
---|
90 | or |
---|
91 | cmd$ ant.bat |
---|
92 | |
---|
93 | from the directory containing this README file will create an |
---|
94 | executable wrapper ('abcl' under UNIX, 'abcl.bat' under Windows). Use |
---|
95 | this wrapper to start ABCL. |
---|
96 | |
---|
97 | |
---|
98 | Using NetBeans |
---|
99 | -------------- |
---|
100 | |
---|
101 | Obtain and install the [Netbeans IDE][2]. One should be able to open |
---|
102 | the ABCL directory as a project in the Netbeans 6.x application. |
---|
103 | |
---|
104 | [2]: http://netbeans.org/downloads/ |
---|
105 | |
---|
106 | |
---|
107 | Building from Lisp |
---|
108 | ------------------ |
---|
109 | |
---|
110 | Building from a Lisp is the most venerable and untested way of |
---|
111 | building ABCL. It produces a "non-standard" version of the |
---|
112 | distribution that doesn't share build instructions with the previous |
---|
113 | two methods, but it still may be of interest to those who absolutely |
---|
114 | don't want to know anything about Java. |
---|
115 | |
---|
116 | First, copy the file 'customizations.lisp.in' to customization.lisp', in the |
---|
117 | directory containing this README file, editing to suit your situation, |
---|
118 | paying attention to the comments in the file. The ciritical point is |
---|
119 | to have **JDK** point to the root of the Java Development Kit. There |
---|
120 | should be a `**JDK**/bin/javac' java compiler present. |
---|
121 | |
---|
122 | Use ./build-from-lisp.sh <lisp-of-choice>, e.g. |
---|
123 | |
---|
124 | unix$ ./build-from-lisp.sh sbcl |
---|
125 | |
---|
126 | Use abcl.bat on Windows or ./abcl on Unix to start ABCL. |
---|
127 | Note: abcl.bat and abcl contain absolute paths, so you'll need |
---|
128 | to edit them if you move things around after the build. |
---|
129 | |
---|
130 | |
---|
131 | If you're developing on ABCL, you may want to use |
---|
132 | |
---|
133 | unix$ ./build-from-lisp.sh <implementation> --clean=nil |
---|
134 | |
---|
135 | to not do a full rebuild. |
---|
136 | |
---|
137 | In case of failure in the javac stage, you might try this: |
---|
138 | |
---|
139 | unix$ ./build-from-lisp.sh <implementation> --full=t --clean=t --batch=nil |
---|
140 | |
---|
141 | This invokes javac separately for each .java file, which avoids running |
---|
142 | into limitations on command line length (but is a lot slower). |
---|
143 | |
---|
144 | There is also an ASDF definition in 'abcl.asd' for BUILD-ABCL which |
---|
145 | can be used to load the necessary Lisp defintions, after which |
---|
146 | |
---|
147 | |
---|
148 | CL-USER> (build-abcl:build-abcl :clean t :full t) |
---|
149 | |
---|
150 | will build ABCL. |
---|
151 | |
---|
152 | |
---|
153 | |
---|
154 | BUGS |
---|
155 | ==== |
---|
156 | |
---|
157 | A lot of (renewed) energy has been spent to make ABCL a compliant |
---|
158 | and practically useable Common Lisp implementation. Because of this, |
---|
159 | ABCL 0.19.1 now fails only 29 out of 21702 tests in the ANSI CL test |
---|
160 | suite. Next to that, the fail count of the Maxima test suite has been |
---|
161 | reduced to only 5 - rounding errors. |
---|
162 | |
---|
163 | ABCL's CLOS does not handle on-the-fly redefinition of classes |
---|
164 | correctly. Quite a bit of energy has been spent in versions 0.16.0 and |
---|
165 | 0.17.0 to improve CLOS performance. There is no support for the long |
---|
166 | form of DEFINE-METHOD-COMBINATION, and certain other required CLOS |
---|
167 | features are also missing. Enough CLOS is there to run |
---|
168 | ASDF2 and CL-PPCRE. |
---|
169 | |
---|
170 | There is no MOP worth mentioning. |
---|
171 | |
---|
172 | Patches to address any of the issues mentioned above will be gladly |
---|
173 | accepted. |
---|
174 | |
---|
175 | Please report problems to the development mailing list: |
---|
176 | |
---|
177 | armedbear-devel@common-lisp.net |
---|
178 | |
---|
179 | Have fun! |
---|
180 | |
---|
181 | On behalf of all ABCL development team and contributors, |
---|
182 | Erik Huelsmann |
---|
183 | March 20, 2010 |
---|