dumplisp

Function

Package: excl

Arguments: &key name ignore-command-line-arguments suppress-allegro-cl-bannerk

This function saves an image of the currently executing Common Lisp as an image file. This file (which usually has extension .dxl) is not executable, but is suitable as the image argument to the executable file mlisp or mlisp8 (on Unix machines) or mlisp.exe or mlisp8.exe (on Windows). You can specify the name of the image file created with the name keyword argument. the name defaults to savedcl.dxl. Thus, calling in Lisp

(dumplisp)

will produce an image file savedcl.dxl.This image can be started with the command line (use whichever of mlisp or mlisp8 was used to start the image that was dumped):

UNIX 16-bit: mlisp -I <directory containing savedcl.dxl>/savedcl.dxl
UNIX 8-bit: mlisp8 -I <directory containing savedcl.dxl>/savedcl.dxl

WINDOWS 16-bit: mlisp.exe -I <directory containing savedcl.dxl>/savedcl.dxl
WINDOWS 8bit: mlisp8.exe -I <directory containing savedcl.dxl>/savedcl.dxl

On Windows, .dxl is usually registered as an Allegro CL image file extension, so double-clicking on it in the File Explorer should also start Allegro CL with that image. Note too on Windows that if the image contains the IDE, then adding -f cg:start-ide to the command line will cause the IDE to be started automatically when the image starts.

The following table gives brief descriptions of the arguments. See the notes for more information on specific arguments and the warnings that follow the notes. See dumplisp.htm for more information on dumplisp.

Argument	Value should be:	Effect	See
name	A string naming a file (default "savedcl.dxl"). Image files must have an extension. The usual extension is dxl but any non-null extension will do.	The dumped image will have this name. If no directory is specified, the file will be written to the current working directory.	Warning 2
ignore-command-line-arguments	`t` or `nil` (default `nil`)	If true, command-line-arguments are ignored during startup and all arguments are considered application arguments (to command-line-arguments and friends)	Note 2
suppress-allegro-cl-banner	`t` or `nil` (default `nil`)	The Allegro CL copyright banner will not be printed on startup.	Note 3

Notes:

These arguments from earlier (than 5.0) Unix releases are no longer supported: checkpoint (if t, tried to restart actual computational state, no longer possible); standalone (the separate executable/image model means an image cannot be standalone).
See The emacs-lisp interface and dumped images in dumplisp.htm for information on starting the emacs-lisp interface when ignore-command-line-arguments is true (the interface is usually started by a command-line argument).
When the suppress-allegro-cl-banner keyword argument is true, then the following warning is issued:

You are allowed to suppress (i.e., not display) the Franz Inc. supplied copyright banner in your application, if and only if you agree to display Franz Inc. copyright and proprietary notices wherever you display your own copyright or other proprietary notices.

Warning 1: dumplisp was significantly changed in release 5.0. Certain arguments were removed as noted in Note 1 above.

Warning 2: This function depends on the current running Lisp image file to be present and readable (i.e. it cannot be read-protected) and not stripped. Therefore you cannot delete that file before running dumplisp and you cannot specify that file as the value of the name argument.

The documentation is described in introduction.htm and the index is in index.htm.

Created 2000.10.5.