source: trunk/abcl/README

Last change on this file was 14975, checked in by mevenson, 3 months ago

metadata: normalize README, manual, and asdf metadata

  • Property svn:eol-style set to native
File size: 9.3 KB
Line 
1Armed Bear Common Lisp README
2=============================
3
4GENERAL INFORMATION
5-------------------
6
7Armed Bear Common Lisp is a conforming implementation of ANSI Common
8Lisp that runs in a Java virtual machine.  It compiles Lisp code
9directly to Java byte code.
10
11
12LICENSE
13=======
14
15Armed Bear Common Lisp is distributed under the GNU General Public
16License with a classpath exception (see "Classpath Exception" below).
17
18A copy of GNU General Public License (GPL) is included in this
19distribution, in the file COPYING.
20
21Linking this software statically or dynamically with other modules is
22making a combined work based on this software. Thus, the terms and
23conditions of the GNU General Public License cover the whole
24combination.
25
26
27Classpath Exception
28-------------------
29
30As a special exception, the copyright holders of this software give
31you permission to link this software with independent modules to
32produce an executable, regardless of the license terms of these
33independent modules, and to copy and distribute the resulting
34executable under terms of your choice, provided that you also meet,
35for each linked independent module, the terms and conditions of the
36license of that module. An independent module is a module which is not
37derived from or based on this software. If you modify this software,
38you may extend this exception to your version of the software, but you
39are not obligated to do so. If you do not wish to do so, delete this
40exception statement from your version.
41
42RUNNING FROM DOCKER
43===================
44
45With [Docker Engine][] installed one may execute:
46
47    docker run -it easye/abcl
48
49to get
50
51    illin:~/work/abcl$ docker run -it easye/abcl
52    Armed Bear Common Lisp 1.5.0-dev
53    Java 1.8.0_111 Oracle Corporation
54    OpenJDK 64-Bit Server VM
55    Low-level initialization completed in 0.295 seconds.
56    Startup completed in 1.425 seconds.
57    Type ":help" for a list of available commands.
58    CL-USER(1): 23
59    23
60    23
61    CL-USER(2): (require :abcl-contrib)
62    (require :abcl-contrib)
63    Using probed value of abcl-contrib:
64    '/home/abcl/work/abcl/dist/abcl-contrib.jar'.
65    Added jar:file:/home/abcl/work/abcl/dist/abcl-contrib.jar!/quicklisp/ to ASDF.
66    Added jar:file:/home/abcl/work/abcl/dist/abcl-contrib.jar!/mvn/ to ASDF.
67    Added jar:file:/home/abcl/work/abcl/dist/abcl-contrib.jar!/jss/ to ASDF.
68    Added jar:file:/home/abcl/work/abcl/dist/abcl-contrib.jar!/jfli/ to ASDF.
69    Added jar:file:/home/abcl/work/abcl/dist/abcl-contrib.jar!/asdf-jar/ to ASDF.
70    Added jar:file:/home/abcl/work/abcl/dist/abcl-contrib.jar!/abcl-introspect/ to ASDF.
71    Added jar:file:/home/abcl/work/abcl/dist/abcl-contrib.jar!/abcl-asdf/ to ASDF.
72    ("uiop" "UIOP" "asdf" "ASDF" "ABCL-CONTRIB")
73
74
75[Docker Engine]: https://www.docker.com/products/docker-engine
76
77
78Building a Docker Image With Modifications
79------------------------------------------
80
81Get the source (see below); make yer mods; use the Dockerfile to build.
82
83        docker build -t YOURID/abcl .
84        docker run -it YOURID/abcl
85
86See <file:Dockerfile> for the build instructions.
87
88
89RUNNING FROM BINARY RELEASE
90===========================
91
92After you have downloaded a binary release from either
93[Maven][maven-abcl] or from [abcl.org][abcl.org-release] archive
94unpack it into its own directory. To run ABCL directly from this
95directory, make sure Java (version 1.5 or up) is in your shell's
96path.
97
98[maven-abcl]:         <mvn:abcl.org/abcl/>
99[maven-abcl-contrib]: <mvn:abcl.org/abcl/abcl-contrib>
100[abcl.org-release:    <http://abcl.org/releases/>
101
102Then issue the following command:
103
104    cmd$ java -jar abcl.jar
105
106which should result in output like the following
107
108    Armed Bear Common Lisp 1.4.0
109    Java 1.8.0_102 Oracle Corporation
110    Java HotSpot(TM) 64-Bit Server VM
111    Low-level initialization completed in 0.324 seconds.
112    Startup completed in 1.892 seconds.
113    Type ":help" for a list of available commands.
114    CL-USER(1):
115
116Yer now at the interactive ABCL "Read Eval Print Loop" (REPL):  hacks 'n glory await.
117
118
119BUILDING FROM SOURCE RELEASE
120============================
121
122There are three ways to build ABCL from the source release with the
123preferred (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* Bootstrap ABCL using a Common Lisp implementation. Supported
130  implementations for this process: SBCL, CMUCL, OpenMCL, Allegro
131  CL, LispWorks or CLISP.
132
133In all cases you need a Java 5 or later JDK (JDK 1.[5678] have been
134tested).  Just the JRE isn't enough, as you need the Java compiler
135('javac') to compile the Java source of the ABCL implementation.
136
137Note that when deploying ABCL having JDK isn't a requirement for the
138installation site, just the equivalent JRE, as ABCL compiles directly
139to byte code, avoiding the need for the 'javac' compiler in deployment
140environments.
141
142
143Using Ant
144---------
145
146Download a binary distribution [Ant version 1.7.1 or greater][1].
147Unpack the files somewhere convenient, ensuring that the 'ant' (or
148'ant.bat' under Windows) executable is in your path and executable.
149
150[1]: http://ant.apache.org/bindownload.cgi
151
152Then simply executing
153
154    unix$ ant
155
156or
157
158    dos> ant.bat
159
160from the directory containing this README file will create an
161executable wrapper ('abcl' under UNIX, 'abcl.bat' under Windows).  Use
162this wrapper to start ABCL.
163
164
165Using NetBeans
166--------------
167
168Obtain and install the [NetBeans IDE][2]. One should be able to open
169the ABCL directory as a project in the Netbeans application, whereupon
170the usual build, run, and debug targets as invoked in the GUI are
171available.  Use the 'slime' config with a suitably linked 'swank.asd'
172in '~/.asdf-install-dir/systems/' to connect a REPL to the NetBeans
173debug process.
174
175[2]: http://netbeans.org/downloads/
176
177
178Building from Lisp
179------------------
180
181Building from another Common Lisp implementation is the most venerable
182and least tested way of building ABCL.  It produces a "non-standard"
183version of the distribution that doesn't share build instructions with
184the previous two methods, but it still may be of interest to those who
185absolutely don't want to know anything about Java.  The other Common
186Lisp implementation does not actually perform any compliation, but is
187merely used to orchestrate the invocation of tools in the JDK.
188
189First, copy the file 'customizations.lisp.in' to 'customization.lisp',
190in the directory containing this README file, editing to suit your
191situation, paying attention to the comments in the file.  The critical
192step is to have Lisp special variable '*JDK*' point to the root of the
193Java Development Kit.  Underneath the directory referenced by the
194value of '*JDK*' there should be an executable Java compiler in
195'bin/javac' ('bin/javac.exe' under Windows).
196
197Then, one may either use the 'build-from-lisp.bash' shell script or load
198the necessary files into your Lisp image by hand.
199
200### Using the 'build-from-lisp.bash' script
201
202Under UNIX-like systems, one may simply invoke the
203'build-from-lisp.bash' script.  As noted above, one must first copy the
204'customizations.lisp.in' file to 'customizations.lisp', then edit it
205to reflect the local configuration most importantly the path to the
206Java Development Kit.
207
208After configuring 'customizations.lisp', the following would use SBCL
209as the compilation driver to build ABCL:
210
211    unix$ ./build-from-lisp.bash sbcl
212
213After a successful build, you may use 'abcl' ('abcl.bat' on Windows)
214to start ABCL.  Note that this wrappers contain absolute paths, so
215you'll need to edit them if you move things around after the build.
216
217If you're developing on ABCL, you may want to use
218
219    unix$ ./build-from-lisp.bash <implementation> --clean=nil
220
221to not do a full rebuild.
222
223In case of failure in the javac stage, you might try this:
224
225    unix$ ./build-from-lisp.bash <implementation> --full=t --clean=t --batch=nil
226
227This invokes javac separately for each .java file, which avoids running
228into limitations on command line length (but is a lot slower).
229
230### Building from another Lisp manually
231
232There is also an ASDF definition in 'abcl.asd' for the BUILD-ABCL
233which can be used to load the necessary Lisp definitions, after which
234
235    CL-USER> (build-abcl:build-abcl :clean t :full t)
236
237will build ABCL.  If ASDF isn't present, simply LOAD the
238'customizations.lisp' and 'build-abcl.lisp' files to achieve the same
239effect as loading the ASDF definition.
240
241
242BUGS
243====
244
245ABCL is a conforming ANSI Common Lisp implementation.  Any other
246behavior should be reported as a bug.
247
248ABCL now has a manual stating its conformance to the ANSI standard,
249providing a compliant and practical Common Lisp implementation.
250
251
252Tests
253-----
254
255ABCL 1.4.0 now fails 47 out of 21708 total tests in the [revised and
256expanded ANSI CL test suite][ansi-test] (derived from the tests
257originally written for GCL).
258
259[ansi-test]: git+https://gitlab.common-lisp.net/ansi-test/ansi-test.git
260
261Maxima's test suite runs without failures.
262
263ABCL comes with a test suite, see the output of `ant help.test` for
264more information.
265
266### Deficiencies
267
268Many.  But Patches to address issues mentioned above will be gladly
269accepted.
270
271CONTACT
272=======
273
274Please report problems to the development mailing list:
275
276    <armedbear-devel@common-lisp.net>
277
278Have fun!
279
280AUTHORS
281=======
282
283On behalf of all ABCL development team and contributors,
284
285    Mark Evenson
286    Erik Huelsmann
287    Rudolf Schlatte
288    Alessio Stalla
289    Ville Voutilainen
290
291    olof ferada
292    pipping
293    slyrus
294    vibhu
295    dmiles
296
297October 2016
298
299
Note: See TracBrowser for help on using the repository browser.