| Allegro CL version 8.0 Moderately revised from 7.0. Moderate update since 8.0 release. | |||||||
This document contains the following sections:
1.0 Installation introductionThis 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.0 over the net. Express users download their copy from the Franz Inc. web site (www.franz.com). Express users should go to Section 12.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 10.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.
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.0. If you have a problem, contact support@franz.com for assistance.
Before installing Allegro CL, consider the following:
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.
The Mac OS X stack size is not an issue for Allegro CL 8.0. (It was for earlier vesions).
In order for Allegro CL 8.0 (as patched in September 2006), Allegro 8.1, and later 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
It is not necessary to delete version 7.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.0 instead of earlier versions.
If you have the Express Edition, see Section 12.0 The Express Edition. If you have the Student Edition, see Section 13.0 The Student Edition.
Here are the installation steps in brief:
On UNIX (including Linux and Mac OS X): you download two files, acl80.bz2 and bunzip2.
On Windows, you download one file, acl80.exe.
% cd /usr/tmp/
See Section 4.0 Notes for installation of Allegro CL on UNIX (including Linux and Mac OS X) for more details.
Windows: find the download executable file in your Windows Explorer.
% ./bunzip2 < acl80.bz2 | (cd /usr/local; tar xf -)
See Section 4.0 Notes for installation of Allegro CL on UNIX (including Linux and Mac OS X) 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.
(sys:update-allegro). See sys:update-allegro and also Patches in
introduction.htm.
Download the distribution file specific to the platform you are using (this file will have a name like acl80.bz2). Also download the bunzip2 executable. Download into a location of your choice (we assume you chose /usr/tmp/ in the discussion below).
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.)
Note to Express and Student users: the link from Section 12.2 Information on installing the Express Edition comes here. Follow the instructions below to install the Express Edition for Linux, FreeBSD, and Mac OS X. Note we usually refer to the regular edition filenames. Replace these with the relevant Express or Student filenames.
% cd /usr/tmp/
% ./bunzip2 < acl80.bz2 | (cd /usr/local; tar xf -)
A directory named acl80/ (acl80_express/ or acl80_student/) should not be present in the location specified to the tar portion of the command above. It will be created and it is the Allegro directory.
(sys:update-allegro). See sys:update-allegro and also Patches in
introduction.htm.
Allegro CL is now installed. See Section 4.1 Testing that the installation of Allegro CL on Unix was successful for information on how to test that Allegro CL is installed properly.
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. 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.
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/acl80/ and that you wish to run the mlisp executable, enter:
/usr/local/acl80/mlisp
With the Express Edition, only alisp is provided, so do:
/usr/local/acl80-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.0 [HP Prism] Copyright (C) 1985-2005, 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):
You may see the message
pure lisp library being relocated by XXX bytes
(where XXX is some integer). Do not worry if you do. The message is for information only. It means that the memory location preassigned for the Lisp library was unavailable and a new location is being used.
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.
Download the distribution file specific to the platform you are using (this file will have a name like acl80.exe). Download into a location of your choice.
Note to Express and Student users: the link from Section 12.2 Information on installing the Express Edition comes here. Follow the instructions below to install the Express Edition for Windows.
Note to Express Users about the NetInstaller: the NetInstaller used for Allegro CL Express on Windows automates the installation process including retrieving the license file. A file named Allegro80installer.exe is downloaded and run and it does the entire installation. Go here below in this section for information on testing and documentation.
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.
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.
We will test the installation by starting Allegro CL from the menu. You should see an `Allegro CL 8.0' item on the Programs submenu of the Start menu (`Allegro CL 8.0 Free Express Edition' for the Express Edition). 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.0 | Modern ACL Images | Allegro CL 8.0 (w IDE, Modern)
(or with the Express Edition, Start | Programs | Allegro CL 8.0 Free Express Edition | Allegro CL 8.0 Free Express 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. (The windows in the picture have been rearranged and resized to make them fit and so what you see will be slightly different. Note: the Express edition looks quite different and has no Startup Action dialog.)
The Startup Action dialog asks what you want to have happen on startup. Just click cancel for now (see cgide.htm for information on using the IDE). Once that dialog goes away, you will see the Debug Window with a Lisp prompt:
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.
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:
(load "c:/program files/acl80/eli/fi-site-init")
That form assumes you installed Allegro CL in the standard location, c:/program files/acl80/. Replace that with the correct location if it is different.
(load "/usr/local/acl80/eli/fi-site-init")
That form assumes you installed Allegro CL in the standard location, /usr/local/acl80/. Replace that with the correct location if it is different.
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.
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).
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.
Also available for download are:
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.)
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:
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.
The 8.0 Free Express Edition was released in early June, 2006.
The Express Edition, available for Windows, FreeBSD, Linux, and Mac OS X (for Intel and PPC 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. On Windows, a page is displayed which allows you to access the Net Installer which installs the software with the license. For Unix/Linux, sometime after submitting the form, you will receive email with information on retrieving a license (see Section 10.0 Getting a license file) and information on downloading. 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).
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.
You must download the files associated with the Express Edition. Download into an empty directory on your machine. For FreeBSD, Linux (x86), Linux (PPC), and Mac OS X, two files, acl80_express.bz2 and bunzip2 are downloaded. For Windows, an automatic Net Installer file is downloaded and started automatically. It installs Allegro CL and gets a license file. The file has a name like Allegro80installer.exe.
Once the download has succeeded, follow the steps in Section 3.0 Installation steps for Linux, FreeBSD, and Mac OS X. Windows users see here in Section 5.0 Installation on Windows (where some useful post-installation information is provided after the installation instructions which do not apply to Allegro CL Express).
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.
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.
The 8.0 Student edition was released at the end of May, 2006.
The Student Edition, available for Windows, FreeBSD, Linux, and Mac OS X (for Intel and PPC processors), is available for sale at the Franz Store. It is a slightly restricted version of the Professional Edition of Allegro CL 8.0. 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 10.0 Getting a license file) and information on downloading. The Student Edition is not available on a CD. It must be downloaded.
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.
Here are the installation steps for the student Edition in brief:
% ./bunzip2 < acl80_student.bz2 | (cd /usr/local; tar xf -)
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.
(sys:update-allegro). See sys:update-allegro and also
Patches in
introduction.htm.
Somewhat more verbose instructions are available in Section 4.0 Notes for installation of Allegro CL on UNIX (including Linux and Mac OS X) for Linux, FreeBSD, and Mac OS X and here in Section 5.0 Installation on Windows for Windows. Note these longer instructions discuss a distribution CD, which is not available for the Student Edition. When those instructions refer to a directory on the CD directory, use the directory you downloaded the files into.
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-2008, Franz Inc. Oakland, CA., USA. All rights reserved.
This page has had moderate revisions compared to the 7.0 page.
Created 2007.4.30.
| Allegro CL version 8.0 Moderately revised from 7.0. Moderate update since 8.0 release. | |||||||