[slime-cvs] CVS update: slime/doc/slime.texi

[Luke Gorrie]

Update of /project/slime/cvsroot/slime/doc
In directory common-lisp.net:/tmp/cvs-serv29659

Modified Files:
	slime.texi 
Log Message:
(slime-selector): New section.
(Inspector): Updated for the post-1.0 inspector.

Date: Thu Mar 31 22:21:08 2005
Author: lgorrie

Index: slime/doc/slime.texi
diff -u slime/doc/slime.texi:1.33 slime/doc/slime.texi:1.34
--- slime/doc/slime.texi:1.33	Sun Mar 27 21:06:31 2005
+++ slime/doc/slime.texi	Thu Mar 31 22:21:08 2005
@@ -46,7 +46,7 @@
 @end macro
 
 @set EDITION 1.2
- at set UPDATED @code{$Date: 2005/03/27 19:06:31 $}
+ at set UPDATED @code{$Date: 2005/03/31 20:21:08 $}
 
 @titlepage
 @title SLIME User Manual
@@ -109,6 +109,7 @@
 * Temporary buffers::           
 * Key bindings::                
 * inferior-lisp::               
+* Multithreading::              
 
 Commands
 
@@ -137,6 +138,7 @@
 
 Extras
 
+* slime-selector::              
 * slime-autodoc-mode::          
 * Multiple connections::        
 * Typeout frames::              
@@ -363,7 +365,7 @@
 * Temporary buffers::           
 * Key bindings::                
 * inferior-lisp::               
-* Multithreading::
+* Multithreading::              
 @end menu
 
 @node Temporary buffers, Key bindings, User-interface conventions, User-interface conventions
@@ -412,7 +414,7 @@
 C-h} will actually list the bindings for all documentation commands.
 This feature is just a bit too useful to clobber!
 
- at node inferior-lisp,  Multithreading, Key bindings, User-interface conventions
+ at node inferior-lisp, Multithreading, Key bindings, User-interface conventions
 @subsection @code{*inferior-lisp*} buffer
 
 @SLIME{} internally uses the @code{inferior-lisp} package to start
@@ -439,7 +441,7 @@
 doesn't belong to @SLIME{}, and you should probably lookup our
 equivalent.
 
- at node Multithreading, , inferior-lisp, User-interface conventions
+ at node Multithreading,  , inferior-lisp, User-interface conventions
 @subsection Multithreading
 
 If the Lisp system supports multithreading, SLIME spawns a new thread
@@ -562,6 +564,7 @@
 @kbditem{C-c :, slime-interactive-eval}
 Evaluate an expression read from the minibuffer.
 
+ at anchor{slime-scratch}
 @item M-x slime-scratch
 Create a @file{*slime-scratch*} buffer. In this
 buffer you can enter Lisp expressions and evaluate them with
@@ -725,19 +728,25 @@
 @node Inspector, Profiling, Cross-reference, Commands
 @subsection Inspector
 
-The @SLIME{} inspector is an Emacs-based version of the Lisp function
- at code{INSPECT} which uses an Emacs buffer to display, navigate and
-operate on lisp objects.
-
-The inspector can be adapted to new objects by defining an appropiate
-method on the generic function @code{SWANK:INSPECT-FOR-EMACS}.
+The @SLIME{} inspector is a very fancy Emacs-based alternative to the
+standard @code{INSPECT} function. The inspector presents objects in
+Emacs buffers using a combination of plain text, hyperlinks to related
+objects, and ``actions'' that can be selected to invoke Lisp code on
+the inspected object. For example, to present a generic function the
+inspector shows the documentation in plain text and presents each
+method with both a hyperlink to inspect the method object and a
+``remove method'' action that you can invoke interactively.
+
+The inspector can easily be specialized for the objects in your own
+programs. For details see the the @code{inspect-for-emacs} generic
+function in @file{swank-backend.lisp}.
 
 @table @kbd
 @kbditem{C-c I, slime-inspect}
 Inspect the value of an expression entered in the minibuffer.
 @end table
 
-The commands available in the inspector are:
+The standard commands available in the inspector are:
 
 @table @kbd
 
@@ -1055,12 +1064,48 @@
 @chapter Extras
 
 @menu
+* slime-selector::              
 * slime-autodoc-mode::          
 * Multiple connections::        
 * Typeout frames::              
 @end menu
 
- at node slime-autodoc-mode, Multiple connections, Extras, Extras
+ at node slime-selector, slime-autodoc-mode, Extras, Extras
+ at section @code{slime-selector}
+
+The @code{slime-selector} is for quickly switching to important
+buffers: the @REPL{}, @SLDB{}, the Lisp source you were just hacking,
+etc. Once invoked the command prompts for a single letter to specify
+which buffer it should display. Here are some of the options:
+
+ at table @kbd
+ at item ?
+A help buffer listing all @code{slime-selectors}'s available buffers.
+ at item r
+The @REPL{} buffer for the current @SLIME{} connection.
+ at item d
+The most recently activated @SLDB{} buffer for the current connection.
+ at item l
+The most recently visited @code{lisp-mode} source buffer.
+ at item s
+The @code{*slime-scratch*} buffer. @xref{slime-scratch}.
+ at end table
+
+ at code{slime-selector} doesn't have a key binding by default but we
+suggest that you assign it a global one. You can bind @kbd{C-c s} like
+this:
+
+ at example
+(global-set-key "\C-cs" 'slime-selector)
+ at end example
+
+And then you can switch to the @REPL{} from anywhere with @kbd{C-c s
+r}.
+
+The macro @code{def-slime-selector-method} can be used to define new
+buffers for @code{slime-selector} to find.
+
+ at node slime-autodoc-mode, Multiple connections, slime-selector, Extras
 @section @code{slime-autodoc-mode}
 
 @code{slime-autodoc-mode} is an additional minor-mode for