The slime Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The slime Reference Manual

This is the slime Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 09:21:39 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

Build Status MELPA MELPA Stable

Overview

SLIME is the Superior Lisp Interaction Mode for Emacs.

SLIME extends Emacs with support for interactive programming in Common Lisp. The features are centered around slime-mode, an Emacs minor-mode that complements the standard lisp-mode. While lisp-mode supports editing Lisp source files, slime-mode adds support for interacting with a running Common Lisp process for compilation, debugging, documentation lookup, and so on.

For much more information, consult the manual.

Quick setup instructions

  1. Set up the MELPA repository, if you haven't already, and install SLIME using M-x package-install RET slime RET.

  2. Add the following lines to your ~/.emacs file, filling in in the appropriate filenames:

    ;; Set your lisp system and, optionally, some contribs
    (setq inferior-lisp-program "/opt/sbcl/bin/sbcl")
    (setq slime-contribs '(slime-fancy))
    
  3. Use M-x slime to fire up and connect to an inferior Lisp. SLIME will now automatically be available in your Lisp source buffers.

If you'd like to contribute to SLIME, you will want to instead follow the manual's instructions on how to install SLIME via Git.

Contribs

SLIME comes with additional contributed packages or "contribs". Contribs can be selected via the slime-contribs list.

The most-often used contrib is slime-fancy, which primarily installs a popular set of other contributed packages. It includes a better REPL, and many more nice features.

License

SLIME is free software. All files, unless explicitly stated otherwise, are public domain.

Contact

If you have problems, first have a look at the list of known issues and workarounds.

Questions and comments are best directed to the mailing list at slime-devel@common-lisp.net, but you have to subscribe first. The mailing list archive is also available on Gmane.

See the CONTRIBUTING.md file for instructions on how to contribute.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 swank

Source

swank.asd (file)

Component

swank-loader.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 swank.asd

Location

swank.asd

Systems

swank (system)

Internal Definitions

swank-loader-file (class)


Previous: , Up: Lisp files   [Contents][Index]

3.1.2 swank/swank-loader.lisp

Parent

swank (system)

Location

swank-loader.lisp

Packages

swank-loader

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 swank-loader

Source

swank-loader.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *fasl-directory*

The directory where fasl files should be placed.

Package

swank-loader

Source

swank-loader.lisp (file)

Special Variable: *source-directory*

The directory where to look for the source.

Package

swank-loader

Source

swank-loader.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: dump-image FILENAME
Package

swank-loader

Source

swank-loader.lisp (file)

Function: init &key DELETE RELOAD LOAD-CONTRIBS SETUP QUIET

Load SWANK and initialize some global variables.
If DELETE is true, delete any existing SWANK packages.
If RELOAD is true, reload SWANK, even if the SWANK package already exists. If LOAD-CONTRIBS is true, load all contribs
If SETUP is true, load user init files and initialize some
global variabes in SWANK.

Package

swank-loader

Source

swank-loader.lisp (file)

Function: list-fasls &key INCLUDE-CONTRIBS COMPILE QUIET

List up SWANK’s fasls along with their dependencies.

Package

swank-loader

Source

swank-loader.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *architecture-features*
Package

swank-loader

Source

swank-loader.lisp (file)

Special Variable: *contribs*

List of names for contrib modules.

Package

swank-loader

Source

swank-loader.lisp (file)

Special Variable: *implementation-features*
Package

swank-loader

Source

swank-loader.lisp (file)

Special Variable: *os-features*
Package

swank-loader

Source

swank-loader.lisp (file)

Special Variable: *swank-files*
Package

swank-loader

Source

swank-loader.lisp (file)

Special Variable: *sysdep-files*
Package

swank-loader

Source

swank-loader.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

Function: append-dir ABSOLUTE NAME
Package

swank-loader

Source

swank-loader.lisp (file)

Function: binary-pathname SRC-PATHNAME BINARY-DIR

Return the pathname where SRC-PATHNAME’s binary should be compiled.

Package

swank-loader

Source

swank-loader.lisp (file)

Function: compile-contribs &key SRC-DIR FASL-DIR SWANK-SRC-DIR LOAD QUIET
Package

swank-loader

Source

swank-loader.lisp (file)

Function: compile-files FILES FASL-DIR LOAD QUIET

Compile each file in FILES if the source is newer than its corresponding binary, or the file preceding it was recompiled. If LOAD is true, load the fasl file.

Package

swank-loader

Source

swank-loader.lisp (file)

Function: contrib-dir BASE-DIR
Package

swank-loader

Source

swank-loader.lisp (file)

Function: default-fasl-dir ()
Package

swank-loader

Source

swank-loader.lisp (file)

Function: delete-packages PACKAGES
Package

swank-loader

Source

swank-loader.lisp (file)

Function: delete-stale-contrib-fasl-files SWANK-FILES CONTRIB-FILES FASL-DIR
Package

swank-loader

Source

swank-loader.lisp (file)

Function: file-newer-p NEW-FILE OLD-FILE

Returns true if NEW-FILE is newer than OLD-FILE.

Package

swank-loader

Source

swank-loader.lisp (file)

Function: handle-swank-load-error CONDITION CONTEXT PATHNAME
Package

swank-loader

Source

swank-loader.lisp (file)

Function: lisp-version-string ()
Package

swank-loader

Source

swank-loader.lisp (file)

Function: list-swank-packages ()
Package

swank-loader

Source

swank-loader.lisp (file)

Function: load-site-init-file DIR
Package

swank-loader

Source

swank-loader.lisp (file)

Function: load-swank &key SRC-DIR FASL-DIR QUIET
Package

swank-loader

Source

swank-loader.lisp (file)

Function: load-user-init-file ()

Load the user init file, return NIL if it does not exist.

Package

swank-loader

Source

swank-loader.lisp (file)

Function: loadup ()
Package

swank-loader

Source

swank-loader.lisp (file)

Function: q S
Package

swank-loader

Source

swank-loader.lisp (file)

Function: setup ()
Package

swank-loader

Source

swank-loader.lisp (file)

Function: slime-version-string ()

Return a string identifying the SLIME version. Return nil if nothing appropriate is available.

Package

swank-loader

Source

swank-loader.lisp (file)

Function: src-files NAMES SRC-DIR
Package

swank-loader

Source

swank-loader.lisp (file)

Function: string-starts-with STRING PREFIX
Package

swank-loader

Source

swank-loader.lisp (file)

Function: unique-dir-name ()

Return a name that can be used as a directory name that is unique to a Lisp implementation, Lisp implementation version, operating system, and hardware architecture.

Package

swank-loader

Source

swank-loader.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Classes

Class: swank-loader-file ()
Package

swank-loader

Source

swank.asd

Direct superclasses

cl-source-file (class)

Direct methods

perform (method)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   S  
Index Entry  Section

F
File, Lisp, swank.asd: The swank<dot>asd file
File, Lisp, swank/swank-loader.lisp: The swank/swank-loader<dot>lisp file

L
Lisp File, swank.asd: The swank<dot>asd file
Lisp File, swank/swank-loader.lisp: The swank/swank-loader<dot>lisp file

S
swank.asd: The swank<dot>asd file
swank/swank-loader.lisp: The swank/swank-loader<dot>lisp file

Jump to:   F   L   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   A   B   C   D   F   H   I   L   Q   S   U  
Index Entry  Section

A
append-dir: Internal functions

B
binary-pathname: Internal functions

C
compile-contribs: Internal functions
compile-files: Internal functions
contrib-dir: Internal functions

D
default-fasl-dir: Internal functions
delete-packages: Internal functions
delete-stale-contrib-fasl-files: Internal functions
dump-image: Exported functions

F
file-newer-p: Internal functions
Function, append-dir: Internal functions
Function, binary-pathname: Internal functions
Function, compile-contribs: Internal functions
Function, compile-files: Internal functions
Function, contrib-dir: Internal functions
Function, default-fasl-dir: Internal functions
Function, delete-packages: Internal functions
Function, delete-stale-contrib-fasl-files: Internal functions
Function, dump-image: Exported functions
Function, file-newer-p: Internal functions
Function, handle-swank-load-error: Internal functions
Function, init: Exported functions
Function, lisp-version-string: Internal functions
Function, list-fasls: Exported functions
Function, list-swank-packages: Internal functions
Function, load-site-init-file: Internal functions
Function, load-swank: Internal functions
Function, load-user-init-file: Internal functions
Function, loadup: Internal functions
Function, q: Internal functions
Function, setup: Internal functions
Function, slime-version-string: Internal functions
Function, src-files: Internal functions
Function, string-starts-with: Internal functions
Function, unique-dir-name: Internal functions

H
handle-swank-load-error: Internal functions

I
init: Exported functions

L
lisp-version-string: Internal functions
list-fasls: Exported functions
list-swank-packages: Internal functions
load-site-init-file: Internal functions
load-swank: Internal functions
load-user-init-file: Internal functions
loadup: Internal functions

Q
q: Internal functions

S
setup: Internal functions
slime-version-string: Internal functions
src-files: Internal functions
string-starts-with: Internal functions

U
unique-dir-name: Internal functions

Jump to:   A   B   C   D   F   H   I   L   Q   S   U  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*architecture-features*: Internal special variables
*contribs*: Internal special variables
*fasl-directory*: Exported special variables
*implementation-features*: Internal special variables
*os-features*: Internal special variables
*source-directory*: Exported special variables
*swank-files*: Internal special variables
*sysdep-files*: Internal special variables

S
Special Variable, *architecture-features*: Internal special variables
Special Variable, *contribs*: Internal special variables
Special Variable, *fasl-directory*: Exported special variables
Special Variable, *implementation-features*: Internal special variables
Special Variable, *os-features*: Internal special variables
Special Variable, *source-directory*: Exported special variables
Special Variable, *swank-files*: Internal special variables
Special Variable, *sysdep-files*: Internal special variables

Jump to:   *  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
Class, swank-loader-file: Internal classes

P
Package, swank-loader: The swank-loader package

S
swank: The swank system
swank-loader: The swank-loader package
swank-loader-file: Internal classes
System, swank: The swank system

Jump to:   C   P   S