Installation Guide for Allegro CL 5.0.1

Windows (95/98/NT/2000) and UNIX (including Linux and FreeBSD)

$Revision: 5.0.2.64 $

Copyright (C) 1999 by Franz Inc. All rights reserved. Allegro CL is a registered trademark of Franz Inc. Allegro Presto is a trademark of Franz Inc.

The HTML version of this document looks best when viewed with Netscape 4.0 or later.

Contents

Allegro CL Lite users: look for the symbol below for details on Lite.

Overview
    Add-On Products
    Available Platforms for Allegro CL
    Where Are the New Features Documented?
    Description of Allegro CL Lite
    Description of Allegro CL Trial
Pre-Installation
UNIX Installation
    CD-ROM Distribution on UNIX
        Installing Add-on Products in UNIX
        Upgrading from one version of Allegro CL to another
    FTP Distribution on UNIX
Windows Installation
    CD-ROM Distribution on Windows (non-Lite)
         Installing Windows Add-on in Windows
         Upgrading from one version of Allegro CL to another
    CD-ROM Distribution on Windows (Lite)
    FTP Distribution on Windows (non-Lite)
    FTP Distribution on Windows (Lite)
AllegroStore Installation
Allegro ODBC (v1) Installation
Installation of GNU Emacs and XEmacs
Installation and Use of the Emacs-Lisp Interface
Installation of Patches
Uninstalling Allegro CL
Post-Installation
    Allegro CL
    Allegro CL Lite [Windows only]
    Allegro ODBC (v2)
    Allegro Composer
    CLIM
    Allegro ORBLink
    Source Code: Common Lisp
    Source Code: Common Graphics and the IDE
    Source Code: CLIM
    Source Code: Allegro ODBC
    C/C++ Binder tool
    The Emacs-Lisp Interface and the IDE [Windows only]
Links to Related Documents

Overview

This document covers the installation of the following versions of Allegro CL:

There are four CD-ROMs containing Allegro CL:

• Allegro CL for UNIX (including Linux and FreeBSD)
• Allegro CL for Windows (including Intel x86 and Alpha (AXP) processor versions)
• Allegro CL Trial Edition
• Allegro CL Lite for Windows

Add-On Products

Available Platforms for Allegro CL

The following bullets show the Operating System versions on which Allegro CL and related products run. Contact Franz Inc. (bugs@franz.com) for information on OS versions released after this document was published or for an update on released versions where Allegro CL or related products do not work. There is platform-specific information sections for each version in the Release Notes. Each bullet has a link. Note that there may not be additional information for all platforms.

AllegroStore note: all add-on products except AllegroStore work on the same OS versions as Allegro CL unless otherwise noted. AllegroStore does not work on all versions of Solaris (Sun SPARC) and IRIX (SGI).

• Compaq (formerly DEC) Alpha/Digital Unix 4.0/Tru64 UNIX (click here for platform-specific information in the Release Notes)
  • Compaq recently renamed Digital UNIX to Tru64 UNIX.
• HP PA/HP-UX 10.20 and 11.0 (click here for platform-specific information in the Release Notes)
  • Note: 11.0 requires use of a different executable and shared library.  See the post-installation notes for HP-UX below.
  • Note: HP-UX 9.x is not supported by this release of Allegro CL.
• FreeBSD 3.x on Intel processors (click here for platform-specific information in the Release Notes)
• IBM RS6000/AIX 4.2 or later (click here for platform-specific information in the Release Notes)
• Linux on Intel processors, Redhat 4.x and 5.x/6.x (click here for platform-specific information in the Release Notes)
• MkLinux DR3 and LinuxPPC R4 on PowerPC processors (click here for platform-specific information in the Release Notes)
• Microsoft Windows 95, Windows 98, and Windows NT 4.0 (Intel and Alpha processors) (click for Intel platform-specific information and for Compaq (formerly DEC) platform-specific information in the Release Notes)
  • Note: In this document we sometimes refer only to Windows 95.  Unless otherwise specified, any comments made about Windows 95 also apply to Windows 98.
  • Note: Windows 2000 (aka NT 5.0) has not been released as of this writing, but Allegro CL works fine on the most recent beta of it.
  • Note: Windows 3.1 and Windows NT 3.x are not supported by this release of Allegro CL.
  • Note: on Alpha Windows NT 4.0, Service Pack 4 is required to run Allegro CL.
• SGI/IRIX 6.2 or later (Note: 6.4 only for AllegroStore) (click here for platform-specific information in the Release Notes)
  • Note: Allegro CL is an n32 application.
  • Note: Allegro CL does run on the MIPS R12000 processor.
• Sun SPARC/Solaris 2.4 or later (Note: AllegroStore works only on Solaris 2.5.1 and 2.6) (click here for platform-specific information in the Release Notes)
  • Note: Solaris 2.7 (aka Solaris 7) is fairly new.  Our tests show that Lisp works on this platform.

The following table shows the availability of add-ons for each platform.  Y means available and n means unavailable.

Where Are the New Features Documented?

New features and changes to Allegro CL 5.0.1 are documented in the Release Notes.

Description of Allegro CL Lite

The Lite Edition is available for free, on both CD-ROM and as a download.  See our website for information about both.

The Lite Edition has the following features:

• Common Graphics and the CG-based Interactive Development Environment (IDE).
• The Allegro CL Profiler, both a time and space profiler.
• The Emacs-Lisp interface.  GNU Emacs 20.3.1 is included on the CD-ROM.
• The Allegro CL Socket library.
• The Netscape plug-in. The plug-in image file, examples/plugin/npacl.dxl, that users normally have to build is included, since Lite users cannot themselves build Lisp images.
• Comprehensive tutorial on the use of CG and the IDE.

The Lite Edition has the following limitations:

• The Lisp heap is limited to approximately 16MB.
• The function excl:dumplisp is not available.
• The function excl:build-lisp-image is not available.
• The function excl:generate-application is not available.
• The function cl:disassemble is not available.
• .fasl files compiled from other versions (Student, Personal, Enterprise and Professional can't be loaded into Lite).
• The Common Lisp function compile-file is able to compile and load a file, but it is not able to produce .fasl files.  There is a new function, excl:load-compiled, that accepts the same arguments as load but compiles the file before it is loaded.
• project-compile-file disabled.  compile-project uses load-compiled.
• prefs.cl not loaded, and cannot be saved.
• The File menu items Build project exe, Build project distribution and Compile... are disabled.
• The program expires on 11/1/2000.
• There is no printed documentation, however the same documentation that exists in ACL 5.0 is included on-line with Lite.

Add-on products are not available for the Lite Edition.

Description of Allegro CL Trial

The Trial Edition is available for free, on both CD-ROM and as a download.  See our website for information about both.

The Trial Edition contains the following features:

• The Allegro CL Profiler, both a time and space profiler.
• The Emacs-Lisp interface.
• The Allegro CL Socket library.

The Trial Edition of Allegro CL has the following limitations:

• The Lisp heap is limited to roughly 24MB.
• The program expires on 11/1/2000.
• The function excl:dumplisp is not available.
• The function excl:build-lisp-image is not available.
• The function excl:generate-application is not available.

Add-on products are not available for the Trial Edition.

| Contents | Top | Related Documents |

Pre-Installation

Windows users take note:

1. Uninstall all previous releases of Allegro CL 4.x and 5.x.  We strongly urge you to uninstall Allegro CL 5.0. There are known problems with installing later releases on top of earlier ones. To uninstall use the Uninstall item on the Allegro CL submenu of the Start menu or use the Start | Settings | Control Panel | Add/Remove Programs command. Be sure to uninstall all the uninstallable items, if you installed add-on products; also, uninstall the most recently installed components first. If you simply delete the previously installed directory you will still have problems installing the newer release.

You should save all your personal files in a separate location. (Do not save 5.0 or 5.0.1.beta2 patch files as they should not be used with 5.0.1.) After uninstallation completes, it is likely that the 5.0 Allegro Directory (by default C:\Program Files\acl5.0\) will not be removed (because uninstallation did not remove all files). You can remove the directory by hand after uninstall completes.

2. Exit all other applications before beginning the installation. This insures a cleaner installation process.
3. If you are installing ORBLink. ORBLink requires the Allegro CL Socket Library, so if you plan on using ORBLink with the Personal or Student Editions of Allegro CL, you will also need to purchase and install the Allegro CL Socket Library.

This document generically uses the term <ACL directory> to refer to the place you installed Allegro CL. This is also referred to as the Allegro directory.

The International products are a superset of the non-International product of the same name.  That is, if you install International Allegro CL Enterprise Edition, you should not install Allegro CL Enterprise Edition, since it is effectively already installed.

| Contents | Top | Related Documents |

UNIX Installation

Choose a specific set of installation instructions from either the CD-ROM or the FTP section.

When you have completed the appropriate installation instructions, you can execute Allegro CL by running <ACL directory>/lisp (see below for starting Allegro Composer). See Allegro CL Startup for more information on starting and running Allegro CL.

CD-ROM Distribution on UNIX

The Allegro CL distribution on a CD-ROM includes several subdirectories corresponding to platform names onto which Allegro CL can be installed--the list of platform subdirectories is given below. If your distribution CD-ROM does not contain a subdirectory corresponding to your desired platform, contact us before proceeding.

You need one or more license keys from Franz Inc to install Allegro CL on your desired platform. A license key is a string of letters and digits used by the copydist program described below. The license key(s) are written on sticker labels included in your Allegro CL package. We recommend that you put one set of the stickers on the CD-ROM jewel case so it will be made available to you when you install the product. If you do not have a license key for your software, please contact us before proceeding.

The installation procedure consists of one step, copying the distribution files to your computer's disks via the copydist program. Each platform subdirectory on this CD-ROM has its own version of copydist. This section gives instructions on where to find the appropriate copydist on your CD-ROM.

When invoked, copydist asks you for the following:

1. the product whose distribution is to be copied,
2. the license key supplied to you for that product, and
3. the directory into which the distribution will be copied.

After entering answers to the above questions, copydist creates the directory in (3) containing the files for the product you wish to install.

The general form of the installation is:

% cd directory
% ./copydist

where directory is one of the values from the first column in the following table:

Installing Add-on Products in UNIX

There are two types of products you can install with copydist: base Lisp products and add-on products (which have [add-on] next to their name as displayed by copydist). Add-on products must be installed into the same directory as the Allegro CL product you installed. copydist requires the -e command line argument to allow the use of an existing directory. To install an add-on product you must supply the -e command line argument and specify the same directory you previously supplied to copydist to install Allegro CL.

See the Add-On tables above for information about which products are automatically installed with each version of Allegro CL.

Upgrading from one version of Allegro CL to another

If you wish to upgrade from one version of Allegro CL (Allegro CL Personal or Allegro CL Professional) to another (Personal to Professional or Enterprise, or Professional to Enterprise), install the new version in a different directory (or remove the existing directory and then install the new version).

Sample Installation Using copydist

User input in the text below is shown in the bold Courier font.

% ./copydist

Please select your licensed product:
  1) ACL Enterprise Ed.
  2) ACL Professional Ed.
  3) Int'l ACL Enterprise Ed.
  4) Int'l ACL Professional Ed.
  5) Allegro CLIM [addon]
  6) Int'l Allegro CLIM [addon]
  7) Allegro Composer [addon]
  8) Allegro ODBC (v2) [addon]
  9) ACL Profiler [addon]
  10) Allegro ORBLink [addon]
  11) ACL Runtime [addon]
  12) ACL Dynamic Runtime [addon]
  13) ACL Source Code for Common Lisp [addon]
  14) ACL Source Code for Allegro ODBC [addon]
  15) ACL Source Code for CLIM [addon]
Enter [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, or -1 to exit]: 1

You have selected
 1) ACL Enterprise Ed..

Is that correct [y or n]? y

Please enter license key [EOF to exit]: <license key>

Enter below the directory name where you want
the licensed products to be installed.

[If you are licensed to use the products over a network,
 you should enter the common directory name that will be
 used by all networked machines using this product.]

Please enter directory name (an absolute pathname
which must not already exist):
> /usr/local/acl501
Copying...  Please wait...
.........................................
Copy Complete!

Please refer to the Installation and Release Notes
for complete information about how to use the product
you selected: ACL Enterprise Ed.

======================

Would you like to install another product into this directory [n]? y

Please select your licensed product:
  1) ACL Enterprise Ed.
  2) ACL Professional Ed.
  3) Int'l ACL Enterprise Ed.
  4) Int'l ACL Professional Ed.
  5) Allegro CLIM [addon]
  6) Int'l Allegro CLIM [addon]
  7) Allegro Composer [addon]
  8) Allegro ODBC (v2) [addon]
  9) ACL Profiler [addon]
  10) Allegro ORBLink [addon]
  11) ACL Runtime [addon]
  12) ACL Dynamic Runtime [addon]
  13) ACL Source Code for Common Lisp [addon]
  14) ACL Source Code for Allegro ODBC [addon]
  15) ACL Source Code for CLIM [addon]
Enter [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, or -1 to exit]: 5

You have selected
 5) Allegro CLIM [addon].

Is that correct [y or n]? y

Please enter license key [EOF to exit]: <another license key>
Copying...  Please wait...
.......
Copy Complete!

Please refer to the Installation and Release Notes
for complete information about how to use the product
you selected: Allegro CLIM [addon]

======================

Would you like to install another product into this directory [n]? n
0.28u 2.20s 3:28 1%; 0pf, 0sw, 384phy, st 2k, d 2k
% /usr/local/acl501/lisp
Allegro CL Enterprise Edition 5.0.1 [DEC Alpha] (6/19/99 21:25)
Copyright (C) 1985-1999, Franz Inc., Berkeley, 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).
USER(1): (exit)
; Exiting Lisp
% 

FTP Distribution on UNIX

This option is not always available for each release; usually only pre-releases are available via FTP.

Using the information provided to you regarding the file's location:

        % cd /tmp/acltmp
        % ...FTP the files from the location you were provided with...
        % chmod +x unzip   (required to make it executable)
        % cd /usr/local
        % /tmp/acltmp/unzip /tmp/acltmp/acl<version>.zip

where /usr/local is replaced by the real installation directory and acl<version>.zip is replaced by the actual name of the file you retrieved via FTP. This unzip command creates a directory called acl<version>. /usr/local/acl<version> is the Allegro directory.

| Contents | Top |  Related Documents |

Windows Installation

Important:

We strongly urge you to uninstall Allegro CL 5.0. There are known problems with installing later releases on top of earlier ones. See the Preinstallation section above.

Depending on the method (CD-ROM or FTP) of distribution, choose a set of specific installation instructions from this section. Refer to the general notes following for details on both types of installations.

Default Installation Location

The default location for the installation is c:\Program Files\acl501. Hereafter, we will use <ACL directory> instead of c:\Program Files\acl501.   For Allegro CL Lite, the default is c:\Program Files\acl501Lite.

Installation Prerequisites

• Windows NT 4.0 (x86) or Windows 95/98; Windows NT 4.0 (Alpha)
• 24 MB of RAM minimum (32 MB recommended)

Installing on Both NT and 95 Platforms

If you wish to install on both Windows 95 and NT, you will need to install once on each platform to get the Explorer extensions and Start menu items. Allegro CL will not function properly on both operating systems without doing the installation twice. If you choose the same installation options, then the same files will be installed each time setup.exe is run.

Multiple Installations

Install ACL on each computer where you intend to run it if you are licensed for running on more than one computer. We do not support a one-time installation on the network which runs from many machines.

Updating the Explorer Icons and Start Menu

After installation of the Allegro CL software, some icons and the Start menu items we add may not be updated in the Windows 95/NT 4.0 Explorer until you restart your computer. Restarting afterwards is a very good idea. Windows may not flash a banner requesting a restart after your installations, so don't rely on a prompt from the system to restart. Be sure to do it automatically after a base Lisp or an add-on installation.

CD-ROM Distribution on Windows (non-Lite)

Disk space requirements for each installation depends on the selection of add-on components.

For the Intel version run windows\setup.exe from the root directory of the CD-ROM.  For the Alpha version run winaxp\setup.exe from the root directory of the CD-ROM.

This walks you through the installation. On Windows 95, Windows 98, and NT 4.0, if you have not disabled the AutoPlay feature of CDs, then loading the CD-ROM automatically executes the Setup program. If you wish to browse the CD-ROM and have AutoPlay enabled, then you must right-click with the mouse on the CD-ROM in the Windows Explorer and select Open. Double-clicking selects the default action, which is AutoPlay. This causes setup.exe to run.

After running setup.exe, the first dialog displayed is:

Choose the particular product(s) you purchased by clicking the name. The default selected product is the Allegro CL Enterprise Edition.  Be sure to check the Add-on Products table above for information on which add-ons are included in each base Lisp product.  If an add-on is indicated as included in the base Lisp version you are installing, do not also check the product in the above dialog.   If it is not indicated as included, you must select it, along with the base Lisp version, for it to be installed.

Next you will be asked for the license key(s) for the products you are installing. Refer to your CD-ROM jewel case or to the literature sent with your purchase for this key. Enter the key in the blank window and click Next.  If you do not have a license key for your software, please contact us before proceeding.

If you are installing a base Lisp product, you will now be asked for the type of installation.

• Typical selects the options suitable for most users, and appears as the default.
• Custom allows you to choose your options. They appear in a list; click the box to the left of each option to choose it.
• Compact is for a minimal installation on computers with limited disk space.

With respect to Typical, Compact removed the following components: Help files, Integrated Development Environment and IDE Help files.

If you chose Custom in the last dialog, you will next be asked to choose the list of components you wish to install. Click Next > to proceed.

Click on the square boxes to the left to either select or un-select each component. Click on the name of any component to see text describing the component in the Description area of the dialog.

Next, choose the folder you wish to use for the software. The default is a good choice here.

Clicking Next > at this point installs the software.

Installing Windows Add-on in Windows

If you wish to add products or components of the base Lisp product after installing Allegro CL, merely run setup.exe again. Nothing will be selected by default.   If you choose the Custom installation type, components you have already installed will be unchecked in the Select Components dialog. Leaving them unchecked will not remove these components. Each time you run setup.exe to install add-on products you will get a unique un-installation menu item on the Start menu, as well as an uninstall item in the Add/Remove Programs dialog in the Windows Control Panel.

Upgrading from one version of Allegro CL to another

If you wish to upgrade from one version of Allegro CL (Allegro CL Personal or Allegro CL Professional) to another (Personal to Professional or Enterprise, or Professional to Enterprise), first uninstall the current version and then install the new version.

CD-ROM Distribution on Windows (Lite)

Disk space requirements for the Lite installation depends on the selection of components.

Run windows\setup.exe from the root directory of the CD-ROM. This walks you through the installation. On Windows 95, Windows 98, and NT 4.0, if you have not disabled the AutoPlay feature of CDs, then loading the CD-ROM automatically executes the Setup program. If you wish to browse the CD-ROM and have AutoPlay enabled, then you must right-click with the mouse on the CD-ROM in the Windows Explorer and select Open. Double-clicking selects the default action, which is AutoPlay. This causes setup.exe to run.

The Lite version has fewer installation options than the non-Lite version.  Taking the defaults is a safe way to install.

| Contents | Top |  Related Documents |

FTP Distribution on Windows (non-Lite)

This option is no longer available.

| Contents | Top |  Related Documents |

FTP Distribution on Windows (Lite)

Allegro CL Lite is distributed on our FTP and Website as a self-extracting executable.   To install it just run it.  It will walk you through the installation.

| Contents | Top |  Related Documents |

AllegroStore Installation

OS Versions: AllegroStore does not work on Solaris 2.7 (on Sun/SPARCs) or IRIX versions other than 6.4 (on SGI's) even though Allegro CL does work on those OS versions.

IMPORTANT NOTE when upgrading to AllegroStore 1.3, supplied with Allegro CL 5.0.1 (this warning is repeated in step 1):

AllegroStore 1.3 database file format is not compatible with earlier AllegroStore version database files. If you wish to use databases created with earlier AllegroStore versions, you must convert them by:

1. Before installing AllegroStore 1.3, dump the databases using the asdump module for the AllegroStore version that created the database.
2. Install AllegroStore 1.3.
3. Restore the dumped databases using the AllegroStore 1.3 asrestore module.

There are five steps to installing AllegroStore 1.3.

1. Install the AllegroStore add-on files from your distribution media
2. Install ObjectStore
3. Set up the individual Runtime environments
4. Build an AllegroStore Lisp image [optional]
5. Test the AllegroStore installation

Step 1: Install the AllegroStore add-on files from your distribution media

See the section on Installation for your particular platform (Unix or Windows) for more information; AllegroStore is installed as an add-on component.

Warning (this repeats the warning at the beginning of the AllegroStore Installation instructions): AllegroStore 1.3 database file format is not compatible with earlier AllegroStore version database files. If you wish to use databases created with earlier AllegroStore versions, you must convert them by:

1. Before installing AllegroStore 1.3, dump the databases using the asdump module for the AllegroStore version that created the database.
2. Install AllegroStore 1.3.
3. Restore the dumped databases using the AllegroStore 1.3 asrestore module.

Step 2: Install ObjectStore

# cd <ACL directory>/astore/ostore
# ./osinstal

Step 3: Set up the individual Runtime environments

Each user should update their environment appropriately for their use of AllegroStore. The environment variables in the following table 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.

Step 4: Build an AllegroStore Lisp image [optional]

(build-lisp-image "<ACL directory>/astore.dxl"
                  :lisp-files '(:allegrostore))

Step 5: Test the AllegroStore installation

 | Contents | Top | Related Documents |

Allegro ODBC (v1) Installation

To use Allegro ODBC you'll need each of the following components:

| Contents | Top | Related Documents |

Installation of GNU Emacs and XEmacs

Obtaining GNU Emacs for Windows

Obtaining GNU Emacs for UNIX

Information on downloading GNU software via FTP is available at: ftp://prep.ai.mit.edu/pub/gnu/GNUInfo/FTP. The files themselves are available at /pub/gnu.   Since we do not distribute GNU Emacs binaries or source for UNIX, you will need to FTP, build and install GNU Emacs yourself.

Obtaining XEmacs for UNIX

The binaries for XEmacs 20.x are in the /xemacs directory on the root of the UNIX CD-ROM.  See the README files in that directory for help on installation.

NOTE for AIX 4.3 users: the XEmacs binaries on the UNIX CD-ROM will work on AIX 4.2 but not on later operating systems (AIX 4.3 and 4.3.1).  Users of AIX 4.3 and later can get GNU Emacs (not XEmacs) binaries from our ftp site at ftp://ftp.franz.com/pub/emacs/gnu-emacs/aix4_3emacs20_3.tar.gz. Instructions for installation are at ftp://ftp.franz.com/pub/emacs/gnu-emacs/aix4_3emacs20_3.txt.

NOTE for FreeBSD XEmacs users: if you use the binaries on the CD-ROM, you may see a message like the following when you run the xemacs binary:

Absurd new brk addr = 0x328000 (current = 0x37a000)

This message can be (in our opinion) safely ignored.

Installation of GNU Emacs on Windows

Once you have copied the GNU Emacs directory to your computer, execute the following command to set up the shortcuts on the Start Menu and to add the registry entries needed by GNU Emacs.

If you copied it to c:/, then execute this command:

c:\emacs-20.3.1\bin\addpm

If you copied it to d:/, then execute this command:

d:\emacs-20.3.1\bin\addpm

Windows NT Users:

You must be a member of the Administrators group for addpm to properly add items to the Start Menu.

Run addpm.exe on Every System

You will need to execute the above command on each operating system you use (Windows NT and 95) for GNU Emacs to work on each operating system. GNU Emacs will not work without executing addpm.exe, since GNU Emacs relies on the changes addpm.exe makes in the registry.

Upgrade if your Emacs is 19.34.5 or Earlier

If you already have GNU Emacs 19.34.6 or later, it will work fine with the Emacs-Lisp interface. If you have an earlier version of GNU Emacs, upgrade to the newest version before trying to use the Emacs-Lisp interface. We made and submitted one change that causes the Emacs-Lisp function start-process to allow the window created by the process it starts to be visible. This is particularly useful when the Emacs-Lisp interface is used to start ACL; without this change, the ACL Console window is hidden.

Emacs Source Code Available

See the Obtaining... sections above for FTP location where you can obtain source code.

| Contents | Top | Related Documents |

Installation and Use of the Emacs-Lisp Interface

NOTE: on Windows, the Emacs-Lisp interface is part of Enterprise and Professional only.

The Emacs-Lisp interface is installed as part of the Allegro CL Enterprise and Professional Editions, described installed above, into <ACL directory>/eli.   On UNIX, a second directory is installed, <ACL directory>/xeli.   The latter is for use with XEmacs.

Using the Interface

1. Put the following forms either in c:\.emacs on Windows or in ~/.emacs on Unix. GNU Emacs loads .emacs in c:\ upon startup, no matter where GNU Emacs or Allegro CL were installed.  <eli> is either eli or xeli, depending on if you are using GNU Emacs or XEmacs 20.

       (load "<ACL directory>/<eli>/fi-site-init")
        (setq fi:common-lisp-image-name "<ACL directory>/lisp")

2. Use the Emacs command M-x fi:common-lisp to start Common Lisp within Emacs and to establish the connection between Emacs and Allegro CL.

   If you want to call fi:common-lisp from an Emacs-Lisp program, it takes the following (all-optional) arguments:

   buffer-name
   directory
   executable-image-name
   image-args
   host, and
   lisp-image-file (new from ACL 4.3)

   For example:

        (fi:common-lisp "*common-lisp*" "<ACL directory>/"
                        "<ACL directory>/lisp")

   In the above forms, just replace <ACL directory> with the actual path for your installation.

| Contents | Top | Related Documents |

Installation of Patches

| Contents | Top | Related Documents |

Uninstalling Allegro CL

| Contents | Top | Related Documents |

Post-Installation

Allegro CL

On Windows, Start menu shortcuts that contain the phrase lisp only do not contain the Integrated Development Environment.  You can load the IDE into such images by doing (require :ide), and you can start the IDE by evaluating (cg:start-ide).

HP-UX 11.0 requires use of different versions of lisp.exe and the ACL shared library (libaclclNNN.sl, where NNN is some number).  These new files can be found in the hpux11/ subdirectory of your Allegro CL directory. Merely replace the files of the same name in your Allegro CL directory with the ones from hpux11/ if you are running on HP-UX 11.0. See also the platform-specific information on HP's in the Release Notes.

Linux Redhat 4: in order that foreign loading and the foreign function interface work properly, you should now install an updated ld.so on your Redhat 4 system.  On the CD-ROM in the directory redhat4/ there are two files:

• ld.so-1.9.2.tar.gz: the original sources for ld.so version 1.9.2.
• ld.so-1.9.2.diff: the diffs required to make foreign loading operational, with respect to the original ld.so-1.9.2 sources.

You can unpack and build the new ld.so like this:

cd /usr/src
tar zxf <...>/ld.so-1.9.2.tar.gz
cd ld.so-1.9.2.tar.gz
patch -N < <...>/ld.so-1.9.2.diffs
make

You will need to be root to install the new ld.so.  Please follow the instructions in the ld.so README for more information.

MkLinux/LinuxPPC: in order that foreign loading and the foreign function interface work properly, you should now install an updated ld.so on your MkLinux/LinuxPPC system.  See the README-ld.so file on the CD-ROM in the directory linuxppc/ for more information.

Allegro CL Lite [Windows only]

The Lite version of Allegro CL is different than the non-Lite versions of Allegro CL in the following ways:

• There is a limit on the amount of heap space that can be allocated.
• build-lisp-image is unavailable in Lite.
• generate-application is unavailable in Lite.
• disassemble is unavailable in Lite.
• .fasl files are incompatible with other versions of Allegro CL on Windows.
• The executable will expire on 11/1/2000.  We recommend you download a new version of Allegro CL Lite before this date.
• The compiler does not produce .fasl files.  As a consequence, various features that use the compiler are disabled.
• The IDE prefs.cl is neither loaded nor saved.

However, the Lite version does contain the following features:

• The Allegro CL Profiler add-on product.
• The Emacs-Lisp interface (Emacs is supplied with the CD-ROM version of Lite).
• The Allegro CL Socket Library add-on product.
• Documentation for all Allegro CL based products.

Additionally, the following items should be noted about Lite:

• Because build-lisp-image and generate-application are disabled in Lite, the instructions for the Netscape plugin to build the .dxl file do not work.  For this reason, we have included a pre-built npacl.dxl in the examples/plugin/ directory.
• Because the compiler does not output .fasl files in Lite, the tutorial step 7 in chapter 4, use of Tools | Full Compile does not work.  You can safely skip this step of the tutorial.

Allegro ODBC (v2)

If you install Allegro ODBC version 2, then you can load it with the following form:

(require :aodbc-v2)

For more information see doc/cl/aodbc_v2.htm.

Allegro Composer

Allegro Composer is only available on Unix platforms.

You can start Allegro CL with Allegro Composer by running the executable <Allegro directory>/composer, or <Allegro directory>/composeri if you are using an International version of Allegro CL. As is discussed in Running Allegro CL 5.0.1, running the composer binary will load composer.dxl, which is in the Allegro directory. See Allegro CL Startup for more information on starting and running Allegro CL.

Allegro Composer is intended to be used with GNU Emacs; we recommend that you use the version which comes with Allegro CL 5.0.1. When you start Emacs and load the Emacs-Lisp interface, there will be a Composer menu, and a Start Composer item on that menu. Choose this menu item to start Allegro Composer.

See the section above for information on installing Emacs.

CLIM

There are no pre-built CLIM images.  You can either:

1. make an image containing CLIM by loading <ACL directory>/buildclim.cl, or
2. load CLIM into a running Lisp image by evaluating (require :climxm) on UNIX or (require :climnt) on Windows.

Refer to the printed CLIM User Guide, the printed Release Notes for CLIM 2.2 on Allegro CL 5.0.1, and CLIM on Allegro CL 5.0.1 in the online Release Notes (doc\cl\release_notes.htm) for information on using CLIM.

CLIM on Windows	CLIM on Windows can only be used in a case insensitive Lisp.  We hope to remove this restriction in a future release.
CLIM on Linux	CLIM on Linux is only supported with the Metro Link Motif (v. 1.2.4) software on Redhat 4.x and 5.x/6.x. See the Metro Link web site, http://www.metrolink.com, for details on Motif.

Allegro ORBLink

For further installation instructions on ORBLink, please see the Installation section of orblink/doc/index.htm.

Source Code: Common Lisp

When you install this product the resulting source code files can be found in <ACL directory>/src/cl.

Source Code: Common Graphics and the IDE

When you install this product the resulting source code files can be found in <ACL directory>/src/cg. Please refer to the file <ACL directory>/src/cg/loadsfi.cl in this directory for more information about using these files.

Source Code: CLIM

When you install this product the resulting source code files can be found in <ACL directory>/src/clim.

Source Code: Allegro ODBC

When you install this product the resulting source code files can be found in <ACL directory>/src/aodbc.

C/C++ Binder tool

Now available is a tool that facilitates the building of interfaces between Allegro CL and foreign libraries written in C and C++. The interface to libraries is typically defined by one or more header files.

The C Binder tool scans C header files and generates the appropriate Lisp code necessary to use the facilities defined in the header file. This normally consists of:

• foreign function definitions
• foreign structure definitions
• constant definitions, and
• in some cases, C function stubs (or wrappers) necessary to interface correctly between ACL and C.

The C++ Binder is a tool that performs the same task for C++ header files. In the C++ case, we generate many more C function wrappers in order to deal with overloaded functions correctly.

In a few cases, it is not possible to generate the correct interface automatically. In these cases we try to generate appropriate warning messages.

The Binder tools are located on the CD-ROM in the cbind/ directory in the root of the CD-ROM. There are subdirectories for the supported platforms (among the platforms on the CD-ROM). The following files in each subdirectory provide more information:

• README.txt
• cbind.htm
• cplbind.htm

The Emacs-Lisp Interface and the IDE [Windows only]

On Windows, there is a bad interaction between the Integrated Development Environment (IDE) and the Emacs-Lisp interface.  When running Lisp connected to Emacs, a run bar is displayed in the mode line of Emacs.  This run bar shows the status of Lisp, whether or not it is idle, running or doing a garbage collection.  When the Lisp connected to Emacs is running the IDE, the run bar may flicker quite rapidly.   To turn off the run bar, put the following form in your .emacs file, just after the loading of fi-site-init:

(setq fi:start-lisp-interface-hook
  (delete 'fi:show-run-status fi:start-lisp-interface-hook))

| Contents | Top | Related Documents |

Links to Related Documents

An Overview of the Allegro CL documentation
Release Notes
ANSI Common Lisp Specification

| Contents | Top |