README 6.88 KB
Newer Older
1
2
3
Armed Bear Common Lisp README
=============================

4
GENERAL INFORMATION
5
-------------------
6

7
8
9
Armed Bear Common Lisp is a conforming implementation of ANSI Common
Lisp that runs in a Java virtual machine.  It compiles Lisp code
directly to Java byte code.
10
11
12
13
14
15


LICENSE
=======

Armed Bear Common Lisp is distributed under the GNU General Public
16
License with a classpath exception (see "Classpath Exception" below).
17
18
19
20
21
22
23
24
25

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.

26
27
** Classpath Exception 

28
29
30
31
32
33
34
35
36
37
38
39
40
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.


41
42
43
RUNNING FROM BINARY RELEASE
===========================

44
45
After you have downloaded a binary release archive unpack it into its
own directory. To run ABCL directly from this directory, make sure
46
47
Java (version 1.5 or up) is in your shell's path. Then issue the
following command:
48

49
    cmd$ java -jar abcl.jar
50

51
which should result in output like the following
52

53
    Armed Bear Common Lisp 1.3.0
54
    Java 1.7.0_51 Sun Microsystems Inc.
55
    Java HotSpot(TM) Client VM
56
    Low-level initialization completed in 0.3 seconds.
57
58
59
    Startup completed in 2.294 seconds.
    Type ":help" for a list of available commands.
    CL-USER(1):
60
61


62
63
BUILDING FROM SOURCE RELEASE
============================
64

65
66
There are three ways to build ABCL from the source release with the
preferred (and most tested way) is to being to use the Ant build tool:
67

68
* Use the Ant build tool for Java environments.
69

70
* Use the NetBeans [678].x IDE to open ABCL as a project.
71

72
73
74
* Bootstrap ABCL using a Common Lisp implementation. Supported
  implementations for this process: SBCL, CMUCL, OpenMCL, Allegro
  CL, LispWorks or CLISP.
75

76
In all cases you need a Java 5 or later JDK (JDK 1.[567] have been
77
78
tested).  Just the JRE isn't enough, as you need the Java compiler
('javac') to compile the Java source of the ABCL implementation.
79

80
81
82
83
Note that when deploying ABCL having JDK isn't a requirement for the
installation site, just the equivalent JRE, as ABCL compiles directly
to byte code, avoiding the need for the 'javac' compiler in deployment
environments.
84

85
86
87
88
89
90
91
92

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.

93
[1]: http://ant.apache.org/bindownload.cgi
94
95
96

Then simply executing

97
    unix$ ant
98
99

or
100

101
    dos> ant.bat
102
103
104
105

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.
106
107


108
109
Using NetBeans
--------------
110

111
Obtain and install the [NetBeans IDE][2]. One should be able to open
112
113
114
115
116
the ABCL directory as a project in the Netbeans application, whereupon
the usual build, run, and debug targets as invoked in the GUI are
available.  Use the 'slime' config with a suitably linked 'swank.asd'
in '~/.asdf-install-dir/systems/' to connect a REPL to the NetBeans
debug process.
117
118

[2]: http://netbeans.org/downloads/
119
120
121
122


Building from Lisp
------------------
123

124
125
126
127
128
129
Building from a Lisp is the most venerable and untested way of
building ABCL.  It produces a "non-standard" version of the
distribution that doesn't share build instructions with the previous
two methods, but it still may be of interest to those who absolutely
don't want to know anything about Java.

130
First, copy the file 'customizations.lisp.in' to 'customization.lisp',
131
132
133
134
in the directory containing this README file, editing to suit your
situation, paying attention to the comments in the file.  The critical
step is to have Lisp special variable '*JDK*' point to the root of the
Java Development Kit.  Underneath the directory referenced by the
135
value of '*JDK*' there should be an executable Java compiler in
136
'bin/javac' ('bin/javac.exe' under Windows).
137

138
139
Then, one may either use the 'build-from-lisp.sh' shell script or load
the necessary files into your Lisp image by hand.
140

141
142
143
144
145
** Using the 'build-from-lisp.sh' script

Under UNIX-like systems, you may simply invoke the
'build-from-lisp.sh' script as './build-from-lisp.sh
<lisp-of-choice>', e.g.
146

147
    unix$ ./build-from-lisp.sh sbcl
148

149
150
151
After a successful build, you may use 'abcl' ('abcl.bat' on Windows)
to start ABCL.  Note that this wrappers contain absolute paths, so
you'll need to edit them if you move things around after the build.
152
153
154

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

155
    unix$ ./build-from-lisp.sh <implementation> --clean=nil
156
157
158

to not do a full rebuild.

159
160
In case of failure in the javac stage, you might try this:

161
    unix$ ./build-from-lisp.sh <implementation> --full=t --clean=t --batch=nil
162
163
164

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

166
** Building from another Lisp by hand
167

168
169
There is also an ASDF definition in 'abcl.asd' for the BUILD-ABCL
which can be used to load the necessary Lisp definitions, after which
170
171

    CL-USER> (build-abcl:build-abcl :clean t :full t)
172

173
174
175
will build ABCL.  If ASDF isn't present, simply LOAD the
'customizations.lisp' and 'build-abcl.lisp' files to achieve the same
effect as loading the ASDF definition.
176

177

178
179
180
BUGS
====

181
182
183
ABCL is a conforming ANSI Common Lisp implementation.  Any other
behavior should be reported as a bug.

184
185
ABCL now has a manual stating its conformance to the ANSI standard,
providing a compliant and practical Common Lisp implementation.
186
187
188
189
190
Because of this, 


### Tests 

191
ABCL 1.3.0 now fails only 1[2-4] out of 21708 total tests in the ANSI CL
192
test suite (derived from the tests originally written for GCL).
193
194

Maxima's test suite runs without failures.
195

196
197
198
ABCL comes with a test suite, see the output of `ant help.test` for more
information.

199
### Deficiencies 
200

201
The MOP implementation is incompletel untested.
202

203
204
Patches to address any of the issues mentioned above will
be gladly accepted.
205

206
207
# Contact

208
Please report problems to the development mailing list:
209

210
    <armedbear-devel@common-lisp.net>
211
212
213

Have fun!

214
215
# Authors 

216
On behalf of all ABCL development team and contributors,
217

218
219
    Mark Evenson
    Erik Huelsmann
220
    Rudolf Schlatte
221
    Alessio Stalla
222
    Ville Voutilainen
223

224
March 2014
225

226