Table of Contents
ACL2 is more than just the executable image. You should obtain the distributed books and a local copy of the documentation. Start here and we will take you through the whole process of obtaining and installing ACL2.
First, create a directory in which to store ACL2 Version 5.0. We will
call this directory dir. For example, dir might be
/home/jones/acl2/v5-0
.
A collection of books (ACL2 input files typically including
definitions and theorems) has been developed over the years for use
with ACL2, typically called the "distributed books". It is important
that you obtain these books, which are distributed from the Google
Code acl2-books
project website; directions are included below.
(First, a note for Windows users only: we suggest that you obtain a
Unix-like environment or, at least, download a utility such as
djtarnt.exe
to use with the -x
option on
gzipped tarfiles. WARNING: At least one user experienced CR/LF issues
when using WinZIP, but we have received the suggestion that people
untarring with that utility should probably turn off smart cr/lf
conversion.)
md5sum
and compare
with
acl2-tar-gz-md5sum if you wish to verify the transmission.)
tar xpvfi acl2.tar
", if you have problems with
other than Gnu tar. You can see if you have Gnu tar by running
"tar -v
".)
cd dir
tar xfz acl2.tar.gz
rm acl2.tar.gz
cd acl2-sources
a
gzipped tarfile
of the distributed books, and then
extract as follows to create a books/
subdirectory: tar xfz books-5.0.tar.gz
books/
: svn checkout http://acl2-books.googlecode.com/svn/branches/5.0 books
svn checkout https://acl2-books.googlecode.com/svn/branches/5.0 books --username <name>
workshops/
and nonstd/
subdirectories
of books/
, which (respectively) are books contributed in
support of papers presented at ACL2 workshops, and
books for use with ACL2(r). However, the first method above does not
provide the workshops books or nonstd books. You can fetch them
easily as gzipped tarfiles, as follows, using the following links.
Then put the gzipped tarfile(s) in
the acl2-sources/books/
directory, connect to that
directory, and extract to create workshops/
and nonstd/
subdirectories, respectively: tar xfz workshops-5.0.tar.gz
tar xfz nonstd-5.0.tar.gz
PLEASE NOTE: The available memory for ACL2 is determined by the underlying Common Lisp executable. If you need more memory, refer to your Common Lisp's instructions for building an executable.
-md5sum
file
was created using md5sum
. We may add additional
links from time to time.
Now proceed to Using ACL2.
cd
acl2-sources
make LISP=
xxx
By default, if no LISP=
xxx is specified,
LISP=ccl
is used. On our hosts, ccl
is the name of
Clozure Common Lisp (CCL), which can be obtained as explained in the Requirements document.
This will create executable saved_acl2
in the
acl2-sources
directory.
The time taken to carry out this process depends on the host processor but may be only a few minutes for a fast processor. The size of the resulting binary image is dependent on which Lisp was used, but it may be up to a couple hundred megabytes or so.
This make
works for the Common Lisps listed
in Requirements document on systems we
have tested. See the file acl2-sources/GNUmakefile
for
further details. If this make
command does not work for
you, please see the instructions below for other
than Unix-like systems.
You can now skip to Using ACL2.
make
' utility. If you are using a trial
version of Allegro Common Lisp, then you may not be able to save
an image. In that case, skip to Running Without
Building an Executable Image.
See also Building an Executable Image on Some Particular Systems, in case you want to skip directly to the instructions in one of its subtopics.
Otherwise, proceed as follows.
Your Common Lisp should be one of those listed in
Requirements document. Filenames
below should default to the dir/acl2-sources
directory; please connect to that directory before continuing.
nsaved_acl2
if it exists.acl2-sources
directory
and submit the following sequence of commands.
; Compile (load "init.lisp") (in-package "ACL2") (compile-acl2)The commands above will compile the ACL2 sources and create compiled object files on your
acl2-sources
subdirectory.
acl2-sources
subdirectory. In the
fresh Lisp type:
; Initialization, first pass (load "init.lisp") (in-package "ACL2") (load-acl2) (initialize-acl2)This will load the new object files in the Lisp image and bootstrap ACL2 by reading and processing the source files. But the attempt at initialization will end in an error saying that it is impossible to finish because a certain file was compiled during the processing, thus dirtying the image yet again. (If however the attempt ends with an error during compilation of file
TMP1.lisp
, see the first troubleshooting tip below.)
acl2-sources
subdirectory). Then, in the
fresh Lisp type:
; Initialization, second pass (load "init.lisp") (in-package "ACL2") (save-acl2 (quote (initialize-acl2)) "saved_acl2")You have now saved an image. Exit Lisp now. Subsequent steps will put the image in the right place.
osaved_acl2
if it exists.
saved_acl2
and saved_acl2.dxl
both exist THEN:
saved_acl2.dxl
to osaved_acl2.dxl
saved_acl2
to osaved_acl2
and edit osaved_acl2
, changing saved_acl2.dxl
(at end of line) to osaved_acl2.dxl
saved_acl2
exists THEN:
saved_acl2
to osaved_acl2
nsaved_acl2
to saved_acl2
.nsaved_acl2.
suffix is created for some
suffix.
Move it to: saved_acl2.
suffixsaved_acl2
is executable. For Windows
this involves two mini-steps:
(a) Remove the"$*"
from thesaved_acl2
script (because Windows does not understand$*
). Consequently, any arguments you pass to ACL2 via the command line will be ignored.(b) Rename
saved_acl2
tosaved_acl2.bat
, for example by executing the following command.
rename saved_acl2 saved_acl2.bat
Otherwise here are steps to follow.
ftp://ftp.gnu.org/gnu/gcl/
or as explained above. You
may wish to pick a .zip
file from the cvs/
subdirectory (containing pre-releases) that has "mingw32
" in the
name.
gclm/bin/gclm.bat
that came with
gcl-cvs-20021014-mingw32
from the above ftp site, a separate
window popped up, and with an error. Many ACL2 users prefer running in an
emacs shell buffer. (We obtained emacs for Windows from ftp://ftp.gnu.org/gnu/windows/emacs/21.2/emacs-21.2-fullbin-i386.tar.gz
.)
The following modification of gclm.bat
seemed to solve the problem
(your pathnames may vary).
@ % do not delete this line % @ECHO off set cwd=%cd% path C:\gcl\gclm\mingw\bin;%PATH% C:\gcl\gclm\lib\gcl-2.6.1\unixport\saved_gcl.exe -dir C:/gcl/gclm/lib/gcl-2.6.1/unixport/ -libdir C:/gcl/gclm/lib/gcl-2.6.1/ -eval "(setq si::*allow-gzipped-file* t)" %1 %2 %3 %4 %5 %6 %7 %8 %9
saved_acl2.exe
rather than saved_acl2
.
acl2.bat
as explained in
http://www.cs.utexas.edu/users/moore/acl2/v5-0/distrib/images/Readme.html
.
We hope that the above simply works. If you experience problems, the following hints may help.
TROUBLESHOOTING:
TMP1.lisp
. That was easily remedied by starting up a
fresh GCL session and invoking (compile-file "TMP1.lisp")
before
proceeding to the next step.
http://www.faculty.idc.ac.il/yishai/reasoning/win-install.htm
,
some of which we have tried to incorporate here. A useful point made there is
that when you want to quit ACL2, use :good-bye
(or
(good-bye)
which works even in raw Lisp). Or you can use
(user::bye)
in raw Lisp. The point is: Avoid control-c
control-d
, even thought that often works fine in emacs under
Unix-like systems.
PATH
variable gcl-dir\gcc\bin
, where
gcl-dir is the directory where GCL is installed. To get to the place to
set environment variables, you might be able to go to the control panel, under
system, under advanced. Alternately, you might be able to get there by opening
My Computer
and right-clicking to get to Properties
,
then selecting the Advanced
tab. At one time, when GCL/Windows
was release as Maxima, Pete Manolios suggested adding the system variable
LD_LIBRARY_PATH with the value "maxima-dir\gcc\i386-mingw32msvc\include"; this
may or may not be necessary for your GCL installation (and the path would of
course likely be different).
We assume you have obtained ACL2 and placed it in directory dir, as
described above for Unix-like systems or other platforms.
(If you downloaded a pre-built ACL2 image, then you may skip this section.)
Connect to subdirectory acl2-sources
of dir,
start up your Common Lisp, and compile by executing the following forms.
This sequence of steps need only be performed once.
(load "init.lisp") (in-package "ACL2") (compile-acl2)Now each time you want to use ACL2, you need only execute the following forms after starting up Common Lisp in subdirectory
acl2-sources
of
dir.
(load "init.lisp") (in-package "ACL2") (load-acl2) (initialize-acl2)Note. The resulting process includes the ACL2 documentation, and hence will probably be considerably larger (perhaps twice the size) than the result of running an executable image created as described above.
Now proceed to read more about Using ACL2.
acl2-sources
may be found in the file all-files.txt
in that directory.
Readme.html; This file acl2-sources/ LICENSE ; GNU General Public License GNUmakefile ; For GNU make. TAGS ; Handy for looking at source files with emacs *.lisp ; ACL2 source files all-files.txt ; List of all files in this directory and subdirectories books/ ; NOT INCLUDED; see instructions above to fetch books doc/ ; ACL2 documentation in various formats emacs/ ; Miscellaneous emacs and file utilities, especially emacs-acl2.el init.lisp; Useful for building the system interface/ emacs/ ; Support for ACL2 "proof trees". See interface/emacs/README.doc. infix/ ; ACL2 infix printer by Mike Smith. See interface/infix/README. saved/ ; Empty directory for backing up copies during make; not important acl2.tar.gz; gzip'd tar file containing all of acl2-sources/ (see below) images/ ; Some gzip'd tar'd executables; see images/Readme.html split/ ; The result of splitting up acl2.tar.gz; see split/Readme.html
The entire acl2.tar.gz is about 6.7MB, which extracts to about 29MB. The gzipped tarfile books-5.0.tar.gz (obtained as described above) is about 10MB, which extracts to about 59MB. Additional space is required to build an image, perhaps 50 to 300 megabytes depending on the platform (including the host Lisp); and more will be required to certify books.