ToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 8.1
Moderately revised from 8.0. Minimal update since 8.1 release.
8.0 version

Installation of Allegro CL 8.1 and related products

This document contains the following sections:

1.0 Installation introduction
   1.1 Definitions of some terms used in this document
   1.2 Installation sizes and supported Operating System versions
2.0 Preinstallation Steps
   2.1 Increasing the default stack size on HP (formerly Compaq) Alpha machines
   2.2 Installing the perfstat filesets on AIX
   2.3 You can leave Allegro CL 8.0 installed
3.0 Installation steps
4.0 Notes for installation of Allegro CL on UNIX (including Linux)
   4.1 Allegro CL may have problems starting up when run on SELinux
   4.2 Testing that the installation of Allegro CL on Unix was successful
5.0 Installation on Windows
   5.1 Testing that the installation of Allegro CL on Windows was successful
6.0 Installation on Mac OS X
   6.1 Testing that the installation of Allegro CL on Mac OS X was successful
7.0 Installing Emacs from the web
8.0 Installing OpenSSL libraries on Windows
9.0 Other Allegro CL products
10.0 Other material
11.0 Getting a license file
12.0 Installing source code
13.0 The Express Edition
   13.1 Information on the Express license
   13.2 Running the IDE in Allegro CL 8.1 Express on Linux
   13.3 Creating additional Express Edition images on Windows
14.0 The Student Edition
   14.1 Information on installing the Student Edition
15.0 Distribution on CDs

Except for Mac OS X, installation of Allegro CL 8.1 is similar to installation of previous versions of Allegro CL such as Allegro CL 8.0. For Mac OS X installation, see here.



1.0 Installation introduction

This document describes how to install Allegro CL and related products.

Allegro CL is typically downloaded. Customers receive instructions on how to download Allegro CL 8.1 over the net. Express users download their copy from the Franz Inc. web site (www.franz.com). Express users should go to Section 13.0 The Express Edition.

You can install Allegro CL from the download without any key or code (though you need a license file, as described below, in order to use Allegro CL). Once Allegro CL is installed, the documentation, including this file, is available in the doc/ subdirectory (this file is doc/installation.htm). A copy of this file is also available on the Franz Inc. web site (www.franz.com).

All types (Professional, Enterprise, etc.) of Allegro CL for a particular platform and all add-on products are downloaded onto your computer. A license file named devel.lic controls which products will be usable. This license file is supplied separately, as described in Section 11.0 Getting a license file. Allegro CL will not work without a license file properly installed in the Allegro directory. The download does not contain a license file. You must obtain a license file from Franz Inc. separately from the download.

If you do not have a license file or the license file you have does not seem to license the correct product mix, contact your Account Manager for information. (If that link does not work, call Franz Inc. in California, USA, at +1 510-452-2000 or send email to support@franz.com or info@franz.com. In email, be sure to identify yourself and provide information on how you can be contacted.)

Once you have installed Allegro CL and the license file is in place, you can use the licensed Allegro CL version and all licensed add-on products. If you upgrade your Allegro CL version, or purchase a license for an add-on product, you will be given an updated license file. You do not have to download further material (except in rare instances or when you have obtained a license for another platform). Simply installing the new license file makes the newly licensed products available for use.


1.1 Definitions of some terms used in this document


1.2 Installation sizes and supported Operating System versions

The size of the Allegro directory after installation is approximately 250 Mbytes on UNIX/Linux/Mac OS X and 225 Mbytes on Windows. More space may be required during installation for temporary files.

The minimal supported versions of the operating systems on platforms where Allegro CL runs are listed below. Allegro CL will generally work without change on operating system versions released after the release of Allegro CL 8.1. If you have a problem, contact support@franz.com for assistance.

32-bit platforms

64-bit platforms



2.0 Preinstallation Steps

Before installing Allegro CL, consider the following:

  1. The default stack size is likely too small on HP (formerly Compaq) Alpha machines. See Section 2.1 Increasing the default stack size on HP (formerly Compaq) Alpha machines, which directs you to instructions in the release-notes.htm for increasing the default stack sizes on HP Alpha machines.
  2. The perfstat filesets must be installed on AIX. See Section 2.2 Installing the perfstat filesets on AIX for details.
  3. You need not uninstall Allegro CL 8.0 See Section 2.3 You can leave Allegro CL 8.0 installed.

2.1 Increasing the default stack size on HP (formerly Compaq) Alpha machines

The default stack size limit is apparently 2 Megabytes on a HP (formerly Compaq) Alpha. This value is too low for normal stack overflow handling when using Allegro CL. You can increase the stack size in a particular shell, but it is better to increase it for the machine as a whole. Note that this change is best performed by a system administrator or similarly trained person.

See HP Alpha running Tru64: default stack size should be increased in release-notes.htm for information on changing the default on HP Alpha machines.


2.2 Installing the perfstat filesets on AIX

In order for Allegro CL to run on AIX the following filesets must be installed:

These filesets should be available on the AIX installation media.

Without these filesets, Lisp will likely fail on startup. The exact nature of the failure depends of the specific dlopen() implementation. A typical failure message looks like:

dlopen(/usr/local/allegro/acl81/libacli8110.so, mode) error: Bad address

2.3 You can leave Allegro CL 8.0 installed

It is not necessary to delete version 8.0 if you have that installed, but note that on Windows, the registry will be updated so extensions (such as .lpr and .dxl) refer to Allegro CL 8.1 instead of earlier versions.



3.0 Installation steps

If you have the Express Edition, see Section 13.0 The Express Edition. If you have the Student Edition, see Section 14.0 The Student Edition. For some platforms, you are directed back here from that section. In that case, skip down to step 3.

Here are the installation steps in brief:

  1. Get the license file. See Section 11.0 Getting a license file. You can install without getting a license file but you cannot use the product without a license file.
  2. Download the software. You should have received instructions for downloading from Franz Inc. If not, contact your Account Manager for information. (If that link does not work, call Franz Inc. in California, USA, at +1 510-452-2000 or send email to support@franz.com or info@franz.com. In email, be sure to identify yourself and provide information on how you can be contacted.) We assume below you download the software into /usr/tmp/ on UNIX and C:\\tmp\\ on Windows.

    On UNIX (including Linux but not Mac OS X): you download two files, acl81.bz2 (acl81_express.bz2 for the Express edition and acl81_student.bz2 for the Student edition) and bunzip2.

    On Windows, you download one file, acl81.exe (acl81_express.exe for the express edition).

    On Mac OS X, you download one file, acl81.dmg (acl81_express.dmg for the express edition).

  3. UNIX (including Linux but excluding Mac OS X): cd into the directory where the software was downloaded. On Solaris, for example, if you downloaded into /usr/tmp/
    % cd /usr/tmp/
    

    See Section 4.0 Notes for installation of Allegro CL on UNIX (including Linux) for more details.

    Windows: find the download executable file in your Windows Explorer.

    Mac OS X: you should see the .dmg file on your desktop.

  4. Decide where you wish to install the Allegro Directory. On UNIX, the typical location is /usr/local/acl81/ (/usr/local/acl81_express/ for the Express Edition and /usr/local/acl81_student/ for the Student Edition). On Windows, the typical location is C:\Program Files\acl81\ (C:\Program Files\acl81-express/ for the Express Edition and >C:\Program Files\acl81-student/ for the Student Edition). On Mac OS X, the location is AllegroCL (for 32-bit) and AllegroCL64 (for 64-bit). However, you can choose any location you like.
  5. UNIX: uncompress and untar the distribution file. The command is (using the typical location)
    % ./bunzip2 < acl81.bz2 | (cd /usr/local; tar xf -)
    

    For the Express and Student editions, the bz2 filename has _express and _student appended.

    See Section 4.0 Notes for installation of Allegro CL on UNIX (including Linux) for more details on this step.

    Windows: run the exe file. Double click on it if using the Windows Explorer or execute it if at a Command Prompt. Follow the instructions that appear. See Section 5.0 Installation on Windows for full details.

    On Mac OS X, double-click on the image of the downloaded .dmg file. That will open the dmg file and mount the disk image. Inside there is a single directory, called AllegroCL or AllegroCL64, depending on which version they have, 32 or 64-bit. This directory can be copied (by clicking and dragging) anywhere.

  6. Copy the license file into [Allegro directory]/devel.lic. The license file you obtained in step one above should be copied into the Allegro directory and its name should be changed to devel.lic.
  7. Install Emacs off the web (optional). See Section 7.0 Installing Emacs from the web for details.
  8. [Windows only] Install OpenSSL libraries if desired and available (optional). Users interested in writing applications using secure sockets may wish to install the OpenSSL libraries. See Section 8.0 Installing OpenSSL libraries on Windows for instructions and more details. OpenSSL libraries need installation only for Windows.
  9. Run sys:update-allegro: patches (correcting bugs or providing new features) are released for Allegro CL regularly. For normal usage, we recommend that you update regularly, including immediately after installation. Do this by starting Lisp and evaluating (sys:update-allegro). See sys:update-allegro and also Patches in introduction.htm.


4.0 Notes for installation of Allegro CL on UNIX (including Linux)

Once Allegro CL is installed, see Section 4.2 Testing that the installation of Allegro CL on Unix was successful for information on how to test that Allegro CL is installed properly. Linux users who have trouble starting Allegro CL after installation see Section 4.1 Allegro CL may have problems starting up when run on SELinux.

Also see these documentation files in the doc/ subdirectory to start with:

There is no Allegro Composer executable or image file after installation. To use Allegro Composer, evaluate (require :composer) after starting Allegro CL. An Allegro Composer binary can be built by using buildcomposer.cl. See composer.htm. Allegro Composer is not available with Allegro CL Express.

There is no CLIM image file, but one can be built using buildclim.cl. CLIM is not available with Allegro CL Express or Allegro CL Student.

Note for CLIM on Linux, FreeBSD: you must have version 2.2 or later of Motif. (Version 2.2 was released in early 2002.) A free version is available from www.openmotif.org. Redhat Linux 7.2 is supplied with Lesstif, a version of Motif that does not work with CLIM. See the Linux architecture specific information in the Allegro CL FAQ for information on how to install Redhat Linux 7.2 without lesstif and how to uninstall lesstif if already present. On all other Unix platforms, CLIM uses the platform-supplied Motif.

Note for CLIM on Mac OS X: you must have version 2.2.2 Motif. This version is available at no charge from www.openmotif.org.

Users wishing to display Japanese characters need the k14 font. As also noted here in release-notes.htm, the k14 font is needed to display Japanese characters in a CLIM demo. This font appears to be missing from most X server font libraries. We are making available a public domain version of this font in the file [Allegro directory]/misc/k14.pcf. Please see your X server documentation for information on how to install this file as a valid font.


4.1 Allegro CL may have problems starting up when run on SELinux

Security-Enhanced Linux, or SELinux is a feature that is available on many modern versions of Linux and is enabled by default on some. It affects the way shared libraries are loaded and that can prevent Allegro CL from starting up. The error you will likely see is something like:

cannot restore segment prot after reloc: Permission denied

Or the error can be segmentation fault. The solution is to mark the shared object files for special handling or to disable SELinux. See the Linux (Architecture Specific) section of the Allegro CL FAQ for futher details.


4.2 Testing that the installation of Allegro CL on Unix was successful

We will test the installation by starting Allegro CL from a shell prompt. To a shell prompt, enter the full path of the Allegro CL executable (on installation, one of mlisp, alisp, mlisp8, and mlisp8; only alisp is provided with the Express Edition) to the shell prompt.

Assuming the Allegro directory is /usr/local/acl81/ and that you wish to run the mlisp executable, enter:


/usr/local/acl81/mlisp

With the Express Edition, only alisp is provided, so do:

/usr/local/acl81-express/alisp

Allegro CL should start up. You will see the banner and perhaps additional messages, and the first prompt (the exact text depends on the platform and which image you are running, so you may see something slightly different from what is printed here):

Allegro CL Enterprise Edition 8.1 [HP Prism]
Copyright (C) 1985-2007, Franz Inc., Oakland, CA, USA.  All Rights Reserved.
;; Optimization settings: safety 1, space 1, speed 1, debug 2.
;; For a complete description of all compiler switches given the
;; current optimization settings evaluate (EXPLAIN-COMPILER-SETTINGS).
;; Current reader case mode: :case-sensitive-lower
user(1): 

To the Lisp prompt user(1):, enter the form (require :build):

user(1): (require :build)
; Fast loading from bundle code/build.fasl.
t

If you see the `Fast loading...' message, that means that Allegro CL can find the Allegro directory correctly and its library and it means that Allegro CL is correctly installed and working. You may now either exit Allegro CL by entering :exit (see the top-level command :exit):

user(2): :exit

or you may continue using Allegro CL.



5.0 Installation on Windows

Download the software

Download the distribution file specific to the platform you are using (this file will have a name like acl81.exe). Download into a location of your choice.

Instructions for Enterprise, Professional, and Student versions

  1. Exit all running programs. Installation is most likely to be trouble free if there are no other programs running.
  2. Display the Windows Explorer. Find the acl81.exe file you downloaded. (Express users: the file is ).
  3. Double click on acl81.exe to execute it. This starts an installation program. During the installation, dialogs appear asking for input, as described in the next steps. (If you are installing the Express Edition, the filename is acl81-express.exe.)
  4. First dialog: this is an informational dialog telling you again to exit all other running programs and informing you about licenses and copyrights. Click on the Cancel button if you wish to stop the installation (perhaps to exit running programs). Click Next to continue.
  5. Second dialog: this dialog asks you for the location of the Allegro directory. A default is provided: Program Files\acl81\ (Program Files\acl81-trial\ for the Express Edition) on main drive (often C: but can be another drive). If you wish a location other than the default, click on the Browse button and select a directory. If you select an existing directory (not recommended), a warning dialog is displayed saying the directory exists and asking if you want to continue. Once you have selected the desired location for the Allegro directory, click the Next button. You can cancel by clicking the Cancel button.
  6. Third dialog: this dialog asks if you wish to leave out portions of the distribution: the [Allegro CL] documentation (about 26 Mbytes), the ANSI spec documentation (about 11 Mbytes), and contributed files (about 3300 Kbytes). By default, the first two are included and the third left out.

    If you do not install either the Allegro CL documentation and the ANSI spec, shortcuts relating to documentation on the Allegro CL menu item on the Start menu will link you to versions on the Franz Inc. web site. (However, if you have the space, it is best to include the documentation.) If you include the Allegro CL documentation but not the ANSI spec, links from the Allegro CL documentation to the ANSI spec will not work.

    Check or uncheck the desired options. Click Cancel to cancel installation, Back to choose a different location, and Next to continue. If you click Next again, the installation will take place.

  7. A dialog may appear when the installation is finished telling you you must restart the machine to complete the installation and asking if you want to do this now. (Restarting is not always necessary. Clicking Cancel ends the installation process for now and does not restart the machine. If restarting is required and you choose to delay it, do not use Allegro CL until you have restarted. We assume in the subsequent steps you have restarted if necessary.)
  8. Copy the license file into the Allegro directory and change its name to devel.lic.

Run sys:update-allegro

Patches (correcting bugs or providing new features) are released for Allegro CL regularly. For normal usage, we recommend that you update regularly, including immediately after installation. Do this by starting Lisp and evaluating (sys:update-allegro). See sys:update-allegro and also Patches in introduction.htm.

Allegro CL is now installed. See these documentation files to start with. (Allegro CL Express and Allegro CL Student users look at documentation on the Franz Inc. Website, specifically here. Links on that page go to the documentation files for your version and also tell you how to download your own copy if desired.)

The next section describes how to test the installation on Windows.


5.1 Testing that the installation of Allegro CL on Windows was successful

We will test the installation by starting Allegro CL from the menu. You should see an `Allegro CL 8.1' item on the Programs submenu of the Start menu. (`Allegro CL 8.1 Free Express Edition' for the Express Edition and `Allegro CL 8.1 Student Edition' for Student.) That item has a submenu, with (among other items) submenus Modern ACL Images and ANSI ACL Images. We will start a Modern ACL with the IDE in this example. The Express does not have submenus for images, since only one is supplied (there are submenus for other things).

Choose

Start | Programs | Allegro CL 8.1 | Modern ACL Images | Allegro CL 8.1 (w IDE, Modern)

(or Start | Programs | Allegro CL 8.1 Free Express Edition | Allegro CL 8.1 Free Express Edition or Start | Programs | Allegro CL 8.1 Student Edition | Allegro CL 8.1 Student Edition). You should see a splash window and then a window titled `Allegro Common Lisp Console'. Shortly thereafter, the Allegro CL Integrated Development Environment windows appear. After everything is started, your screen should look something like the following picture.

If you have worked on projects in the IDE in earlier sessions, a Startup Action dialog is displayed which asks if you want to open one of these recent projects. (We do not show it because we are assuming you have just installed Allegro CL. Note the Express edition does not have a startup dialog.)

To the prompt cg-user(1):, enter the form (require :build):

cg-user(1): (require :build)
; Fast loading from bundle code\build.fasl.
t

If you see the `Fast loading...' message, that means that Allegro CL can find the Allegro directory correctly and its library and it means that Allegro CL is correctly installed and working. You may now either exit Allegro CL by choosing File | Exit (that is, the Exit choice from the File menu) or you may continue using Allegro CL. If you choose to exit, a dialog will appear asking if you really want to exit. Answer Yes.



6.0 Installation on Mac OS X

Allegro CL on Mac OS X, starting with release 8.1, is distributed as a .dmg file. There is no .bz2 file and bunzip2 is not used. The .dmg file for Allegro CL 8.1 is called acl81.dmg. This is how to install:

  1. Download the file to the local hard disk.
  2. Double-click on the image. It will open the .dmg file and mount the disk image. Inside there is a single directory, called AllegroCL or AllegroCL64, depending on which version they have, 32 or 64-bit.
  3. Copy the directory to the desired location. The AllegroCL or AllegroCL64 directory can be copied (by clicking and dragging) anywhere.

That's all there is to the installation. Just click and drag it somewhere. Of course, /Applications is a good location to use, if you don't know where to put it. It will run from anywhere.

Download patches

You should download available patches. See sys:update-allegro.


6.1 Testing that the installation of Allegro CL on Mac OS X was successful

Make sure you have downloaded patches with sys:update-allegro.

We will test the installation by starting Allegro CL from a Terminal Window. To the prompt in a Terminal Window, enter the full path of the Allegro CL executable (on installation, one of mlisp, alisp, mlisp8, and mlisp8; only alisp is provided with the Express Edition) to the shell prompt.

Assuming the Allegro directory is /Applications/AllegroCL/ or /Applications/AllegroCL64/ and that you wish to run the mlisp executable, enter:


/Applications/AllegroCL/mlisp
or
/Applications/AllegroCL64/mlisp

With the Express Edition, only alisp is provided, so do:

/Applications/AllegroCL/alisp

Allegro CL should start up. You will see the banner and perhaps additional messages, and the first prompt (the exact text depends on the platform and which image you are running, so you may see something slightly different from what is printed here):

Allegro CL Enterprise Edition 8.1 [Mac OS X]
Copyright (C) 1985-2007, Franz Inc., Oakland, CA, USA.  All Rights Reserved.
;; Optimization settings: safety 1, space 1, speed 1, debug 2.
;; For a complete description of all compiler switches given the
;; current optimization settings evaluate (EXPLAIN-COMPILER-SETTINGS).
;; Current reader case mode: :case-sensitive-lower
user(1): 

To the Lisp prompt user(1):, enter the form (require :build):

user(1): (require :build)
; Fast loading from bundle code/build.fasl.
t

If you see the `Fast loading...' message, that means that Allegro CL can find the Allegro directory correctly and its library and it means that Allegro CL is correctly installed and working. You may now either exit Allegro CL by entering :exit (see the top-level command :exit):

user(2): :exit

or you may continue using Allegro CL.



7.0 Installing Emacs from the web

We no longer supply a version of Emacs on the CD. In past releases, the version on the CD quickly became out of date. Emacs is easily downloaded from multiple sources on the net. See www.franz.com/emacs/ for information.

There is a downloadable installer for GNU Emacs on Windows on www.franz.com/emacs/. That same location has links to locations from which to download Emacs for Unix platforms.

Once you have Emacs installed on your machine, you need to have it load the Emacs-Lisp interface files when it starts up. You do this by putting the appropriate form in your .emacs file, as described:

The page at www.franz.com/emacs/ has additional recommendations for the .emacs file, along with a list of convenient key bindings. See also eli.htm: this is the documentation file for the Emacs-Lisp interface.



8.0 Installing OpenSSL libraries on Windows

For customers with an Enterprise license (or above), Allegro CL supports the Secure Socket Layer (SSL) protocol, as described in Secure Socket Layer (SSL) in socket.htm. The OpenSSL libraries are necessary to make use of this facility. For all UNIX platforms (that is, all platforms except Windows), the libraries are part of the standard Allegro CL distribution and no special installation is required. For Windows, however, an extra installation step is required.

The Allegro directory contains the file openssl.exe. This is a self-extracting executable containing the necessary SSL libraries and files.

To install the libraries run openssl.exe and select a location with at least 3 megabytes of free space (the default location is c:\openssl-0.9.8e\).

Next run the System program in the Control Panel and edit your PATH environment variable to include the directory where you installed the openssl libraries, so if you installed in the default location, add c:\openssl-0.9.8e. Put this first in the PATH list (incorrect files may be found if you put the location elsewhere).

These instructions have been updated since the release of Allegro CL 8.1. As originally written, you were told to put c:\openssl-0.9.8e\out32dll into PATH and no comment was made about where in PATH. In 8.1, the SSL directory does not have an out32dll subdirectory and the position of the c:\openssl-0.9.8e entry in the PATH does matter, so the text above has been edited to show the correct instructions.



9.0 Other Allegro CL products

Allegro CL comes with various add-on products, such as the CLIM windowing system and Orblink. Some require additional licenses. Others are available to all users. All material needed for these products is in the distribution. Only the license file determines whether products can be used or not. Contact your Franz Inc. Account Manager for information on licensing.



10.0 Other material

Also available for download are Doc PDF files. These are PDF files made from the HTML documentation (in the doc/ subdirectory of the distribution). These are provided to make is easier to print parts of the documentation if desired. The PDF versions are available for download here.



11.0 Getting a license file

You must have a license file to use Allegro CL and its associated products. The license file is not included with the distribution.

Professional and Enterprise customers with current maintenance agreements should have received an email message from Franz Inc. with instructions on how to obtain their license file. Express Edition customers should receive such an email after providing the necessary information to Franz Inc. (usually by filling in a form on the Franz Inc. web site, www.franz.com).

The email sent by Franz Inc. gives an URL from which the license file can be retrieved. The email is in Mime format, with plain text and HTML versions. If you are able to read mail in a mime-enabled client, you will be able to click on the URL immediately.

You should retrieve the license as soon as you receive the email even if you have not downloaded the software. Then the license file will be ready when you install Allegro CL. The name of the file when it is put in the Allegro directory must be devel.lic. However, you may use any name when retrieving, renaming when you copy it to the Allegro directory later.

The license file is a text file which includes encrypted text. See The Allegro CL license file in startup.htm for a sample (with the encrypted text much and obviously modified).

If you upgrade your license or purchase add-on products, you will be sent email with instructions for retrieving a new license file. Placing the new license file in the Allegro directory is all you must do to use the upgraded version of the new add-on products.

If you do not have a license file or the license file you have does not seem to license the correct product mix, contact your Account Manager for information. (That link goes to the file introduction.htm. If that link does not work, call Franz Inc. in Oakland, California, at +1 510-452-2000 or send email to support@franz.com or info@franz.com. In email, be sure to identify yourself and provide information on how you can be contacted.)



12.0 Installing source code

In order to get source code (if your license allows it), you must return the source code license addendum included with the distribution. When that addendum is received, you will be sent a new license which allows installing source code. (Some sources are free to licensed customers and others are provided for an additional charge. If you have questions about getting source code, please contact your Account Manager.)

The sources available are:

To install sources, do the following:

  1. On Windows, open the Windows Explorer.
  2. On Windows, find the Allegro directory in the explorer (it is typically c:\Program Files\acl81\ but you may have chosen a different directory).
    On UNIX, cd to the Allegro directory (it is typically /usr/local/acl81/ but you may have chosen a different directory) in a shell.
  3. On Windows, double-click on the files srclisp.bat (and also, if appropriate srcclim.bat, srcaodbc.bat, srcmysql.bat, srcoracle.bat, and srcorblink.bat). Note that the CG and IDE sources are unpacked by srclisp.bat.
    On UNIX, run ./srclisp.sh (and also, if appropriate ./srcclim.sh, ./srcaodbc.sh, ./srcmysql.sh, ./srcoracle.sh, and ./srcorblink.sh).

Assuming you have the new license with the source code module included, the encrypted source files in the src/ directory should be unencrypted and expanded so the source code will be located in subdirectories of the src/ directory.



13.0 The Express Edition

The 8.1 Free Express Edition was re-released in June, 2008 with a new installation method for both Windows and UNIX. This procedure automatically obtains the express license (that was true in the earlier version on Windows but not on UNIX). Installation instructions for Windows, Linux and FreeBSD, and Mac OS X are next.

Express Installation for Windows

Run acl81_express.exe (it may run automatically when you download it).

The license file will automatically be retrieved and installed during installation. If the license file is not retrieved, then do you need to use a proxy to surf the web? If so see www.franz.com/support/faq/index.lhtml#newlicenseproxy about running the newlicense program with a proxy (newlicense is used both to retrieve the initial license and to update licences). If not, please contact us (support@franz.com) for help.

You should download updates/patches by selecting the Rebuild images (download new updates first) menu item on the Start | Programs | Allegro CL 8.1 Express menu. (Or use one of the other ways to download patches -- see sys:update-allegro).

Only the allegro.dxl image is provided. Other images can be created, as described in Section 13.3 Creating additional Express Edition images on Windows.

Express Installation for UNIX (Linux and FreeBSD)

  1. If you already have bunzip2 installed, skip to the next step. If you do not have bunzip2 and want to use our version, then download it and make it executable. We assume it was downloaded to /tmp:
    % chmod 755 /tmp/bunzip2
    
  2. We assume you downloaded acl81_express.bz2 to /tmp and that you wish to install into /usr/local/acl81_express (modify the command as necessary for other locations):
    % bunzip2 < /tmp/acl81_express.bz2 | (cd /usr/local; tar xf -)
    
  3. Run the newlicense program to get your license file. If it will not startup, it may be the SELinux problem. See Section 4.1 Allegro CL may have problems starting up when run on SELinux for more information. Linux users, see Section 13.2 Running the IDE in Allegro CL 8.1 Express on Linux below for information on using the IDE on Linux. If the license file is not retrieved, then do you need to use a proxy to surf the web? If so see www.franz.com/support/faq/index.lhtml#newlicenseproxy about running the newlicense program with a proxy (newlicense is used both to retrieve the initial license and to update licences). If not, please contact us (support@franz.com) for help.
  4. Get available patches (see sys:update-allegro).

Express Installation for Mac OS X

  1. Mount the image (double-click on the .dmg file).
  2. Copy, by dragging the AllegroCL directory, to the desired location, which might be /Applications/.
  3. Run /Applications/AllegroCL/newlicense to get a license file. If the license file is not retrieved, then do you need to use a proxy to surf the web? If so see www.franz.com/support/faq/index.lhtml#newlicenseproxy about running the newlicense program with a proxy (newlicense is used both to retrieve the initial license and to update licences). If not, please contact us (support@franz.com) for help.
  4. Get available patches (see sys:update-allegro).

After installation

For post-installation information, see:

Information on Allegro CL Express

The Express Edition, available for Windows, FreeBSD, Linux, and Mac OS X (for Intel processors), is provided free of charge so that potential users may gain experience using Allegro CL and some add-ons before purchasing. The Express Edition is fully described on the Franz Inc. web site (www.franz.com, click on the Download button to see information about Express software). That information may be updated more frequently than the information here. If there is a conflict between the information on the Web site and the information given here, the information on the Web site is correct.

CLIM and Allegro Composer are not available with Allegro CL Express.

To obtain an Express Edition, you fill out an information form on the Franz Inc. web site. Then, on Windows, you download a self-installing executable while on UNIX and UNIX-like platforms, you download a compressed file which does the installation when uncompressed. On both Windows and UNIX, the installation also obtains the license file needed to run the software (you must be connected to the internet during installation).

The Express Edition is not available on a CD. It must be downloaded. The Windows version does not include the documentation (but instead links to the documentation on the Web site).


13.1 Information on the Express license

The license file you receive for the Express Edition will expire after 30 days. You can run the program newlicense to update your license file (if you start Allegro CL Express when the license has or is about to expire, you are asked if you want to run newlicense). newlicense is an option on the Allegro CL Free Express Edition choice on the Start menu. You can also run it by double-clicking on newlicense.exe in the Allegro directory.

newlicense can be run as early as seven days before the license expires, so timely action will result in no interruption of Lisp service. Each renewal is good for 30 days and there is no limit on the number of renewals.

newlicense must be run in the Allegro directory.

newlicense updates your license by sending your current license to Franz Inc. An error message will be displayed if there are any problems. If the update succeeds, your license is updated.


13.2 Running the IDE in Allegro CL 8.1 Express on Linux

To use the IDE on Linux, just as on Windows, you invoke the allegro or allegro-ansi executable. The associated image includes the IDE and starts it when Allegro CL is started. You do this also with Allegro CL Express on Linux on x86 processors.

But in Allegro CL Professional and Enterprise, you can also start a non-IDE image (alisp or mlisp) and load the IDE and call ide:start-ide (as described in cgide.htm). This second method does not work in Allegro CL Express Edition. To use the IDE, you must use the allegro or allegro-ansi executable/image.

Thus, you start Allegro CL in Emacs with the Emacs function fi:common-lisp (see Running Lisp as a subprocess of Emacs in startup.htm). When you are asked for the Executable Image Name, specify allegro (for a case-sensitive, modern image) or allegro-ansi (for a case-insensitive ANSI image). The IDE will start when Allegro CL does.


13.3 Creating additional Express Edition images on Windows

To make the downloadable file as small as possible, on Windows we have only included one Allegro CL image, allegro-ansi.exe, one that includes the IDE and is in International "ANSI" mode (case insensitive upper, as opposed to case sensitive lower of "Modern" images).

The other images which are commonly found in an Allegro CL installation are:

mlisp Modern base Lisp image, international (16-bit characters)
alisp ANSI base Lisp image, international (16-bit characters)
allegro Modern IDE image, international (16-bit characters)
alisp8 ANSI base Lisp image, 8-bit characters (not available with express)
mlisp8 Modern base Lisp image, 8-bit characters (not available with express)

To build one of the available above images (the 8-bit images are unavailable), start up allegro-ansi.exe and evaluate one or more of the following forms in the Debug window:

  ;; mlisp:
  (progn
    (build-lisp-image "mlisp.dxl" :case-mode :case-sensitive-lower
                      :include-ide nil :restart-app-function nil
                      :restart-init-function nil)
    (sys:copy-file "sys:allegro-ansi.exe" "sys:mlisp.exe"))

  ;; alisp:
  (progn
    (build-lisp-image "alisp.dxl" :case-mode :case-insensitive-upper
                      :include-ide nil :restart-app-function nil
                      :restart-init-function nil)
    (sys:copy-file "sys:allegro-ansi.exe" "sys:alisp.exe"))

  ;; allegro:
  (progn
    (build-lisp-image "allegro.dxl" :case-mode :case-sensitive-lower)
    (sys:copy-file "sys:allegro-ansi.exe" "sys:allegro.exe"))

Evaluating any of the above forms does not add a menu item to the Start Menu. To run the resulting image, you will need to run the executable created in each form.



14.0 The Student Edition

The Student Edition, available for Windows, FreeBSD, Linux, and Mac OS X (for Intel processors), is available for sale at the Franz Store. It is a slightly restricted version of the Professional Edition of Allegro CL 8.1. Certain add-ons are not supported in the base product, but are available for purchase. Sale is restricted to bona fide students. The Student Edition is fully described on the Franz Store web site. That information may be updated more frequently than the information here. If there is a conflict between the information on the Web site and the information given here, the information on the Web site is correct.

When you purchase a Student Edition, you will receive an email with information on retrieving a license (see Section 11.0 Getting a license file) and information on downloading. The Student Edition is not available on a CD. It must be downloaded.

Documentation not included

To reduce the download time, the documentation is not included in the Student Edition download. The documentation is available at http://www.franz.com/support/documentation/. There are links on that page allowing you to download the documentation if desired. The Windows version includes standard Windows tools for accessing documentation. These automatically link to the version on the Website unless the documentation is downloaded.


14.1 Information on installing the Student Edition

Here are the installation steps for the student Edition in brief:

  1. Get the license file. See Section 11.0 Getting a license file. You can install without getting a license file but you cannot use the product without a license file.
  2. Download the software. Information on downloading should have been sent to you when you purchased the Student Edition. If you bought a FreeBSD or Linux version, the files acl81_student.bz2 and, if necessary, the bunzip2 decompression program will be downloaded. If you bought the Mac OS X version, one file, acl81_student.dmg is downloaded. If you bought the Windows version, the self-extracting executable file acl81_student.exe will be downloaded. Here we assume the files for FreeBSD and Linux will be downloaded into the /usr/tmp/ directory, the file for Mac OS X onto the desktop, and the file for Windows will be downloaded into the c:\temp\ folder.
  3. Decide where you wish to install the Allegro Directory. On UNIX, the typical location is /usr/local/acl81_student/. On Windows, the typical location is C:\Program Files\acl81-student\. However, you can choose any location you like.
  4. Linux and FreeBSD: uncompress and untar the distribution file. Enter this command in /usr/tmp/ (or wherever the downloaded files are):
    % ./bunzip2 < acl81_student.bz2 | (cd /usr/local; tar xf -)
    

    Mac OS X: run the dmg file. Find the acl81_student.dmg image and double click on it. It will open the dmg file and mount the disk image.

    Windows: run the exe file. Double click on it if using the Windows Explorer. Execute it if at a Command Prompt or a DOS prompt. Follow the instructions that appear.

  5. Copy the license file into [Allegro directory]/devel.lic. The license file you obtained in step one above should be copied into the Allegro directory and its name should be changed to devel.lic.
  6. Install Emacs off the web (optional). See Section 7.0 Installing Emacs from the web for details.
  7. Start Lisp and run sys:update-allegro: patches (correcting bugs or providing new features) are released for Allegro CL regularly. For normal usage, we recommend that you update regularly, including immediately after installation. Do this by starting Lisp and evaluating (sys:update-allegro). See sys:update-allegro and also Patches in introduction.htm.

If you get an error when starting Allegro CL on Linux, it may be the SELinux problem. See Section 4.1 Allegro CL may have problems starting up when run on SELinux for more information.

Somewhat more verbose instructions are available in Section 4.0 Notes for installation of Allegro CL on UNIX (including Linux) for Linux and FreeBSD; in Section 6.0 Installation on Mac OS X for Mac OS X; and in Section 5.0 Installation on Windows for Windows.



15.0 Distribution on CDs

While it is always best to download the software (because the download version will be the latest available), regular customers can request the distribution on a CD. The installation instructions are the same except you typically install from a directory on the CD rather than from the location of the downloaded files. Additional instructions will be sent with the CD.


Copyright (c) 1998-2009, Franz Inc. Oakland, CA., USA. All rights reserved.
This page has had moderate revisions compared to the 8.0 page.
Created 2007.4.30.

ToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 8.1
Moderately revised from 8.0. Minimal update since 8.1 release.
8.0 version