/[cmucl]/src/general-info/lisp.1
ViewVC logotype

Contents of /src/general-info/lisp.1

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.15 - (hide annotations)
Wed Aug 25 21:35:00 2010 UTC (3 years, 7 months ago) by rtoy
Branch: MAIN
CVS Tags: GIT-CONVERSION, cross-sol-x86-merged, cross-sol-x86-base, snapshot-2010-12, snapshot-2010-11, snapshot-2011-09, snapshot-2011-06, snapshot-2011-07, snapshot-2011-04, snapshot-2011-02, snapshot-2011-03, snapshot-2011-01, cross-sol-x86-2010-12-20, cross-sparc-branch-base, HEAD
Branch point for: cross-sparc-branch, cross-sol-x86-branch
Changes since 1.14: +45 -6 lines
o Update with new command line options
o Document some of the new files and directories that are installed.
1 ram 1.1 .\" -*- Mode: Text -*-
2     .\"
3     .\" **********************************************************************
4     .\" This code was written as part of the CMU Common Lisp project at
5     .\" Carnegie Mellon University, and has been placed in the public domain.
6     .\" If you want to use this code or any part of CMU Common Lisp, please contact
7     .\" Scott Fahlman or slisp-group@cs.cmu.edu.
8     .\"
9 rtoy 1.15 .\"$Header: /tiger/var/lib/cvsroots/cmucl/src/general-info/lisp.1,v 1.15 2010/08/25 21:35:00 rtoy Rel $
10 ram 1.1 .\"
11     .\" **********************************************************************
12     .\"
13     .\" Man page for CMU CL.
14 rtoy 1.14 .TH LISP 1 "Mar, 2009"
15 ram 1.1 .AT 3
16     .SH NAME
17     lisp \- CMU Common Lisp programming environment
18     .SH SYNOPSIS
19     .B lisp
20     [input-files] [switch-list]
21     .SH DESCRIPTION
22     .I lisp
23     Starts up CMU Common Lisp. If
24     .I switch-list
25     is empty, then Lisp will enter a read-eval-print loop using stdin, stdout and
26     stderr. The optional
27     .I input-files
28     provide operands for some switches. These switches are defined:
29    
30     .TP 10n
31 rtoy 1.15 .BR \-help
32     Prints out the command line options and exits.
33     .TP
34     .BR \--help
35     Same as -help.
36     .TP
37 ram 1.1 .BR \-core " filename"
38 toy 1.9 Specifies the suspended Lisp image (or `core file') to start up.
39     .TP
40     .BR \-lib " libpath"
41     A colon-separated list of directories to be used for the library: search-list.
42 ram 1.1 .TP
43 pmai 1.10 .BR \-batch
44     Causes Lisp to run in batch mode, where all input is directed from
45     standard-input.
46     A unix return code of 0 is returned upon encountering an EOF, while any
47     unhandled error condition will cause an immediate exit with a return code
48     of 1, instead of entering the debugger.
49     .TP
50     .BR \-quiet
51     Causes Lisp to start up silently, disabling printing of the herald, and causing
52     most unnecessary noise, like GC messages, load messages, etc. to be suppressed.
53     .TP
54     .BR \-dynamic-space-size
55     Requires an argument that should be the number of megabytes (1048576 bytes)
56     that should be allocated to the heap. If not specified, a platform-specific
57     default is used. The actual maximum allowed heap size is platform-specific.
58     Currently, this option is only available for the x86 and sparc platforms.
59     .TP
60 ram 1.1 .BR \-edit
61     Causes Lisp to enter the
62     .I Hemlock
63     editor.
64     A file to edit may be specified by
65     placing the name of the file between the program name (usually `lisp') and
66     the first switch.
67     .TP
68     .BR \-eval " expression"
69     Evaluates the specified Lisp
70     .I expression
71     during the start up sequence. The value of the form will not be printed unless
72     it is wrapped in a form that does output.
73     .TP
74     .BR \-init " filename"
75     Specifies the name of a file containing user customizations that is to be
76     loaded each time Lisp starts up (default ~/init or ~/.cmucl-init.) The loader
77     loads any existing compiled binary, or the ".lisp" source if none.
78     .TP
79     .BR \-hinit " filename"
80     Similar to \-init, but specifies the name of the
81     .I Hemlock
82 ram 1.2 init file (default `~/hemlock-init' or ~/.hemlock-init), which is loaded only
83     when
84 ram 1.1 .I Hemlock
85     is started.
86     .TP
87     .BR \-noinit
88     Suppresses loading of the init file, and also prevents \-edit from loading the
89     .I Hemlock
90     init file.
91 pmai 1.7 .TP
92     .BR \-nositeinit
93     Suppresses loading of the site-init site specific initialization file.
94 ram 1.1 .TP
95     .BR \-load " filename"
96     Loads the specified file into Lisp before entering Lisp's read-eval-print loop.
97     .TP
98     .BR \-slave " editor-name"
99     Specifies that Lisp should start up as a
100     .I slave
101     Lisp and try to
102     connect to an editor Lisp. The name of the editor to connect to must be
103     specified. To find the editor's name, use the
104     .I Hemlock
105     `Accept Slave Connections' command.
106     .I editor-name
107     is of the form `machine-name:socket', where
108     .I machine-name
109     is the
110     internet host name for the machine and
111     .I socket
112     is the decimal number of the socket to connect to.
113 rtoy 1.11 .TP
114     .BR \-debug-lisp-search
115     Enables printing of messages indicating how CMUCL is searching for its
116     core file. This is useful if CMUCL is not finding its core file for
117     some reason.
118 rtoy 1.12 .TP
119     .BR \-fpu " fpu-mode"
120     This option is only available on x86 systems. This option takes the
121     values x87, sse2, or auto, with auto being the default. With the
122     default value, CMUCL will check to see if the machine running CMUCL
123     supports SSE2 or not. If so, the SSE2 core file is automatically
124     selected and used. If not, the x87 core file is used. With this
125     option, the user can override the detection and select a core. (Note
126     that you cannot run the SSE2 core on a chip that doesn't not have
127     SSE2. But the x87 core can run on any machine.)
128 rtoy 1.13 .TP
129     .BR \--
130     If this option is given, CMUCL's argument processing is stopped, and
131     anything after "--" is placed in
132     EXT:*COMMAND-LINE-APPLICATION-ARGUMENTS*. This allows the application
133     to its own processing of any special options.
134 ram 1.1 .PP
135    
136     .SH ENVIRONMENT
137    
138     .TP 10n
139     .BR CMUCLLIB
140     This variable points to the `lib/' directory holding `lisp.core' and other
141 toy 1.9 files used by Lisp at run-time. This can be overridden by using the
142     -lib commandline option.
143     .TP
144     .BR CMUCLCORE
145     This variable holds the path to the `lisp.core' that that should be
146     used. This can be overridden by using the -core commandline option.
147 ram 1.1 .TP
148     .BR CMUCL_EMPTYFILE
149 ram 1.5 [SunOS only] If `df /tmp' shows `swap' as the filesystem for the `/tmp'
150     directory, then you have a "tmpfs" filesystem. In this case, you must setenv
151     CMUCL_EMPTYFILE to point into a pathname on a non-TMPFS filesystem that can be
152     used instead of `/tmp/empty'.
153 ram 1.4 .TP
154     .BR XKEYSYMDB
155     In order to use Motif (and the graphical debugger) with X servers from
156     non-OSF vendors (like Sun) you may need to set the environment variable
157 ram 1.5 XKEYSYMDB to point to the file `lib/XKeysymDB'. Otherwise, you will get many
158 ram 1.4 error messages every time a new connection is opened to the CMU CL motifd.
159     This file is read by the X11R5 Xt in order to augment the keysym database with
160     certain OSF vendor keysyms that Motif wants to use.
161 toy 1.9
162     .SH CORE FILE SEARCHING
163     When no core file is specified (either by the CMUCLCORE environment
164     variable or by the -core option), CMUCL will search in various places to
165     find a possible core file.
166    
167     When the environment variable CMUCLLIB is set or the -lib option is
168     given, the lisp core file is searched in the places specified
169     therein. This is a colon-separated list of directories, just like
170 pmai 1.10 PATH. This list of directories is searched in order for a file named
171 toy 1.9 `lisp.core'. The first one found will be the core to be used.
172    
173     When the CMUCLLIB is not set and -lib is not given, a set of default
174 pmai 1.10 paths is used to initialize the library: search-list, and this list is
175     also used to search for the core file. Let the lisp C executable be
176     located at `<bin>/lisp'. Then the following directories are searched
177     for the core file:
178 toy 1.9
179     .TP 10n
180     .BR `<bin>'
181     .TP
182     .BR `<bin>/../lib/cmucl/lib'
183     .TP
184     .BR `<bin>/../lib'
185     .TP
186     .BR `/usr/local/lib/cmucl/lib'
187 ram 1.4
188 ram 1.1 .PP
189    
190     .SH FILES
191    
192     The following pathnames are specified relative to the directory where CMU CL is
193 pmai 1.8 installed, e.g. /usr/local.
194 ram 1.1
195     .TP 10n
196 pmai 1.8 .BR doc/cmucl/*
197 ram 1.1 Various postscript and text documentation files.
198     .TP
199     .BR bin/lisp
200     The lisp startup program. This directory should be in PATH.
201     .TP
202 rtoy 1.15 .BR lib/cmucl/sample-wrapper
203     An example shell script that setups up the environment and run lisp.
204     This is not normally needed unless you want some special
205     configuration.
206     .TP
207 pmai 1.8 .BR lib/cmucl/lib/lisp.core
208 rtoy 1.15 The suspended Lisp image. But for x86 machines the suspended core is
209     named lisp-x87.core or lisp-sse2.core, depending on whether the x87 or
210     sse2 core is used.
211     .TP
212     .BR lib/cmucl/lib/site-init.lisp, generic-site.lisp
213     Site specific initialization (see README file.) The generic-site.lisp
214     file is a template that can be used to create site-init.lisp. (Note:
215     installation of CMUCL does not create or destroy any site-init.lisp file.)
216     .TP
217     .BR lib/cmucl/lib/lisp.a
218     An archive file of all of the C runtime code. This is needed when
219     creating and executable image.
220     .TP
221     .BR lib/cmucl/lib/linker.sh, linker-x86.sh
222     Shell scripts to perform the necessary linking to create an executable
223     image.
224 ram 1.1 .TP
225 pmai 1.8 .BR lib/cmucl/lib/hemlock11.*, lib/cmucl/lib/mh-scan, lib/cmucl/lib/spell-dictionary.bin
226 ram 1.1 Hemlock files.
227     .TP
228 pmai 1.8 .BR lib/cmucl/lib/fonts/
229 ram 1.5 X11 fonts for Hemlock.
230 ram 1.4 .TP
231 rtoy 1.15 .BR lib/cmucl/lib/locale
232     This directory contains template files for CMUCL messages.
233     Translations of the CMUCL messages are also stored here.
234     .TP
235 pmai 1.8 .BR lib/cmucl/lib/XKeysymDB
236 ram 1.4 Database of X Keysym names for Motif.
237 ram 1.1 .TP
238 pmai 1.8 .BR lib/cmucl/lib/load-foreign.csh
239     Script used by LOAD-FOREIGN to run "ld" on some platforms.
240 ram 1.1 .TP
241 rtoy 1.15 .BR lib/cmucl/lib/contrib
242     This directory contains contrib modules, including asdf2 and
243     mk-defsystem.
244     .TP
245     .BR lib/cmucl/lib/ext-formats
246     This directory contains lisp files that implement the various external
247     formats supported by CMUCL.
248     .TP
249     .BR lib/cmucl/lib/subsystems
250     This directory contains the subsystems for CMUCL. The subsystems
251     include CLX, CLM, Gray streams, Hemlock, and Simple Streams.
252     .TP
253     .BR ~/init.lisp,~/.cmucl\-init.lisp
254 ram 1.1 User customization files loaded at lisp startup; either name is acceptable.
255     Init files can be compiled.
256     .TP
257 ram 1.2 .BR ~/hemlock-init.lisp, ~/.hemlock-init.lisp
258 ram 1.1 Hemlock initialization file, loaded when Hemlock starts.
259     .PP
260    
261     .SH SEE ALSO
262     cmucl(1), README
263     .br
264     The ``CMU Common Lisp User's Manual'',
265     .br
266     the ``Hemlock User's Manual'', and
267     .br
268     the ``Hemlock Command Implementor's Manual''
269    
270     .SH BUGS
271    
272 pmai 1.8 Consult http://www.cons.org/cmucl/support.html for support
273     information, including mechanisms for bug reporting. Please consult
274     your local CMU CL maintainer or Common Lisp expert if any to verify
275     that a problem really is a bug before reporting it.
276 ram 1.1
277     Known problems with this version:
278     .TP 3
279     --
280     Detection of stack overflow is not very graceful. You get many "map
281     failure" errors on stderr.
282     .TP 3
283     --
284 ram 1.5 If file descriptors are used up, then Lisp will die.
285 ram 1.1 .TP 3
286     \--
287     Several proposed ANSI Common Lisp (CLtL II) features are not implemented:
288 ram 1.5 Any CLOS features not implemented by PCL, and features added since the first
289     ANSI draft.
290 ram 1.1 .TP 3
291     \--
292     The interpreter's pre-processing freezes in the macro definitions in effect at
293     the time an interpreted function is defined.
294     .PP

  ViewVC Help
Powered by ViewVC 1.1.5