Obtaining and Installing ACL2

[Back to main page of Installation Guide.]

Table of Contents

ACL2 is more than just the executable image. In particular, it comes with a user's manual, but you will almost certainly want to obtain the distributed books. 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 6.4. We will call this directory dir. For example, dir might be /home/jones/acl2/v6-4.

NOTE: If you intend to obtain an incremental release (e.g. 2.9.4 as opposed to 2.9), please see the ACL2 News for instructions. Otherwise, continue reading here.

A collection of books (ACL2 input files typically including definitions and theorems) has been developed over the years for use with ACL2, called the "community books". It is very useful to obtain these books, which are distributed from the Google Code acl2-books project website; directions are included below.

Pre-built Binary Distributions

Visit the "Recent changes to this page" link on the ACL2 home page to see if there are other shortcuts available.

WARNING: Some of these packages might be for old version of ACL2. We recommend that you use the latest version of ACL2 (Version 6.4).

Obtaining the Sources and Community Books

Obtain the sources and place them in directory dir as follows.

(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.)

Creating or Obtaining an Executable Image

The next step is to create an executable image. The common approach is to build that image from the sources you have already obtained. However, you may be able to take a short cut by downloading an ACL2 image, in which case you can skip ahead to Summary of Distribution. Otherwise you should click on one of the links just below. Choose the last option if you are using a Common Lisp on which you cannot save an image (e.g., a trial version of Allegro Common Lisp).

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.

Short Cut: Pre-Built ACL2 Images

The site http://www.cs.utexas.edu/users/moore/acl2/v6-4/distrib/images/Readme.html contains links to ACL2 executables and packages. Each -md5sum file was created using md5sum. We may add additional links from time to time.

Now proceed to Using ACL2.

Building an Executable Image on a Unix-like System

We assume you have obtained ACL2 and placed it in directory dir, as described above. If you downloaded a pre-built ACL2 image, you may skip this section. Connect to dir as above and execute

cd acl2-sources
make LISP=xxx

where xxx is the command to run your local Common Lisp.

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.

Building an Executable Image on Other than a Unix-like System

Next we describe how to create a binary image containing ACL2 without using the `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.

  1. Remove file nsaved_acl2 if it exists.
  2. Start up Common Lisp in the acl2-sources directory and submit the following sequence of commands.
      ; Compile
      (load "init.lisp")
      (in-package "ACL2")
    The commands above will compile the ACL2 sources and create compiled object files on your acl2-sources subdirectory.
  3. Now exit your Common Lisp and invoke a fresh copy of it (mainly to avoid saving an image with the garbage created by the compilation process). Again arrange to connect to the acl2-sources subdirectory. In the fresh Lisp type:
      ; Initialization, first pass
      (load "init.lisp")
      (in-package "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.)
  4. So now exit your Common Lisp and invoke a fresh copy of it (again arranging to connect to your acl2-sources subdirectory). Then, in the fresh Lisp type:
      ; Initialization, second pass
      (load "init.lisp")
      (in-package "ACL2")
      (save-acl2 (quote (initialize-acl2))
    You have now saved an image. Exit Lisp now. Subsequent steps will put the image in the right place.

  5. Remove osaved_acl2 if it exists.

  6. IF saved_acl2 and saved_acl2.dxl both exist THEN: ELSE IF saved_acl2 exists THEN:
  7. Move nsaved_acl2 to saved_acl2.
  8. For some Common Lisps, a file nsaved_acl2.suffix is created for some suffix. Move it to: saved_acl2.suffix
  9. Make sure saved_acl2 is executable. For Windows this involves two mini-steps:
    (a) Remove the "$*" from the saved_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 to saved_acl2.bat, for example by executing the following command.

    rename saved_acl2 saved_acl2.bat

Building an Executable Image on Some Particular Systems

Subtopics of this section are as follows.

Special Case: Building an Executable Image on a Windows System using GCL

You may want to skip this section and instead read Instructions from David Rager for building ACL2 on Windows. Or, you may be able to download a pre-built ACL2 image for Windows instead of reading this section.

Otherwise here are steps to follow.

  1. FIRST get GCL running on your Windows system using ONE of the following two options. Note that GCL can be unhappy with spaces in filenames, so you should probably save the GCL distribution to a directory whose path is free of spaces.
  2. SECOND, create an appropriate GCL batch file. When we tried running the script 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.2\unixport\saved_gcl.exe -dir C:/gcl/gclm/lib/gcl-2.6.2/unixport/ -libdir  C:/gcl/gclm/lib/gcl-2.6.2/ -eval "(setq si::*allow-gzipped-file* t)" %1 %2 %3 %4 %5 %6 %7 %8 %9
  3. THIRD, follow the instructions for other than Unix-like systems above, though the resulting file may be called saved_acl2.exe rather than saved_acl2.
  4. FINALLY, create a file acl2.bat as explained in http://www.cs.utexas.edu/users/moore/acl2/v6-4/distrib/images/Readme.html.

We hope that the above simply works. If you experience problems, the following hints may help.


Running Without Building an Executable Image

The most convenient way to use ACL2 is first to install an executable image as described above for Unix-like systems and other platforms. However, in some cases this is not possible, for example if you are using a trial version of Allegro Common Lisp. In that case you should follow the steps below each time you want to start up ACL2.

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")
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")
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.

Summary of Distribution

The ACL2 distribution, acl2.tar.gz, includes the ACL2 source files as well as the following files and directories (and a few others not mentioned here). Note that a books/ directory is not included; see instructions above to fetch the community books.
  LICENSE       ; ACL2 license file
  GNUmakefile   ; For GNU make
  TAGS          ; Handy for looking at source files with emacs
  doc/          ; ACL2 documentation
  emacs/        ; Some helpful emacs utilities
  installation/ ; Installation instructions (start with installation.html)
  saved/        ; Empty directory for backing up copies during make
Also available are the following.

We estimate that the entire acl2.tar.gz consists of approximately 6 MB, which extracts to about 29 MB, and the size of gzipped tarfile books-6.4.tar.gz (obtained as described above) is about 14 MB, which extracts to about 180 MB. 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.

[Back to Installation Guide.]

Bleeding-edge Distributions via SVN

We strongly recommend that ACL2 users update their local copies of the system and community books at each ACL2 release. While that should suffice for most ACL2 users, nevertheless for those who prefer to obtain the latest developments, the ACL2 source code and community books have been made available between ACL2 releases, by way of revision control using SVN. The authors of ACL2 consider SVN distributions to be experimental; while they will likely be fully functional in most cases, they could however be incomplete, fragile, and unable to pass our own regression. If you decide to use SVN versions of either the ACL2 or the community books, then you should use both, as they tend to be kept in sync. See the project websites, acl2-books and acl2-devel, for the ACL2 community books and development sources, respectively.