File: clisp.html

package info (click to toggle)
clisp 1997-12-06-1
  • links: PTS
  • area: main
  • in suites: hamm, slink
  • size: 20,744 kB
  • ctags: 8,390
  • sloc: ansic: 37,808; lisp: 37,255; asm: 6,393; sh: 3,077; objc: 2,481; makefile: 1,174; sed: 96; perl: 14
file content (339 lines) | stat: -rw-r--r-- 9,228 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
<HEAD>
<TITLE> CLISP manual page </TITLE>
</HEAD>
<BODY>
<H1>CLISP manual page</H1>

<UL>
<LI> <A HREF="#Name">Name</A>
<LI> <A HREF="#Synopsis">Synopsis</A>
<LI> <A HREF="#Description">Description</A>
<LI> <A HREF="#Options">Options</A>
<LI> <A HREF="#Reference">Reference</A>
<LI> <A HREF="#Use">Use</A>
<LI> <A HREF="#Files">Files</A>
<LI> <A HREF="#Environment">Environment</A>
<LI> <A HREF="#See also">See also</A>
<LI> <A HREF="#Bugs">Bugs</A>
<LI> <A HREF="#Projects">Projects</A>
<LI> <A HREF="#Authors">Authors</A>
</UL>
<P>

<HR>

<A NAME="Name">
<H2>Name</H2>
</A>

<CODE>clisp</CODE> - Common Lisp language interpreter and compiler

<A NAME="Synopsis">
<H2>Synopsis</H2>
</A>

<CODE>clisp</CODE>
[ <A HREF="#Option -h"><CODE>-h</CODE></A> ]
[ <A HREF="#Option -m"><CODE>-m</CODE> <EM>memsize</EM></A> ]
[ <A HREF="#Option -M"><CODE>-M</CODE> <EM>memfile</EM></A> ]
[ <A HREF="#Option -L"><CODE>-L</CODE> <EM>language</EM></A> ]
[ <A HREF="#Option -N"><CODE>-N</CODE> <EM>directory</EM></A> ]
[ <A HREF="#Option -q"><CODE>-q</CODE></A> ]
[ <A HREF="#Option -I"><CODE>-I</CODE></A> ]
[ <A HREF="#Option -i"><CODE>-i</CODE> <EM>initfile</EM> ...</A> ]
[ <A HREF="#Option -c"><CODE>-c</CODE> [ <CODE>-l</CODE> ] <EM>lispfile</EM> [ <CODE>-o</CODE> <EM>outputfile</EM> ] ...</A> ]
[ <A HREF="#Option -p"><CODE>-p</CODE> <EM>packagename</EM></A> ]
[ <A HREF="#Option -x"><CODE>-x</CODE> <EM>expression</EM></A> ]

<A NAME="Description">
<H2>Description</H2>
</A>

Invokes the common lisp interpreter and compiler. Invoked without
arguments, executes a read-eval-print loop, in which expressions are in
turn read from standard input, evaluated by the lisp interpreter, and
their results output to standard output. Invoked with <A HREF="#Option -c"><CODE>-c</CODE></A>,
the specified lisp files are compiled to a bytecode that can be executed
more efficiently.

<A NAME="Options">
<H2>Options</H2>
</A>

<DL>

<DT> <A NAME="Option -h"> <CODE>-h</CODE> </A>
<DD> Displays a help message on how to use <CODE>clisp</CODE>.
<P>

<DT> <A NAME="Option -m"> <CODE>-m</CODE> <EM>memsize</EM> </A>
<DD> Sets the amount of memory <CODE>clisp</CODE> tries to grab
on startup. The amount may be given as <EM>nnnnnnn</EM> (measured in bytes),
<EM>nnnn</EM> <CODE>K</CODE> or <EM>nnnn</EM> <CODE>KB</CODE> (measured in kilobytes) or
<EM>n</EM> <CODE>M</CODE> or <EM>n</EM> <CODE>MB</CODE> (measured in megabytes).
Default is 2 megabytes.
The argument is constrained between 100 KB and 16 MB.
-- This version of <CODE>clisp</CODE>
allocates memory dynamically.
<EM>memsize</EM> is essentially ignored.
<P>

<DT> <A NAME="Option -M"> <CODE>-M</CODE> <EM>memfile</EM> </A>
<DD> Specifies the initial memory image.
This must be a memory dump produced by the <EM>saveinitmem</EM> function.
<P>

<DT> <A NAME="Option -L"> <CODE>-L</CODE> <EM>language</EM> </A>
<DD> Specifies the language <CODE>clisp</CODE>
uses to communicate with the user. This may be
<CODE>english</CODE>, <CODE>deutsch</CODE>, <CODE>francais</CODE>.
<P>

<DT> <A NAME="Option -N"> <CODE>-N</CODE> <EM>directory</EM> </A>
<DD> Specifies where the locale messages files may be found.
<P>

<DT> <A NAME="Option -q"> <CODE>-q</CODE> </A>
<DD> Quiet: <CODE>clisp</CODE>
displays no banner at startup and no good-bye message when quitting.
<P>

<DT> <A NAME="Option -I"> <CODE>-I</CODE> </A>
<DD> ILISP friendly: <CODE>clisp</CODE>
interacts in a way that ILISP (a popular Emacs LISP interface) can deal with.
Currently the only effect of this is that unnecessary prompts are not
suppressed.
Furthermore, the GNU readline library treats Tab as a normal self-inserting
character.
<P>

<DT> <A NAME="Option -i"> <CODE>-i</CODE> <EM>initfile</EM> ... </A>
<DD> Specifies initialization files to be <CODE>load</CODE>ed
at startup. These should be lisp files (source or compiled).
<P>

<DT> <A NAME="Option -c"> <CODE>-c</CODE> <EM>lispfile</EM> ... </A>
<DD> Compiles the specified <EM>lispfile</EM>s to bytecode. The compiled files
can then be <CODE>load</CODE>ed instead of the sources to gain efficiency.
<P>

<DT> <A NAME="Option -o"> <CODE>-o</CODE> <EM>outputfile</EM> </A>
<DD> Specifies the output file or directory for the compilation of the last
specified <EM>lispfile</EM>.
<P>

<DT> <A NAME="Option -l"> <CODE>-l</CODE> </A>
<DD> A bytecode listing of the files being compiled will be produced.
Useful only for debugging purposes.
<P>

<DT> <A NAME="Option -p"> <CODE>-p</CODE> <EM>packagename</EM> </A>
<DD> At startup the value of the variable <CODE>*package*</CODE> will
be set to the package named <EM>packagename</EM>.
<P>

<DT> <A NAME="Option -x"> <CODE>-x</CODE> <EM>expressions</EM> </A>
<DD> Executes a series of arbitrary expressions instead of a read-eval-print loop.
The values of the expressions will be output to standard output.
Due to the argument processing done by the shell, the <EM>expressions</EM>
must be enclosed in single quotes, and double quotes and backslashes must
be preceded by backslashes.
<P>

<DT> <CODE>@</CODE><EM>optionfile</EM>
<DD> substitutes the contents of <EM>optionfile</EM> as arguments. Each line of
<EM>optionfile</EM> is treated as a separate argument to
<CODE>clisp</CODE>.
<P>
</DL>

<A NAME="Reference">
<H2>Reference</H2>
</A>

The language implemented conforms to

<BLOCKQUOTE>
      Guy L. Steele Jr.: Common Lisp - The Language.
      Digital Press. 1st edition 1984, 465 pages.
      ("CLtL1" for short)
</BLOCKQUOTE>

and to the older parts of
<BLOCKQUOTE>
      Guy L. Steele Jr.: Common Lisp - The Language.
      Digital Press. 2nd edition 1990, 1032 pages.
      ("CLtL2" for short)
</BLOCKQUOTE>

<A NAME="Use">
<H2>Use</H2>
</A>

<DL>

<DT> <CODE>help</CODE>
<DD> to get some on-line help.
<P>

<DT> <CODE>(apropos </CODE><EM>name</EM><CODE>)</CODE>
<DD> lists the symbols relating to <EM>name</EM>.
<P>

<DT> <CODE>(exit)</CODE> or <CODE>(quit)</CODE> or <CODE>(bye)</CODE>
<DD> to quit <CODE>clisp</CODE>.
<P>

<DT>
EOF (Ctrl-Z)
<DD> to leave the current read-eval-print loop.
<P>

<DT> arrow keys
<DD> for editing and viewing the input history.
<P>

<DT> Tab key
<DD> to complete the symbol's name you are just typing.
<P>

</DL>

<A NAME="Files">
<H2>Files</H2>
</A>

<DL>

<DT>
<CODE>lisp.exe</CODE>
<DD> main executable
<P>

<DT>
<CODE>lispinit.mem</CODE>
<DD> initial memory image
<P>

<DT>
<CODE>config.lsp</CODE>
<DD> site-dependent configuration
<P>

<DT>
<CODE>*.lsp</CODE>
<DD> lisp source
<P>

<DT>
<CODE>*.fas</CODE>
<DD> lisp code, compiled by <CODE>clisp</CODE>
<P>

<DT>
<CODE>*.lib</CODE>
<DD> lisp source library information, generated and used by the
<CODE>clisp</CODE> compiler
<P>

<DT>
<CODE>*.c</CODE>
<DD> C code, compiled from lisp source by <CODE>clisp</CODE>
<P>

</DL>

<A NAME="Environment">
<H2>Environment</H2>
</A>

<DT> <CODE>CLISP_LANGUAGE</CODE>
<DD> specifies the language
<CODE>clisp</CODE>
uses to communicate with the user. The value may be
<CODE>english</CODE>, <CODE>deutsch</CODE>, <CODE>francais</CODE>
and defaults to <CODE>english</CODE>.
The <A HREF="#Option -L"><CODE>-L</CODE></A> option can be used to override this environment variable.
<P>

<DT> <CODE>LANG</CODE>
<DD> specifies the language
<CODE>clisp</CODE>
uses to communicate with the user, unless it is already specified through
the environment variable <CODE>CLISP_LANGUAGE</CODE> or the
<A HREF="#Option -L"><CODE>-L</CODE></A> option. The value may begin with
a two-letter ISO 639 language code, for example
<CODE>en</CODE>, <CODE>de</CODE>, <CODE>fr</CODE>.
<P>

<DT>
<CODE>COMSPEC</CODE> (DOS, OS/2 implementations only)
<DD> is used to find the command interpreter called by the function
<CODE>(shell)</CODE>.
<P>

<DT> <CODE>TERM</CODE>
<DD> specifies the terminal emulation <CODE>clisp</CODE>
relies on. If you have ANSI.SYS loaded, possible values are
<CODE>ansi</CODE>, <CODE>ansi-color-2</CODE>, <CODE>ansi-color-3</CODE>
and <CODE>mono</CODE>.
<P>

<DT> <CODE>TERMCAP</CODE>
<DD> should be set to the slashified file name of the terminal capabilities database
<CODE>termcap.dat</CODE>.
<P>

</DL>

<A NAME="See also">
<H2>See also</H2>
</A>

<CODE>cmulisp</CODE>(1), <CODE>emacs</CODE>(1).


<A NAME="Bugs">
<H2>Bugs</H2>
</A>

<UL>
<LI> The function <CODE>inspect</CODE> is not implemented.
<LI> The memory management scheme is not very flexible.
<LI> Not all extensions from CLtL2 are supported.
<LI> No on-line documentation beyond <CODE>apropos</CODE> and <CODE>describe</CODE>
is available.
<LI> Stack overflow aborts the program ungracefully, with a register dump.
<LI> Pressing Control-C may not interrupt <CODE>clisp</CODE> in every situation.
<LI> Calling the function <CODE>execute</CODE> on batch files crashes the machine.
</UL>

<A NAME="Projects">
<H2>Projects</H2>
</A>

<UL>
<LI> Writing on-line documentation.
<LI> Write <CODE>inspect</CODE>.
<LI> Enhance the compiler such that it can inline local functions.
<LI> Specify a portable set of window and graphics operations.
</UL>

<A NAME="Authors">
<H2>Authors</H2>
</A>

Bruno Haible <TT>&lt;haible@ma2s2.mathematik.uni-karlsruhe.de&gt;</TT>
and Michael Stoll.
<P>

<HR>

<ADDRESS>CLISP manual page<BR>
Bruno Haible &lt;haible@ma2s2.mathematik.uni-karlsruhe.de&gt;
</ADDRESS>
<P>
Last modified: 15 June 1995.

</BODY>