ToCDocOverviewCGDocRelNotesIndexPermutedIndex
Allegro CL version 7.0
Moderately revised from 6.2. Moderate update since 7.0 release.

Installation of Allegro CL 7.0 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
      1.2.1 Operating System versions released after the release of Allegro CL 7.0
2.0 Preinstallation Steps
   2.1 Increasing the default stack size on HP (formerly Compaq) Alpha and Mac OS X machines
   2.2 The procfs package must be installed on Linux and FreeBSD
   2.3 Preparing for AllegroStore installation
   2.4 You can leave Allegro CL 6.2 installed
3.0 Installation steps
4.0 Notes for installation of Allegro CL on UNIX (including Linux and Mac OS X)
   4.1 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 instructions and information for AllegroStore users
   6.1 Pre-Installation notes for AllegroStore users
   6.2 Compatibility notes for AllegroStore users
   6.3 Installing ObjectStore
      6.3.1 Step 1: Copying and unencrypting the ObjectStore distribution
      6.3.2 Step 2: Install ObjectStore
      6.3.3 Step 3: Set up the individual Runtime environments
      6.3.4 Step 4: Build an AllegroStore Lisp image [optional]
      6.3.5 Step 5: Test the AllegroStore installation
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 Information on installing the Express Edition
   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


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 information about downloading Allegro CL 7.0 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, but without ObjectStore installed is approximately 200 Mbytes on UNIX/Linux/Mac OS X and 240 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. Platforms that have 32-bit and 64-bit versions are so indicated; other platforms are 32-bit. Allegro CL 7.0 runs on all operating system versions released (not in beta or pre-release form as of October 15, 2004. See Section 1.2.1 Operating System versions released after the release of Allegro CL 7.0 for places to obtain information on operating systems released after that date.


1.2.1 Operating System versions released after the release of Allegro CL 7.0

Franz Inc. cannot maintain the same release schedule as the many operating system providers on the many platforms we support. Usually Allegro Common Lisp and all of its component parts will work on new Operating System versions that become available after release. But sometimes Allegro CL patches or operating-system patches, or installation tweaks, will be required before Lisp will run on an updated system.

Franz Inc. usually finds out about any such issues soon after new operating system releases appear and devises any necessary patches or compatibility procedures. We maintain current information about operating system versions on this web page: http://www.franz.com/support/osinfo.lhtml. We strongly advise you to check that page before updating your operating system. If we know that the new operating system is compatible, or is compatible with certain patches, you will find the information there. Similarly if it is known to be incompatible. If the new operating system is not yet listed it may be that it has not yet been tested.

If you want to update to an operating system not yet listed, and Lisp operation is important to you, it may be wise to test the new operating system on an auxiliary machine, or provide some way to roll back the upgrade if problems appear.



2.0 Preinstallation Steps

Before installing Allegro CL, consider the following:

  1. Default stack sizes are likely too small on HP (formerly Compaq) Alpha and Mac OS X machines. See Section 2.1 Increasing the default stack size on HP (formerly Compaq) Alpha and Mac OS X machines, which directs you to instructions in the release-notes.htm for increasing the default stack sizes on those machines.
  2. On Linux and FreeBSD, the procfs package must be installed. See Section 2.2 The procfs package must be installed on Linux and FreeBSD for details.
  3. AllegroStore users should make sure their databases are properly saved. See Section 6.1 Pre-Installation notes for AllegroStore users for details.
  4. You need not uninstall Allegro CL 6.2 See Section 2.4 You can leave Allegro CL 6.2 installed.

2.1 Increasing the default stack size on HP (formerly Compaq) Alpha and Mac OS X machines

The default stack size limit is apparently 2 Megabytes on a HP (formerly Compaq) Alpha and 512 Kilobytes on a Mac OS X machine. These values are 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.

See Increasing stack size on Mac OS X in release-notes.htm for information on changing the default on Mac OS X machines.


2.2 The procfs package must be installed on Linux and FreeBSD

On Linux and FreeBSD systems, the procfs package is required for Allegro CL operation. Procfs is the process filesystem package which establishes memory map info for each process in /proc on the system (see the man page for procfs). Allegro CL uses that info to determine where mmap() can be done. The Procfs package is optional on these operating systems and may not be installed. Please see your operating system documentation for further information on installing the package if it is not there.

(Procfs is necessary on all UNIX and UNIX-like operating systems, but it does not seem to be optional except on Linux and FreeBSD. If it is optional, it must be installed in order to use Allegro CL.)


2.3 Preparing for AllegroStore installation

Allegrostore 2.1.8 (supplied with Allegro CL 7.0) uses an updated schema, which makes databases for the current version incompatible with databases of previous Allegrostore versions (such as AllegroStore 2.1 supplied with Allegro CL 6.2). Users of Allegro CL 7.0 should perform the following steps to convert their databases.

  1. Before installing Allegro CL 7.0 AllegroStore, dump the databases using the Allegro CL 6.2 AllegroStore asdump program.
  2. Install Allegro CL 7.0 AllegroStore (which is to say, install Allegro CL 7.0).
  3. Restore the dumped databases using the Allegro CL 7.0 AllegroStore asrestore program.

asdump/asrestore note: versions of Allegrostore prior to that supplied with Allegro CL 7.0, asdump would dump raw arrays (typically arrays of element-type signed- or unsigned-byte) in the endianness of the dumping platform. This would result in raw arrays being recreated incorrectly if the dumped database was restored on a platform of differing endianness. This problem is corrected in Allegro CL 7.0 by dumping raw arrays in network byte-order. However, this may cause incorrect restoring of raw arrays when upgrading databases to the current Allegrostore release. To correct this, asrestore may be used with a -r option, which informs it not to make any assumptions about byte-ordering of raw arrays. The -r option to asrestore should only be used when converting databases from previous versions of allegrostore. It is not recommended for use when dumping and restoring ACL 7.0 databases. The -r option is safe to use even if you are not sure if raw arrays have been stored in the database.

AllegroStore installation is described in Section 6.0 Installation instructions and information for AllegroStore users.


2.4 You can leave Allegro CL 6.2 installed

It is not necessary to delete version 6.2 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 7.0 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.

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 and Mac OS X): you download two files, acl70.bz2 and bunzip2.

    On Windows, you download one file, acl70.exe.

  3. UNIX: 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 and Mac OS X) for more details.

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

  4. Decide where you wish to install the Allegro Directory. On UNIX, the typical location is /usr/local/acl70/ (/usr/local/acl70_trial/ for the Trial Edition and /usr/local/acl70_student/ for teh Sudent edition). On Windows, the typical location is C:\Program Files\acl70\ (C:\Program Files\acl70-trial/ for the Trial Edition and C:\Program Files\acl70-student/ for the Student Edition). However, you can choose any location you like.
  5. UNIX: uncompress and untar the distribution file. The command is (using the typical location)
    % ./bunzip2 < acl70.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.

  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. (In the original version of this document, this step was after the next step AllegroStore customers: install ObjectStore. This was an error. The license file must be in the Allegro directory for the installation of ObjectStore to succeed.)
  7. AllegroStore customers: install ObjectStore.: See Section 6.0 Installation instructions and information for AllegroStore users for details. Note: on some platforms, you should dump your databases. Be sure you do this if it is necessary. The license file must be in the Allegro directory before you attempt to install ObjectStore.
  8. Install Emacs off the web (optional). See Section 7.0 Installing Emacs from the web for details.
  9. [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.
  10. 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 and Mac OS X)

Download the software

Download the distribution file specific to the platform you are using (this file will have a name like acl70.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 13.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 Trial or Student filenames.

  1. Change to download directory (the one where the acl70.bz2 file and bunzip2 files were downloaded to). If you downloaded to /usr/tmp/, the command would be:
    % cd /usr/tmp/
    
  2. Run the following commands to install. Replace /usr/local with the name of the directory you wish to be above the Allegro directory, if you wish to use a different location (if you have bunzip2 installed elsewhere and did not download it, use its path rather than ./). Replace acl70 with acl70_express or acl70_student as necessary.
    % ./bunzip2 < acl70.bz2 | (cd /usr/local; tar xf -)
    

    A directory named acl70/ (acl70_trial/ or acl70_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.

  3. Copy the license file into the Allegro directory and change its name to devel.lic.
  4. If you are an AllegroStore customer, install the new version of ObjectStore as described in Section 6.0 Installation instructions and information for AllegroStore users.
  5. 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 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 this faq item 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 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/acl70/ and that you wish to run the mlisp executable, enter:

/usr/local/acl70/mlisp

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

/usr/local/acl70_trial/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 7.0 [HP Prism]
Copyright (C) 1985-2004, 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.



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 acl70.exe). Download into a location of your choice.

Note to Express and Student users: the link from Section 13.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.

  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 acl70.exe file you downloaded (Express users: the file is acl70_trial.exe).
  3. Double click on acl70.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 acl70-trial.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\acl70\ (Program Files\acl70-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.
  9. If you are an AllegroStore customer, install the new version of ObjectStore as described in Section 6.0 Installation instructions and information for AllegroStore users.
  10. 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.

Once Allegro CL is installed, see Section 5.1 Testing that the installation of Allegro CL on Windows was successful for information on how to test that Allegro CL is installed properly.

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


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 7.0' item on the Programs submenu of the Start menu (`Allegro CL Trial 7.0' 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 7.0 | Modern ACL Images | Allegro CL 7.0 (w IDE, Modern) (or with the Express Edition, Start | Programs | Allegro CL 7.0 Free Express Edition | Allegro CL 7.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 differet and has no Startup Action dialog.)

There is a cg-user(1): prompt in the Debug window. If the cursor is not already there, click on that window to make it the selected window and make sure the cursor is after that 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.



6.0 Installation instructions and information for AllegroStore users

Allegro CL 7.0 is distributed with AllegroStore version 2.1.8.

(AllegroStore is an add-on Object-Oriented database product that works with Allegro CL and ObjectStore, a database product from Excelon Corp. You must be licensed for AllegroStore to use it and to install ObjectStore. If you are not licensed for AllegroStore, you need not concern yourself with this section.

ObjectStore versions with AllegroStore version 2.1.8/Allegro CL 7.0

A new version of ObjectStore is supplied with AllegroStore 2.1.8/Allegro CL 7.0. AllegroStore 2.1 (supplied with Allegro CL 6.1) will work with this new version.


6.1 Pre-Installation notes for AllegroStore users

See Section 2.3 Preparing for AllegroStore installation for pre-installation information.


6.2 Compatibility notes for AllegroStore users

Maintaining multiple versions of the ObjectStore

The easiest method of running multiple versions of ObjectStore is to install one version per machine.

It is possible, but not recommended, to install multiple ObjectStore clients or servers on a single machine. If you believe this configuration option may be necessary, please contact Franz support (support@franz.com) for assistance.


6.3 Installing ObjectStore

The following subsections tell you how to install ObjectStore and how to configure it for use with AllegroStore, and how to test the result.


6.3.1 Step 1: Copying and unencrypting the ObjectStore distribution

This must be done for every platform.

The new ObjectStore distribution is in an encrypted file ostore.blf.

  1. Copy the ostore.blf file. Copy [directory you downloaded into]/ostore/ostore.blf to [allegro directory]/astore/.
  2. Run the program to unencrypt ostore.blf.

    On UNIX: execute the following command in the Allegro directory:

    % sh ostore.sh
    

    On Windows: run ostore.bat in the Allegro directory.

    If you are licensed (according to your license file devel.lic) to install ObjectStore, an ObjectStore distribution will now be in place in [Allegro directory]/ostore/. To install it, go to Section 6.3.2 Step 2: Install ObjectStore.


6.3.2 Step 2: Install ObjectStore

UNIX

The supported operating system version levels are:

Make sure the OS_ROOTDIR environmental variable is not set before beginning the installation. The installation procedure will print an error message telling you to un-set the OS_ROOTDIR variable if it is set when you begin the installation. The osinstal (note: one `l' in `instal') script starts the installation. You must be root to run this script.

# cd [Allegro directory]/ostore
# ./osinstal

When the osinstal script completes its work, it instructs you what to do next. When running the osconfig step (as described in those instructions), calling osconfig with a "server" argument is recommended for most users. If you desire a client only installation, use a "client" argument.

Windows

The supported operating system version levels are NT SP6a, XP Home, XP Professional, and 2000.

Run [Allegro directory]/ostore/setup.exe to begin the installation. The default installation option installs both a client and a server. If you desire a client only installation, choose a custom installation and pick the appropriate custom settings. Note that if you choose the default installation, you will see a number of message boxes containing installation warnings. These warnings should all be ignored. We recommend that you answer 'yes' to the Reinitialize the ObjectStore Server log file? query, and we recommend that you let the installation process configure your computer to automatically start the Ostore server and/or client cache manager.

On Windows 98, you may need to increase your environment space for MS-DOS. Do this by adding the following line to your config.sys file on your boot drive:

SHELL=C:\COMMAND.COM C:\ /E:2048 /P

If you get "out of environment space" error when booting Windows 98, then you will need to add the above line.

Special note for Windows ME users

The Ostore installation on Windows creates a file C:\OS_auto.bat which sets the necessary environment values, and inserts a single CALL statement in C:\AUTOEXEC.BAT that invokes OS_auto.bat at boot time. Unfortunately, Windows ME appears to remove CALL statements from AUTOEXEC.BAT each time it boots -- perhaps this is a security feature -- which will prevent Ostore from working properly. The workaround for Windows ME installations is to append the several SET statements that are the contents of OS_auto.bat directly at the end of AUTOEXEC.BAT.


6.3.3 Step 3: Set up the individual Runtime environments

Each user should update their environment appropriately for their use of AllegroStore. The environment variables listed next are used by ObjectStore and you may wish to change them from their default value. Variables required for proper AllegroStore operation are noted in the following table; don't remove those.

Operating-System-Specific Configurations and Notes


6.3.4 Step 4: Build an AllegroStore Lisp image [optional]

Creating a Lisp image with AllegroStore preloaded means you will not have to load it at the start of each Lisp session using AllegroStore.

Start Allegro CL: UNIX

On HP-UX 11.0 you must use the executable aslisp or aslisp8. These executables are needed on HP-UX 11.00 to be able to load the AllegroStore shared library. If you use mlisp[8] or alisp[8] on HP-UX 11.00, the load of this shared library will fail.

On other UNIX platforms, you can use mlisp or alisp, both of which have International Character set support, or mlisp8 or alisp8, which do not. (mlisp and mlisp8 are case-sensitive executables/images; alisp and alisp8 are not.)

Command lines for HP-UX 11.0 (32-bit and 64-bit Lisp)

;; HP-UX 11.00 (to run a case-sensitive 
;; image with International Character set support)
;;
aslisp -I mlisp.dxl  

;; HP-UX 11.00 (to run a case-insensitive 
;; image with International Character set support)
;;
aslisp -I alisp.dxl  


;; HP-UX 11.00 (to run a case-sensitive 
;; image without International Character set support)
;;
aslisp8 -I mlisp8.dxl  

;; HP-UX 11.00 (to run a case-insensitive 
;; image without International Character set support)
;;
aslisp8 -I alisp8.dxl 

Command lines for all other UNIX

;; Other UNIX (to run a case-sensitive image with
;; International Character set support)
;;
mlisp

;; Other UNIX (to run a case-insensitive image with
;; International Character set support)
;;
alisp

;; Other UNIX (to run a case-sensitive image without
;; International Character set support)
;;
mlisp8

;; Other UNIX (to run a case-insensitive image without
;; International Character set support)
;;
alisp8

Start Allegro CL: Windows

On Windows, start Allegro CL from the Start menu choosing a menu item that contains AllegroStore in it. On Windows only, Lisp needs special command line arguments for AllegroStore to work properly. See the command line in the shortcut for the AllegroStore menu items for details. You can choose to use either the International (mlisp or alisp) or non-International (mlisp8 or alisp8) versions to build your AllegroStore image.

Create pre-loaded AllegroStore image

To build a Lisp image with AllegroStore pre-loaded, evaluate the following form in Lisp:

(build-lisp-image "[Allegro CL directory]/astore.dxl"
                  :lisp-files '(:allegrostore))

This image can be started with the same executable used above, with the arguments -I astore.dxl


6.3.5 Step 5: Test the AllegroStore installation

Start Lisp as in Step 4. Then, evaluate the following forms:

(require :allegrostore)
(load "[Allegro CL directory]/astore/verify.cl")

If you are testing a client only installation, you must edit the verify.cl file. Change the two "averify.db" strings to a string naming a file in a directory that is on a disk that is local to an AllegroStore server. If such a directory is not available via a network mount, use the "host:dir" format described above in the AS_CONFIG_PATH description. Note that "host" need not be same host specified in the AS_CONFIG_PATH variable.

On Windows, if you see an error message indicating that Ostore could not find a running server on your computer, run Start/Programs/ObjectStore Win32/ObjectStore Setup. Make sure you answer 'yes' when asked whether Ostore should reinitialize the server log file, 'yes' when asked whether Ostore should configure your computer to automatically start the server and/or cache manager, and 'yes' when asked whether Ostore should start the services 'now'. After exiting the Setup program, retry the AllegroStore test.

AllegroStore documentation

The AllegroStore manual is available in PDF format, allegrostore.pdf.



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.8a\).

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.8a.



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:



11.0 Getting a license file

You must have a license file to use Allegro CL and its associated products, and to install ObjectStore if you are an AllegroStore customer. The license file is not on the CD.

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 (except users who add AllegroStore must install ObjectStore from the CD).

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\acl70\ but you may have chosen a different directory).
    On UNIX, cd to the Allegro directory (it is typically /usr/local/acl70/ 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 7.0 Trial edition became available in early August, 2005.

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


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 Information on installing the Express Edition

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, acl70_trial.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 Allegro70installer.exe.

Once the download has succeeded, follow the steps starting here 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. Windows users see here in Section 5.0 Installation on Windows for Windows (where some useful post-installation information is provided after the installation instructions which do not apply to Allegro CL Express). In installation instructions, the CD directory is the directory you downloaded into, not the CD drive on your machine.


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, is available for sale at the Franz Store. It is a slightly restricted version of the Professional Edition of Allegro CL 7.0. Certain add-ons are not supported in the base product. 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 UNIX version (FreeBSD, Linux, or Mac OS X), the files acl70_student.bz2 and, if necessary, the bunzip2 decompression program will be downloaded. If you bought the Windows version, the self-extracting executable file acl70_student.exe will be downloaded. Here we assume the files for UNIX will be downloaded into the /usr/tmp/ directory 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/acl70_student/. On Windows, the typical location is C:\Program Files\acl70_student\. However, you can choose any location you like.
  4. UNIX: uncompress and untar the distribution file. Enter this command in /usr/tmp/ (or wherever the downloaded files are):
    % ./bunzip2 < acl70_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.

  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.

Somewhat more verbose instructions are available here 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.



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-2006, Franz Inc. Oakland, CA., USA. All rights reserved.
This page has had moderate revisions compared to the 6.2 page.
Created 2005.9.20.

ToCDocOverviewCGDocRelNotesIndexPermutedIndex
Allegro CL version 7.0
Moderately revised from 6.2. Moderate update since 7.0 release.