clisp (1) - Linux Manuals

clisp: ANSI Common Lisp compiler, interpreter and debugger.

Command to display clisp manual in Linux: $ man 1 clisp

NAME

clisp - ANSI Common Lisp compiler, interpreter and debugger.

SYNOPSIS

clisp [[-h] | [--help]] [--version] [--license] [-help-image] [-B lisp-lib-dir] [-K linking-set] [-M mem-file] [-m memory-size] [-L language] [-N locale-dir] [-Edomain encoding] [[-q] | [--quiet] | [--silent] | [-v] | [--verbose]] [-on-error action] [-repl] [-w] [-I] [[-ansi] | [-traditional]] [-modern] [-p package] [-C] [-norc] [-lp directory...] [-i init-file...] [-c [-l] lisp-file [-o output-file]...] [-x expressions...] [lisp-file [argument...]]

DESCRIPTION

Invokes the Common Lisp[1] interpreter and compiler. When called without arguments, executes the read-eval-print loop[2], in which expressions are in turn READ[3] from the standard input, EVAL[4]uated by the lisp interpreter, and their results are PRINT[5]ed to the standard output. Invoked with -c, compiles the specified lisp files to a platform-independent bytecode which can be executed more efficiently.

OPTIONS

-h
--help

: Displays a help message on how to invoke CLISP[6].

--version

: Displays the CLISP[6] version number, as given by the function LISP-IMPLEMENTATION-VERSION[7], the value of the variable *FEATURES*, as well some other information.

--license

: Displays a summary of the licensing information, the GNU[8] GPL[9].

-help-image

: Displays information about the memory image being invoked: whether is it suitable for scripting as well as the :DOCUMENTATION supplied to EXT:SAVEINITMEM.

-B lisp-lib-dir

: Specifies the installation directory. This is the directory containing the linking sets and other data files. This option is normally not necessary, because the installation directory is already built-in into the clisp executable. Directory lisp-lib-dir can be changed dynamically using the SYMBOL-MACRO[10] *LIB-DIRECTORY*.

-K linking-set

Specifies the linking set to be run. This is a directory (relative to the lisp-lib-dir) containing at least a main executable (runtime) and an initial memory image. Possible values are

base

: the core CLISP[6]

full

: core plus all the modules with which this installation was built, see Section 32.2, lqExternal Modulesrq.

The default is base.

-M mem-file

: Specifies the initial memory image. This must be a memory dump produced by the EXT:SAVEINITMEM function by this clisp runtime. It may have been compressed using GNU[8] gzip[11].

-m memory-size

Sets the amount of memory CLISP[6] tries to grab on startup. The amount may be given as

n
nB

: measured in bytes

n
nW

: measured in machine words (4×n on 32-bit platforms, 8×n on 64-bit platforms)

nK
nKB

: measured in kilobytes

nKW

: measured in kilowords

nM
nMB

: measured in megabytes

nMW

: measured in megawords

The default is 3 megabytes. The argument is constrained above 100 KB.

This version of CLISP[6] is not likely to actually use the entire memory-size since garbage-collection will periodically reduce the amount of used memory. It is therefore common to specify 10 MB even if only 2 MB are going to be used.

-L language

: Specifies the language CLISP[6] uses to communicate with the user. This may be one of english, german, french, spanish, dutch, russian, danish. Other languages may be specified through the environment variable[12] LANG, provided the corresponding message catalog is installed. The language may be changed dynamically using the SYMBOL-MACRO[10] CUSTOM:*CURRENT-LANGUAGE*.

-N locale-dir

: Specifies the base directory of locale files. CLISP[6] will search its message catalogs in locale-dir/language/LC_MESSAGES/clisp.mo. This directory may be changed dynamically using the SYMBOL-MACRO[10] CUSTOM:*CURRENT-LANGUAGE*.

-Edomainencoding

Specifies the encoding used for the given domain, overriding the default which depends on the environment variable[12]s LC_ALL, LC_CTYPE, LANG. domain can be

file

: affecting CUSTOM:*DEFAULT-FILE-ENCODING*

pathname

: affecting CUSTOM:*PATHNAME-ENCODING*

terminal

: affecting CUSTOM:*TERMINAL-ENCODING*

foreign

: affecting CUSTOM:*FOREIGN-ENCODING*

misc

: affecting CUSTOM:*MISC-ENCODING*

blank

: affecting all of the above.

Warning Note that the values of these SYMBOL-MACRO[10]s that have been saved in a memory image are ignored: these SYMBOL-MACRO[10]s are reset based on the OS environment after the memory image is loaded. You have to use the RC file, CUSTOM:*INIT-HOOKS* or init function to set them on startup, but it is best to set the aforementioned environment variable[12]s appropriately for consistency with other programs. See Section 31.1, lqCustomizing CLISP Process Initialization and Terminationrq.

-q
--quiet
--silent
-v
--verbose

: Change verbosity level: by default, CLISP[6] displays a banner at startup and a good-bye message when quitting, and initializes *LOAD-VERBOSE*[13] and *COMPILE-VERBOSE*[14] to T[15], and *LOAD-PRINT*[13] and *COMPILE-PRINT*[14] to NIL[16], as per [ANSI CL standard]. The first -q removes the banner and the good-bye message, the second sets variables *LOAD-VERBOSE*[13], *COMPILE-VERBOSE*[14] and CUSTOM:*SAVEINITMEM-VERBOSE* to NIL[16]. The first -v sets variables CUSTOM:*REPORT-ERROR-PRINT-BACKTRACE*, *LOAD-PRINT*[13] and *COMPILE-PRINT*[14] to T[15], the second sets CUSTOM:*LOAD-ECHO* to T[15]. These settings affect the output produced by -i and -c options. Note that these settings persist into the read-eval-print loop[2]. Repeated -q and -v cancel each other, e.g., -q -q -v -v -v is equivalent to -v.

-on-error action

Override (or force) the batch mode imposed by -c, -x, and lisp-file, depending on action:.PP appease

: continuable[17] ERROR[18]s are turned into WARNING[19]s (with EXT:APPEASE-CERRORS) other ERROR[18]s are handled in the default way

debug

: ERROR[18]s INVOKE-DEBUGGER[20] (the normal read-eval-print loop[2] behavior)

abort

: continuable[17] ERROR[18]s are appeased, other ERROR[18]s are ABORT[21]ed with EXT:ABORT-ON-ERROR

exit

: continuable[17] ERROR[18]s are appeased, other ERROR[18]s terminate CLISP[6] with EXT:EXIT-ON-ERROR

LANGUAGE REFERENCE

The language implemented is ANSI[38][37] Common Lisp[1]. The implementation mostly conforms to the ANSI Common Lisp standard, see Section 31.10, lqMaximum ANSI CL compliancerq.

[ANSI CL] ANSI CL standard1994. ANSI INCITS 226-1994 (R1999) Information Technology - Programming Language - Common Lisp[39] [formerly ANSI X3.226-1994 (R1999)].

USAGE

help

: get context-sensitive on-line help, see Chapter 25, Environment.

(APROPOS name)

: list the SYMBOL[40]s matching name.

(DESCRIBE symbol)

: describe the symbol.

(exit)
(quit)
(bye)

: quit CLISP[6].

EOF (Control+D on UNIX[41])

: leave the current level of the read-eval-print loop[2] (see also Section 1.1, lqSpecial Symbols rq).

arrow keys

: for editing and viewing the input history, using the GNU[8] readline[26] library.

TAB key

Context sensitive:

: *If you are in the lqfunction positionrq (in the first symbol after an opening paren or in the first symbol after a #'[43]), the completion is limited to the symbols that name functions.

: *If you are in the "filename position" (inside a string after #P[44]), the completion is done across file names, bash[45]-style.

: *If you have not typed anything yet, you will get a help message, as if by the help command.

: *If you have not started typing the next symbol (i.e., you are at a whitespace), the current function or macro is DESCRIBEd.

: *Otherwise, the symbol you are currently typing is completed.

FILES

clisp

: startup driver (a script or an executable)

lisp.run
lisp.exe

: main executable (runtime)

lispinit.mem

: initial memory image

config.lisp

: site-dependent configuration (should have been customized before CLISP[6] was built); see Section 31.12, lqCustomizing CLISP behaviorrq

*.lisp

: lisp source

*.fas

: lisp code, compiled by CLISP[6]

*.lib

: lisp source library information, generated by COMPILE-FILE, see Section 24.3, lqFunction REQUIRErq.

*.c

: C code, compiled from lisp source by CLISP[6] (see Section 32.3, lqThe Foreign Function Call Facilityrq)

For the CLISP[6] source files, see Chapter 34, The source files of CLISP.

ENVIRONMENT

All environment variable[12]s that CLISP[6] uses are read at most once.

CLISP_LANGUAGE

: specifies the language CLISP[6] uses to communicate with the user. The legal values are identical to those of the -L option which can be used to override this environment variable[12].

LC_CTYPE

: specifies the locale which determines the character set in use. The value can be of the form language or language_country or language_country.charset, where language is a two-letter ISO 639 language code (lower case), country is a two-letter ISO 3166 country code (upper case). charset is an optional character set specification, and needs normally not be given because the character set can be inferred from the language and country. This environment variable[12] can be overridden with the -Edomain encoding option.

LANG

: specifies the language CLISP[6] uses to communicate with the user, unless it is already specified through the environment variable[12] CLISP_LANGUAGE or the -L option. It also specifies the locale determining the character set in use, unless already specified through the environment variable[12] LC_CTYPE. The value may begin with a two-letter ISO 639 language code, for example en, de, fr.

HOME
USER

: used for determining the value of the function USER-HOMEDIR-PATHNAME[33].

SHELL
COMSPEC

: is used to find the interactive command interpreter called by EXT:SHELL.

TERM

: determines the screen size recognized by the pretty printer.

ORGANIZATION

: for SHORT-SITE-NAME[46] and LONG-SITE-NAME[46] in config.lisp.

CLHSROOT

: for CUSTOM:CLHS-ROOT in config.lisp.

IMPNOTES

: for CUSTOM:IMPNOTES-ROOT in config.lisp.

EDITOR

: for editor-name in config.lisp.

LOGICAL_HOST_host_FROM
LOGICAL_HOST_host_TO
LOGICAL_HOST_host

: for CUSTOM:*LOAD-LOGICAL-PATHNAME-TRANSLATIONS-DATABASE*

BUGS

When you encounter a bug in CLISP[6] or in its documentation (this manual page or CLISP impnotes), please report it to the CLISP[6] SourceForge bug tracker[49].

Before submitting a bug report, please take the following basic steps to make the report more useful:

: 1.Please do a clean build (remove your build directory and build CLISP[6] with ./configure --cbc build or at least do a make distclean before make).

: 2.If you are reporting a lqhard crashrq (segmentation fault, bus error, core dump etc), please do ./configure --with-debug --cbc build-g ; cd build-g; gdb lisp.run, then load the appropriate linking set by either base or full gdb[50] command, and report the backtrace (see also Q: A.1.1.10).

: 3.If you are using pre-built binaries and experience a hard crash, the problem is likely to be in the incompatibilities between the platform on which the binary was built and yours; please try compiling the sources and report the problem if it persists.

When submitting a bug report, please specify the following information:

: 1.What is your platform (uname -a on a UNIX[41] system)? Compiler version? GNU[8] libc[51] version (on GNU[8]/Linux[52])?

: 2.Where did you get the sources or binaries? When? (Absolute dates, e.g., lq2006-01-17rq, are preferred over the relative ones, e.g., lq2 days agorq).