3 .\" Manual for `dump-runlisp-image'
5 .\" (c) 2020 Mark Wooding
8 .\"----- Licensing notice ---------------------------------------------------
10 .\" This file is part of Runlisp, a tool for invoking Common Lisp scripts.
12 .\" Runlisp is free software: you can redistribute it and/or modify it
13 .\" under the terms of the GNU General Public License as published by the
14 .\" Free Software Foundation; either version 3 of the License, or (at your
15 .\" option) any later version.
17 .\" Runlisp is distributed in the hope that it will be useful, but WITHOUT
18 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
19 .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 .\" You should have received a copy of the GNU General Public License
23 .\" along with Runlisp. If not, see <https://www.gnu.org/licenses/>.
40 \h'-\w'\fB\\$1\ \fP'u'\fB\\$1\ \fP\c
44 .\"--------------------------------------------------------------------------
45 .TH runlisp 1 "12 August 2020" "Mark Wooding"
47 dump-runlisp-image \- dump Lisp images for faster script execution
49 .\"--------------------------------------------------------------------------
59 .\"--------------------------------------------------------------------------
64 program builds custom images for use by
66 For many Lisp implementation,
68 with ASDF already loaded,
69 can start scripts much more quickly
70 than the `vanilla' images installed by deafult.
71 The downside is that custom images may be rather large.
73 .SS "Supperted Common Lisp implementations"
74 The following Lisp implementations are currently supported.
78 The default image name is
80 a typical image can be 20\(en30\*,MB in size.
84 The default image name is
86 a typical image is about 10\*,MB in size.
89 Carnegie\(enMellon University Common Lisp.
90 The default image name is
92 a typical image is about 35\*,MB in size.
95 Embeddable Common Lisp.
96 The default image name is
98 images comparatively very small
99 \(en about 4\*,MB \(en
100 but, sadly, not very effective.
103 Steel Bank Common Lisp.
104 The default image name is
106 a typical image is nearly 45\*,MB in size.
110 also supports Armed Bear Common Lisp,
111 .B dump-runlisp-image
115 The following options are accepted on the command line.
120 .BR dump-runlisp-image 's
122 and a description of the command-line options
124 and immediately exit with status 0.
129 .BR dump-runlisp-image 's
132 and immediately exit with status 0.
136 Dump images for all Lisp supported implementations
137 which are installed .
143 and also list implementations explicitly on the command line.
147 Only dump images for Lisp implementations
148 which are actually installed
153 List the supported implementations
154 and the names of the image files for each
156 and immediately exit with status 0.
163 then write images to that directory
164 with their default names
167 exactly one Lisp implementation may be named, and
168 the image is written to a file named
171 images are written to the directory which
173 will look in when checking for custom images
175 .B "runlisp \-\-help"
177 .BR "dump-runlisp-image \-h" ),
178 unless overridden by the
180 environment variable.
184 Don't create Lisp images
185 if a file with the appropriate name
190 Be more verbose about the process of creating images.
191 Lisp implementations can be rather noisy:
193 .B dump-runlisp-image
194 runs silently unless something goes wrong,
195 in which case it prints the failed Lisp command line
200 .B dump-runlisp-image
201 will show Lisp implementation's noise immediately,
202 without waiting to see whether it succeeds or fails.
205 .B dump-runlisp-image
206 program will dump an image for each of the named
208 implementations in turn,
209 or all Lisp implementations, if
213 This involves invoking the Lisp implementations.
215 .B dump-runlisp-image
216 program expects, by default,
217 to be able to run a Lisp system
218 as a program with the same name,
219 found by searching as directed by the
221 environment variable.
222 This can be overridden by setting an environment variable,
223 with the same name but in
225 to the actual name \(en
226 either a bare filename to be searched for on the
228 or a pathname containing a
230 relative to the working directory or absolute,
232 Note that the entire variable value is used as the program name:
233 it's not possible to provide custom arguments to a Lisp system
234 using this mechanism.
235 If you want to do that,
236 you must write a shell script to do the necessary work,
237 and point the environment variable
241 (This is the same convention as
250 .B dump-runlisp-image
251 will skip Lisp implementations
252 which can't actually be found
255 for its command name).
257 .\"--------------------------------------------------------------------------
261 There's no support for making images for ABCL.
262 I don't really know what this would look like,
263 but I suspect it wouldn't help very much.
264 ABCL is terribly slow to start up anyway.
270 Mark Wooding, <mdw@distorted.org.uk>
272 .\"----- That's all, folks --------------------------------------------------