[slime-cvs] CVS /slime/doc

[mbaringer]

Update of /project/slime/cvsroot//slime/doc
In directory clnet:/tmp/cvs-serv30317/doc

Modified Files:
	slime.texi 
Log Message:
Document new macroexpansion mode.


--- /project/slime/cvsroot//slime/doc/slime.texi	2005/10/14 18:28:07	1.42
+++ /project/slime/cvsroot//slime/doc/slime.texi	2006/02/27 14:30:32	1.43
@@ -46,7 +46,7 @@
 @end macro
 
 @set EDITION 1.2
- at set UPDATED @code{$Date: 2005/10/14 18:28:07 $}
+ at set UPDATED @code{$Date: 2006/02/27 14:30:32 $}
 
 @titlepage
 @title SLIME User Manual
@@ -123,6 +123,13 @@
 * Inspector::                   
 * Profiling::                   
 
+Programming Helpers
+
+* Completion::                  
+* Macro Expansion::             
+* Accessing Documentation::     
+* Disassembly::                 
+
 REPL: the ``top level''
 
 * REPL commands::               
@@ -140,6 +147,7 @@
 
 * slime-selector::              
 * slime-autodoc-mode::          
+* slime-macroexpansion-minor-mode::  
 * Multiple connections::        
 * Typeout frames::              
 
@@ -166,7 +174,7 @@
 @SLIME{} is the ``Superior Lisp Interaction Mode for Emacs.''
 
 @SLIME{} extends Emacs with new support for interactive programming in
-Common Lisp. The features are centred around @code{slime-mode}, an Emacs
+Common Lisp. The features are centered around @code{slime-mode}, an Emacs
 minor-mode that complements the standard @code{lisp-mode}. While
 @code{lisp-mode} supports editing Lisp source files, @code{slime-mode}
 adds support for interacting with a running Common Lisp process for
@@ -620,6 +628,16 @@
 @node Programming Helpers, Recovery, Documentation, Commands
 @subsection Programming Helpers
 
+ at menu
+* Completion::                  
+* Macro Expansion::             
+* Accessing Documentation::     
+* Disassembly::                 
+ at end menu
+
+ at node Completion, Macro Expansion, Programming Helpers, Programming Helpers
+ at subsubsection Completion
+
 @table @kbd
 @kbditem{M-TAB, slime-complete-symbol}
 Complete the symbol at point. Note that three styles of completion are
@@ -638,10 +656,6 @@
 selected as the method of completion used for
 @code{slime-complete-symbol}.
 
- at kbditem{SPC, slime-space}
-The space key inserts a space and also looks up and displays the
-argument list for the function at point, if there is one.
-
 @kbditem{C-c C-s, slime-complete-form} 
 Looks up and inserts into the current buffer the argument list for the
 function at point, if there is one.  More generally, the command
@@ -669,7 +683,14 @@
 (make-instance 'foo <C-c C-s>
   --inserts--> :bar bar :blub blub initargs...)
 @end example
+ at end table
+
+ at node Macro Expansion, Accessing Documentation, Completion, Programming Helpers
+ at subsubsection Macro Expansion
+
+ at xref{slime-macroexpansion-minor-mode}.
 
+ at table @kbd
 @kbditem{C-c C-m, slime-macroexpand-1}
 Macroexpand the expression at point once.  If invoked with a prefix
 argument, use macroexpand instead of macroexpand-1.
@@ -681,10 +702,23 @@
 Toggle tracing of the function at point.  If invoked with a prefix
 argument, read additional information, like which particular method
 should be traced.
+ at end table
 
+ at node Accessing Documentation, Disassembly, Macro Expansion, Programming Helpers
+ at subsubsection Accessing Documentation
+
+ at table @kbd
+ at kbditem{SPC, slime-space}
+The space key inserts a space and also looks up and displays the
+argument list for the function at point, if there is one.
+ at end table
+
+ at node Disassembly,  , Accessing Documentation, Programming Helpers
+ at subsubsection Disassembly
+
+ at table @kbd
 @kbditem{C-c M-d, slime-disassemble-symbol}
 Disassemble the function definition of the symbol at point.
-
 @end table
 
 @node Recovery, Cross-reference, Programming Helpers, Commands
@@ -1094,6 +1128,7 @@
 @menu
 * slime-selector::              
 * slime-autodoc-mode::          
+* slime-macroexpansion-minor-mode::  
 * Multiple connections::        
 * Typeout frames::              
 @end menu
@@ -1133,7 +1168,7 @@
 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
+ at node slime-autodoc-mode, slime-macroexpansion-minor-mode, slime-selector, Extras
 @section @code{slime-autodoc-mode}
 
 @code{slime-autodoc-mode} is an additional minor-mode for
@@ -1149,7 +1184,26 @@
 (slime-setup :autodoc t)
 @end example
 
- at node Multiple connections, Typeout frames, slime-autodoc-mode, Extras
+ at node slime-macroexpansion-minor-mode, Multiple connections, slime-autodoc-mode, Extras
+ at section slime-macroexpansion-minor-mode
+
+Within a slime macroexpansion buffer some extra commands are provided
+(these commands are always available but are only bound to keys in a
+macroexpansion buffer).
+
+ at table @kbd
+ at kbditem{C-c C-m, slime-macroexpand-1-inplace}
+Just like slime-macroexpand-1 but the original form is replaced with the expansion.
+
+ at kbditem{g, slime-macroexpand-1-inplace}
+The last macroexpansion is performed again, the current contents of
+the macroexpansion buffer are replaced with the new expansion.
+
+ at kbditem{q, slime-temp-buffer-quit}
+Close the expansion buffer.
+ at end table
+
+ at node Multiple connections, Typeout frames, slime-macroexpansion-minor-mode, Extras
 @section Multiple connections
 
 @SLIME{} is able to connect to multiple Lisp processes at the same