[slime-cvs] CVS slime/doc
jcunningham
jcunningham at common-lisp.net
Tue Jan 16 02:01:26 UTC 2007
Update of /project/slime/cvsroot/slime/doc
In directory clnet:/tmp/cvs-serv18344/slime/doc
Modified Files:
slime.texi
Log Message:
Test check in of doc/slime.texi (jeff cunningham)
--- /project/slime/cvsroot/slime/doc/slime.texi 2006/12/24 13:43:15 1.51
+++ /project/slime/cvsroot/slime/doc/slime.texi 2007/01/16 02:01:26 1.52
@@ -10,7 +10,7 @@
@set EDITION 2.0
@c @set UPDATED @today{}
- at set UPDATED @code{$Date: 2006/12/24 13:43:15 $}
+ at set UPDATED @code{$Date: 2007/01/16 02:01:26 $}
@set TITLE SLIME User Manual
@settitle @value{TITLE}, version @value{EDITION}
@@ -158,7 +158,7 @@
@item
Steel Bank Common Lisp (@acronym{SBCL}), latest official release
@item
-OpenMCL, version 0.14.3
+OpenMCL, version 0.14.3 or newer
@item
LispWorks, version 4.3 or newer
@item
@@ -271,7 +271,7 @@
@iftex
The snippet above also appears in the @file{README} file. You can
copy&paste it from there, but remember to fill in the appropriate
-path.
+paths.
@end iftex
We recommend not loading the @acronym{ILISP} package into Emacs if you
@@ -357,6 +357,10 @@
@node About key bindings, inferior-lisp, Temporary buffers, User-interface conventions
@subsection About key bindings
+A (near) complete list of the default keybindings set by @SLIME{} is
+given in an appendix (@pxref{Index to Key Bindings}), with links to
+their descriptions.
+
In general we try to make our key bindings fit with the overall Emacs
style. We also have the following somewhat unusual convention of our
own: when entering a three-key sequence, the final key can be pressed
@@ -370,19 +374,29 @@
There is one exception to this rule, just to trip you up. We never
bind @kbd{C-h} anywhere in a key sequence, so @kbd{C-c C-d C-h}
doesn't do the same thing as @kbd{C-c C-d h}. This is because Emacs
-has a builtin default so that typing a prefix followed by @kbd{C-h}
+has a built-in default so that typing a prefix followed by @kbd{C-h}
will display all bindings starting with that prefix, so @kbd{C-c C-d
C-h} will actually list the bindings for all documentation commands.
This feature is just a bit too useful to clobber!
-You can assign or change default key bindings using the @code{global-set-key}
+You can assign or change default key bindings globally using the @code{global-set-key}
function in your @file{~/.emacs} file like this:
@example
-(global-set-key "\C-cs" 'slime-selector)
+(global-set-key "\C-c s" 'slime-selector)
@end example
@noindent
which binds @kbd{C-c s} to the function @code{slime-selector}.
+Alternatively, if you want to assign or change a key binding in just a
+particular slime mode, you can use the @code{global-set-key} function in
+your @file{~/.emacs} file like this:
+ at example
+(define-key slime-repl-mode-map (kbd "C-c ;") 'slime-insert-balanced-comments)
+ at end example
+ at noindent
+which binds @kbd{C-c ;} to the function
+ at code{slime-insert-balanced-comments} in the REPL buffer.
+
@c -----------------------
@node inferior-lisp, Multithreading, About key bindings, User-interface conventions
@subsection @code{*inferior-lisp*} buffer
@@ -446,7 +460,7 @@
categories: @strong{Programming, Compilation, Evaluation, Recovery,
Inspector, and Profiling}, discussed in separate sections below. There
are also comprehensive indices to commands by function (@pxref{Index
-to Functions}) and by function (@pxref{Index to Key Bindings}).
+to Functions}) and by key binding (@pxref{Index to Key Bindings}).
@menu
* Programming::
@@ -638,7 +652,7 @@
@SLIME{}'s cross-reference commands are based on the support provided
by the Lisp system, which varies widely between Lisps. For systems
-with no builtin @acronym{XREF} support @SLIME{} queries a portable
+with no built-in @acronym{XREF} support @SLIME{} queries a portable
@acronym{XREF} package, which is taken from the @cite{CMU AI
Repository} and bundled with @SLIME{}.
@@ -667,7 +681,7 @@
Show all known methods specialized on a class.
@fcnanchor{slime-goto-xref}
-Goto the cross-referenced location at point.
+Go to the cross-referenced location at point.
@end table
@@ -706,6 +720,7 @@
@anchor{slime-pop-find-definition-stack}
@item M-,
+ at itemx M-*
@code{slime-pop-find-definition-stack}
Go back to the point where @kbd{M-.} was invoked. This gives multi-level
backtracking when @kbd{M-.} has been used several times.
@@ -1100,16 +1115,22 @@
Go to the beginning of the line, but stop at the @REPL{} prompt.
@anchor{slime-repl-next-input}
- at anchor{slime-repl-next-matching-input}
@anchor{slime-repl-previous-input}
- at anchor{slime-repl-previous-matching-input}
@item M-n
@itemx M-p
+ at code{slime-repl-next-input, slime-repl-previous-input}@*
+Go to next/previous in command history.
+
+ at anchor{slime-repl-next-matching-input}
+ at anchor{slime-repl-previous-matching-input}
@itemx M-s
@itemx M-r
- at code{slime-repl-@{next,previous@}-input}@*
- at code{slime-repl-@{next,previous@}-matching-input}@*
- at code{comint}-style input history commands.
+ at code{slime-repl-next-matching-input, slime-repl-previous-matching-input}@*
+Search forward/reverse through command history with regex
+
+ at c @code{slime-repl-@{next,previous@}-input}@*
+ at c @code{slime-repl-@{next,previous@}-matching-input}@*
+ at c @code{comint}-style input history commands.
@anchor{slime-repl-next-prompt}
@anchor{slime-repl-previous-prompt}
@@ -1139,10 +1160,69 @@
@REPL{} prompt and then enter the shortcut's name when prompted.
Shortcuts deal with things like switching between directories and
-compiling and loading Lisp systems. The exact set of shortcuts is not
-currently documented in this manual, but you can use the @code{help}
+compiling and loading Lisp systems. The set of shortcuts is listed
+below, and you can also use the @code{help}
shortcut to list them interactively.
+ at table @kbd
+ at item change-directory (aka !d, cd)
+Change the current directory.
+
+ at item change-package (aka !p)
+Change the current package.
+
+ at item compile-and-load (aka cl)
+Compile (if neccessary) and load a lisp file.
+
+ at item compile-system
+Compile (but not load) an ASDF system.
+
+ at item defparameter (aka !)
+Define a new global, special, variable.
+
+ at item force-compile-system
+Recompile (but not load) an ASDF system.
+
+ at item force-load-system
+Recompile and load an ASDF system.
+
+ at item help (aka ?)
+Display the help.
+
+ at item load-system
+Compile (as needed) and load an ASDF system.
+
+ at item pop-directory (aka -d)
+Pop the current directory.
+
+ at item pop-package (aka -p)
+Pop the top of the package stack.
+
+ at item push-directory (aka +d, pushd)
+Push a new directory onto the directory stack.
+
+ at item push-package (aka +p)
+Push a package onto the package stack.
+
+ at item pwd
+Show the current directory.
+
+ at item quit
+Quit the current Lisp.
+
+ at item resend-form
+Resend the last form.
+
+ at item restart-inferior-lisp
+Restart *inferior-lisp* and reconnect SLIME.
+
+ at item sayoonara
+Quit all Lisps and close all SLIME buffers.
+
+ at end table
+
+
+
@c -----------------------
@node Debugger, Extras, REPL, Top
@chapter SLDB: the SLIME debugger
@@ -1256,7 +1336,9 @@
Exit @SLDB{} and debug the condition using the Lisp system's default
debugger.
- at c @anchor{slime-interactive-eval}
+ at fcnanchor{in-sldb-face}
+Return STRING propertised with face sldb-NAME-face.
+
@kbditem{C-c :, slime-interactive-eval}
Evaluate an expression entered in the minibuffer.
@end table
@@ -1414,7 +1496,7 @@
Connect to a running Swank server.
@fcnanchor{slime-disconnect}
-Disconnect all connextions.
+Disconnect all connections.
@fcnanchor{slime-connection-list-mode}
Connection-list. @acronym{SLIME} Connection List Mode.
@@ -1541,6 +1623,7 @@
@table @code
+ at fcnanchor{slime-mode-hook}
@item slime-mode-hook
This hook is run each time a buffer enters @code{slime-mode}. It is
most useful for setting buffer-local configuration in your Lisp source
@@ -1621,7 +1704,7 @@
@end table
The default request handling style is chosen according to the
-capabilities your Lisp system. The general order of preference is
+capabilities of your Lisp system. The general order of preference is
@code{:SPAWN}, then @code{:SIGIO}, then @code{:FD-HANDLER}, with
@code{NIL} as a last resort. You can check the default style by
calling @code{SWANK-BACKEND:PREFERRED-COMMUNICATION-STYLE}. You can
@@ -1744,7 +1827,7 @@
Since we're going to be tunneling our connection via
ssh at footnote{there is a way to connect without an ssh tunnel, but it
has the side-effect of giving the entire world access to your lisp
-image, se we're not gonig to talk about it} and we'll only have on
+image, se we're not gonig to talk about it} and we'll only have one
port open we want to tell swank to not use an extra connection for
output:
@@ -1852,7 +1935,7 @@
friends outside of the @REPL{}. If you have any other threads which
call @code{format}, @code{write-string}, etc. that output will be seen
only in the @code{*inferior-lisp*} buffer or on the terminal, more
-often than not this inconvenient. So, if you want code such as this:
+often than not this is inconvenient. So, if you want code such as this:
@example
(run-in-new-thread
@@ -1925,6 +2008,7 @@
@c -----------------------
@node Index to Key Bindings, Index to Functions, Credits, Top
@appendix Index to Key Bindings
+These are the keybindings set by default in Slime.
@table @kbd
@kbdindex{SPC, slime-space}
@@ -1974,7 +2058,7 @@
@kbdindex{M-TAB, slime-complete-symbol}
@kbdindex{M-*, slime-pop-find-definition-stack}
@kbdindex{M-., slime-edit-definition}
- at kbdindex{M-\,, slime-pop-find-definition-stack}
+ at kbdindex{M- at comma{}, slime-pop-find-definition-stack}
@kbdindex{M-n, slime-next-note}
@kbdindex{M-p, slime-previous-note}
@kbdindex{C-M-i, slime-complete-symbol}
@@ -1985,31 +2069,21 @@
@node Index to Functions, , Index to Key Bindings, Top
@appendix Index to Functions
- at c Note: the functions commented out below are in slime.el but as
- at c yet unreferenced (and may or may not be -jkc-).
+These functions are all available (when relevant). To find the
+keybinding (if there is one) refer to the function description.
+
+ at c Note to editors: @fcnindex{...} lines commented out below are place holders
+ at c ----------------
+ at c They have yet to be documented
+ at c Please feel free to add descriptions in the text where appropriate, add the
+ at c appropriate anchors and uncomment them.
+ at c
+ at c [jkc]
+
@table @code
@fcnindex{common-lisp-hyperspec-format}
- at c @fcnindex{sldb-mode-hook}
- at c @fcnindex{slime-mode-hook}
- at c @fcnindex{slime-repl-mode-hook}
- at c @fcnindex{compile}
- at c @fcnindex{compile-defun}
- at c @fcnindex{fboundp}
- at c @fcnindex{def-sldb-face}
- at c @fcnindex{def-sldb-faces}
- at c @fcnindex{def-slime-selector-method}
- at c @fcnindex{def-slime-test}
- at c @fcnindex{define-sldb-invoke-restart-key}
- at c @fcnindex{define-sldb-invoke-restart-keys}
- at c @fcnindex{define-slime-dialect}
- at c @fcnindex{defslime-repl-shortcut}
- at c @fcnindex{destructure-case}
- at c @fcnindex{in-sldb-face}
- at c @fcnindex{inferior-slime-closing-return}
- at c @fcnindex{inferior-slime-indent-line}
- at c @fcnindex{inferior-slime-input-complete-p}
- at c @fcnindex{inferior-slime-return}
+ at fcnindex{in-sldb-face}
@fcnindex{sldb-abort}
@c @fcnindex{sldb-activate}
@c @fcnindex{sldb-add-face}
@@ -2064,6 +2138,7 @@
@c @fcnindex{sldb-list-locals}
@c @fcnindex{sldb-lookup-reference}
@c @fcnindex{sldb-maybe-recenter-region}
+ at c @fcnindex{sldb-mode-hook}
@c @fcnindex{sldb-next}
@c @fcnindex{sldb-out}
@fcnindex{sldb-pprint-eval-in-frame}
@@ -2086,603 +2161,193 @@
@c @fcnindex{sldb-var-number-at-point}
@c @fcnindex{sldb-xemacs-emulate-point-entered-hook}
@c @fcnindex{sldb-xemacs-post-command-hook}
+
+
+ at c @fcnindex{inferior-slime-closing-return}
+ at c @fcnindex{inferior-slime-indent-line}
+ at c @fcnindex{inferior-slime-mode}
+ at c @fcnindex{inferior-slime-return}
@fcnindex{slime-abort-connection}
- at c @fcnindex{slime-accept-process-output}
- at c @fcnindex{slime-activate-font-lock-magic}
- at c @fcnindex{slime-add-face}
- at c @fcnindex{slime-add-presentation-properties}
- at c @fcnindex{slime-after-change-function}
- at c @fcnindex{slime-alistify}
@fcnindex{slime-apropos}
@fcnindex{slime-apropos-all}
@fcnindex{slime-apropos-package}
- at c @fcnindex{slime-apropos-summary} [internal]
@c @fcnindex{slime-arglist}
- at c @fcnindex{slime-arglist-specializers}
- at c @fcnindex{slime-at-top-level-p}
- at c @fcnindex{slime-autodoc} [internal]
- at c @fcnindex{slime-autodoc-global-at-point} [internal]
- at c @fcnindex{slime-autodoc-message} [internal]
- at c @fcnindex{slime-autodoc-message-dimensions} [internal]
- at c @fcnindex{slime-autodoc-message-ok-p} [internal]
@fcnindex{slime-autodoc-mode}
- at c @fcnindex{slime-autodoc-pre-command-refresh-echo-area} [internal]
- at c @fcnindex{slime-autodoc-start-timer} ??
- at c @fcnindex{slime-autodoc-stop-timer} [internal]
- at c @fcnindex{slime-autodoc-thing-at-point} [internal]
- at c @fcnindex{slime-autodoc-timer-hook} [internal]
+ at c @fcnindex{slime-autodoc-start-timer}
@c @fcnindex{slime-background-activities-enabled-p}
@c @fcnindex{slime-background-message}
- at c @fcnindex{slime-batch-test}
- at c @fcnindex{slime-beginning-of-comment} [internal]
- at c @fcnindex{slime-beginning-of-list} [internal]
- at c @fcnindex{slime-beginning-of-symbol} [internal]
- at c @fcnindex{slime-bogus-completion-alist}
@c @fcnindex{slime-browse-classes}
@c @fcnindex{slime-browse-xrefs}
- at c @fcnindex{slime-buffer-substring-with-reified-output}
- at c @fcnindex{slime-busy-p}
- at c @fcnindex{slime-bytecode-stale-p}
@fcnindex{slime-call-defun}
- at c @fcnindex{slime-call-describer}
- at c @fcnindex{slime-call-with-browser-setup}
@fcnindex{slime-calls-who}
- at c @fcnindex{slime-changelog-date}
- at c @fcnindex{slime-cheat-sheet}
- at c @fcnindex{slime-cheat-sheet-table}
- at c @fcnindex{slime-check}
@c @fcnindex{slime-check-coding-system}
- at c @fcnindex{slime-check-connected}
- at c @fcnindex{slime-check-eval-in-emacs-enabled}
- at c @fcnindex{slime-check-sldb-level}
- at c @fcnindex{slime-check-top-level}
- at c @fcnindex{slime-choose-connection}
- at c @fcnindex{slime-choose-overlay-for-sexp}
- at c @fcnindex{slime-choose-overlay-region}
- at c @fcnindex{slime-cl-symbol-external-ref-p}
- at c @fcnindex{slime-cl-symbol-name}
- at c @fcnindex{slime-cl-symbol-package}
@fcnindex{slime-close-all-sexp}
[571 lines skipped]
More information about the slime-cvs
mailing list