source: trunk/abcl/README @ 14615

Last change on this file since 14615 was 14615, checked in by Mark Evenson, 9 years ago

Documentation & metadata updates prior to abcl-1.3.0 branch.

  • Property svn:eol-style set to native
File size: 6.9 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** Classpath Exception
27
28As a special exception, the copyright holders of this software give
29you permission to link this software with independent modules to
30produce an executable, regardless of the license terms of these
31independent modules, and to copy and distribute the resulting
32executable under terms of your choice, provided that you also meet,
33for each linked independent module, the terms and conditions of the
34license of that module. An independent module is a module which is not
35derived from or based on this software. If you modify this software,
36you may extend this exception to your version of the software, but you
37are not obligated to do so. If you do not wish to do so, delete this
38exception statement from your version.
39
40
41RUNNING FROM BINARY RELEASE
42===========================
43
44After you have downloaded a binary release archive unpack it into its
45own directory. To run ABCL directly from this directory, make sure
46Java (version 1.5 or up) is in your shell's path. Then issue the
47following command:
48
49    cmd$ java -jar abcl.jar
50
51which 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    Startup completed in 2.294 seconds.
58    Type ":help" for a list of available commands.
59    CL-USER(1):
60
61
62BUILDING FROM SOURCE RELEASE
63============================
64
65There are three ways to build ABCL from the source release with the
66preferred (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* Bootstrap ABCL using a Common Lisp implementation. Supported
73  implementations for this process: SBCL, CMUCL, OpenMCL, Allegro
74  CL, LispWorks or CLISP.
75
76In all cases you need a Java 5 or later JDK (JDK 1.[567] have been
77tested).  Just the JRE isn't enough, as you need the Java compiler
78('javac') to compile the Java source of the ABCL implementation.
79
80Note that when deploying ABCL having JDK isn't a requirement for the
81installation site, just the equivalent JRE, as ABCL compiles directly
82to byte code, avoiding the need for the 'javac' compiler in deployment
83environments.
84
85
86Using Ant
87---------
88
89Download a binary distribution [Ant version 1.7.1 or greater][1].
90Unpack the files somewhere convenient, ensuring that the 'ant' (or
91'ant.bat' under Windows) executable is in your path and executable.
92
93[1]: http://ant.apache.org/bindownload.cgi
94
95Then simply executing
96
97    unix$ ant
98
99or
100
101    dos> ant.bat
102
103from the directory containing this README file will create an
104executable wrapper ('abcl' under UNIX, 'abcl.bat' under Windows).  Use
105this wrapper to start ABCL.
106
107
108Using NetBeans
109--------------
110
111Obtain and install the [NetBeans IDE][2]. One should be able to open
112the ABCL directory as a project in the Netbeans application, whereupon
113the usual build, run, and debug targets as invoked in the GUI are
114available.  Use the 'slime' config with a suitably linked 'swank.asd'
115in '~/.asdf-install-dir/systems/' to connect a REPL to the NetBeans
116debug process.
117
118[2]: http://netbeans.org/downloads/
119
120
121Building from Lisp
122------------------
123
124Building from a Lisp is the most venerable and untested way of
125building ABCL.  It produces a "non-standard" version of the
126distribution that doesn't share build instructions with the previous
127two methods, but it still may be of interest to those who absolutely
128don't want to know anything about Java.
129
130First, copy the file 'customizations.lisp.in' to 'customization.lisp',
131in the directory containing this README file, editing to suit your
132situation, paying attention to the comments in the file.  The critical
133step is to have Lisp special variable '*JDK*' point to the root of the
134Java Development Kit.  Underneath the directory referenced by the
135value of '*JDK*' there should be an executable Java compiler in
136'bin/javac' ('bin/javac.exe' under Windows).
137
138Then, one may either use the 'build-from-lisp.sh' shell script or load
139the necessary files into your Lisp image by hand.
140
141** Using the 'build-from-lisp.sh' script
142
143Under UNIX-like systems, you may simply invoke the
144'build-from-lisp.sh' script as './build-from-lisp.sh
145<lisp-of-choice>', e.g.
146
147    unix$ ./build-from-lisp.sh sbcl
148
149After a successful build, you may use 'abcl' ('abcl.bat' on Windows)
150to start ABCL.  Note that this wrappers contain absolute paths, so
151you'll need to edit them if you move things around after the build.
152
153If you're developing on ABCL, you may want to use
154
155    unix$ ./build-from-lisp.sh <implementation> --clean=nil
156
157to not do a full rebuild.
158
159In case of failure in the javac stage, you might try this:
160
161    unix$ ./build-from-lisp.sh <implementation> --full=t --clean=t --batch=nil
162
163This invokes javac separately for each .java file, which avoids running
164into limitations on command line length (but is a lot slower).
165
166** Building from another Lisp by hand
167
168There is also an ASDF definition in 'abcl.asd' for the BUILD-ABCL
169which can be used to load the necessary Lisp definitions, after which
170
171    CL-USER> (build-abcl:build-abcl :clean t :full t)
172
173will build ABCL.  If ASDF isn't present, simply LOAD the
174'customizations.lisp' and 'build-abcl.lisp' files to achieve the same
175effect as loading the ASDF definition.
176
177
178BUGS
179====
180
181ABCL is a conforming ANSI Common Lisp implementation.  Any other
182behavior should be reported as a bug.
183
184ABCL now has a manual stating its conformance to the ANSI standard,
185providing a compliant and practical Common Lisp implementation.
186Because of this,
187
188
189### Tests
190
191ABCL 1.3.0 now fails only 1[2-4] out of 21708 total tests in the ANSI CL
192test suite (derived from the tests originally written for GCL).
193
194Maxima's test suite runs without failures.
195
196ABCL comes with a test suite, see the output of `ant help.test` for more
197information.
198
199### Deficiencies
200
201The MOP implementation is incompletel untested.
202
203Patches to address any of the issues mentioned above will
204be gladly accepted.
205
206# Contact
207
208Please report problems to the development mailing list:
209
210    <armedbear-devel@common-lisp.net>
211
212Have fun!
213
214# Authors
215
216On behalf of all ABCL development team and contributors,
217
218    Mark Evenson
219    Erik Huelsmann
220    Rudolf Schlatte
221    Alessio Stalla
222    Ville Voutilainen
223
224January 2014
225
226
Note: See TracBrowser for help on using the repository browser.