3.6 Documentation commands

SLIME’s online documentation commands follow the example of Emacs Lisp. The commands all share the common prefix C-c C-d and allow the final key to be modified or unmodified (see Key bindings.)

SPC

M-x slime-space

The space key inserts a space, but also looks up and displays the argument list for the function at point, if there is one.

C-c C-d d

M-x slime-describe-symbol

Describe the symbol at point.

C-c C-d f

M-x slime-describe-function

Describe the function at point.

C-c C-d A

M-x slime-apropos

Perform an apropos search on Lisp symbol names for a regular expression match and display their documentation strings. By default the external symbols of all packages are searched. With a prefix argument you can choose a specific package and whether to include unexported symbols.

C-c C-d z

M-x slime-apropos-all

Like slime-apropos but also includes internal symbols by default.

C-c C-d p

M-x slime-apropos-package

Show apropos results of all symbols in a package. This command is for browsing a package at a high-level. With package-name completion it also serves as a rudimentary Smalltalk-ish image-browser.

C-c C-d h

M-x slime-hyperspec-lookup

Lookup the symbol at point in the Common Lisp Hyperspec. This uses the familiar hyperspec.el to show the appropriate section in a web browser. The Hyperspec is found either on the Web or in common-lisp-hyperspec-root, and the browser is selected by browse-url-browser-function.

Note: this is one case where C-c C-d h is not the same as C-c C-d C-h.

C-c C-d ~

M-x hyperspec-lookup-format

Lookup a format character in the Common Lisp Hyperspec.

C-c C-d #

M-x hyperspec-lookup-reader-macro

Lookup a reader macro in the Common Lisp Hyperspec.