dumplisp

$Revision: 5.0.2.5 $

Function

Package: EXCL

Arguments: (&key name ignore-command-line-arguments suppress-allegro-cl-banner)

This function saves an image of the currently executing Common Lisp as an executable file. 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 the discussion under the large headings above in this section for more information on excl: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 sys: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 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 14.0 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 ignore-command-line-arguments keyword argument is non-nil value, 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: excl:dumplisp is significantly changed from earlier releases. Certain arguments have been 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 excl:dumplisp and you cannot specify that file as the value of the name argument.

See dumplisp.htm for more information on excl:dumplisp. See also building_images.htm and delivery.htm.

The general documentation description is in introduction.htm. The index in index.htm.