README 8.54 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 28

Classpath Exception
-------------------
29

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

42 43 44
RUNNING FROM DOCKER
===================

45
With [Docker Engine][] installed one may execute:
46

47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
    docker run -it easye/abcl

to get

    illin:~/work/abcl$ docker run -it easye/abcl
    Armed Bear Common Lisp 1.5.0-dev
    Java 1.8.0_111 Oracle Corporation
    OpenJDK 64-Bit Server VM
    Low-level initialization completed in 0.295 seconds.
    Startup completed in 1.425 seconds.
    Type ":help" for a list of available commands.
    CL-USER(1): 23
    23
    23
    CL-USER(2): (require :abcl-contrib)
    (require :abcl-contrib)
    Using probed value of abcl-contrib:
    '/home/abcl/work/abcl/dist/abcl-contrib.jar'.
    Added jar:file:/home/abcl/work/abcl/dist/abcl-contrib.jar!/quicklisp/ to ASDF.
    Added jar:file:/home/abcl/work/abcl/dist/abcl-contrib.jar!/mvn/ to ASDF.
    Added jar:file:/home/abcl/work/abcl/dist/abcl-contrib.jar!/jss/ to ASDF.
    Added jar:file:/home/abcl/work/abcl/dist/abcl-contrib.jar!/jfli/ to ASDF.
    Added jar:file:/home/abcl/work/abcl/dist/abcl-contrib.jar!/asdf-jar/ to ASDF.
    Added jar:file:/home/abcl/work/abcl/dist/abcl-contrib.jar!/abcl-introspect/ to ASDF.
    Added jar:file:/home/abcl/work/abcl/dist/abcl-contrib.jar!/abcl-asdf/ to ASDF.
    ("uiop" "UIOP" "asdf" "ASDF" "ABCL-CONTRIB")

74 75 76

[Docker Engine]: https://www.docker.com/products/docker-engine

77

78 79
Building a Docker Image With Modifications
------------------------------------------
80

81
Get the source (see below); make yer mods; use the Dockerfile to build.
82

83 84
        docker build -t YOURID/abcl .
        docker run -it YOURID/abcl 
85

86
See <file:Dockerfile> for the build instructions.
87

88

89 90 91
RUNNING FROM BINARY RELEASE
===========================

92 93 94 95 96 97 98 99 100 101 102
After you have downloaded a binary release from either
[Maven][maven-abcl] or from [abcl.org][abcl.org-release] archive
unpack it into its own directory. To run ABCL directly from this
directory, make sure Java (version 1.5 or up) is in your shell's
path. 

[maven-abcl]:         <mvn:abcl.org/abcl/>
[maven-abcl-contrib]: <mvn:abcl.org/abcl/abcl-contrib>
[abcl.org-release:    <http://abcl.org/releases/>

Then issue the following command:
103

104
    cmd$ java -jar abcl.jar
105

106
which should result in output like the following
107

108
    Armed Bear Common Lisp 1.4.0
109 110 111 112
    Java 1.8.0_102 Oracle Corporation
    Java HotSpot(TM) 64-Bit Server VM
    Low-level initialization completed in 0.324 seconds.
    Startup completed in 1.892 seconds.
113 114
    Type ":help" for a list of available commands.
    CL-USER(1):
115

116 117
Yer now at the interactive ABCL "Read Eval Print Loop" (REPL):  hacks 'n glory await.

118

119 120
BUILDING FROM SOURCE RELEASE
============================
121

122 123
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:
124

125
* Use the Ant build tool for Java environments.
126

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

129 130 131
* Bootstrap ABCL using a Common Lisp implementation. Supported
  implementations for this process: SBCL, CMUCL, OpenMCL, Allegro
  CL, LispWorks or CLISP.
132

133
In all cases you will need a Java 6 or later JDK (JDK 1.[678] have been
134 135
tested).  Just the JRE isn't enough, as you need the Java compiler
('javac') to compile the Java source of the ABCL implementation.
136

137 138 139 140
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.
141

142 143 144 145 146 147 148 149

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.

150
[1]: http://ant.apache.org/bindownload.cgi
151 152 153

Then simply executing

154
    unix$ ant
155 156

or
157

158
    dos> ant.bat
159 160 161 162

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.
163 164


165 166
Using NetBeans
--------------
167

168
Obtain and install the [NetBeans IDE][2]. One should be able to open
169 170 171 172 173
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.
174 175

[2]: http://netbeans.org/downloads/
176 177 178 179


Building from Lisp
------------------
180

181 182 183
You need to have a Java compiler installed locally.  If the Ant build
tool does not exist, it will be downloaded and used to invoke the Ant
build.
184

185
Then, one may either use the 'build-from-lisp.bash' shell script or load
186
the necessary files into your Lisp image by hand.
187

188
### Using the 'build-from-lisp.bash' script
189

190 191 192 193 194
Under UNIX-like systems, one may simply invoke the
'build-from-lisp.bash' script.  As noted above, one must first copy the
'customizations.lisp.in' file to 'customizations.lisp', then edit it
to reflect the local configuration most importantly the path to the
Java Development Kit.
195

196 197 198 199
After configuring 'customizations.lisp', the following would use SBCL
as the compilation driver to build ABCL:

    unix$ ./build-from-lisp.bash sbcl
200

201 202 203
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.
204 205 206

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

207
    unix$ ./build-from-lisp.bash <implementation> --clean=nil
208 209 210

to not do a full rebuild.

211 212
In case of failure in the javac stage, you might try this:

213
    unix$ ./build-from-lisp.bash <implementation> --full=t --clean=t --batch=nil
214 215 216

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

218
### Building from another Lisp manually
219

220
There is also an ASDF definition in 'abcl.asd' for ABCL/BUILD
221
which can be used to load the necessary Lisp definitions, after which
222 223

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

225 226 227
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.
228

229

230 231 232
BUGS
====

233 234 235
ABCL is a conforming ANSI Common Lisp implementation.  Any other
behavior should be reported as a bug.

236 237
ABCL now has a manual stating its conformance to the ANSI standard,
providing a compliant and practical Common Lisp implementation.
238 239


240 241
Tests
-----
242

243 244 245 246 247
ABCL 1.4.0 now fails 47 out of 21708 total tests in the [revised and
expanded ANSI CL test suite][ansi-test] (derived from the tests
originally written for GCL).

[ansi-test]: git+https://gitlab.common-lisp.net/ansi-test/ansi-test.git
248 249

Maxima's test suite runs without failures.
250

251 252
ABCL comes with a test suite, see the output of `ant help.test` for
more information.
253

254
### Deficiencies
255

256 257
Many.  But Patches to address issues mentioned above will be gladly
accepted.
258

259 260
CONTACT
=======
261

262
Please report problems to the development mailing list:
263

264
    <armedbear-devel@common-lisp.net>
265 266 267

Have fun!

268 269
AUTHORS
=======
270

271
On behalf of all ABCL development team and contributors,
272

273 274
    Mark Evenson
    Erik Huelsmann
275
    Rudolf Schlatte
276
    Alessio Stalla
277
    Ville Voutilainen
278

279
    olof ferada
280 281
    pipping
    slyrus
282 283
    vibhu
    dmiles
284

285
October 2016
286

287