[slime-cvs] CVS slime/doc
CVS User trittweiler
trittweiler at common-lisp.net
Thu Feb 26 21:50:00 UTC 2009
Update of /project/slime/cvsroot/slime/doc
In directory cl-net:/tmp/cvs-serv31780/doc
Modified Files:
slime.texi
Log Message:
* doc/slime.texi: Fix typos, and add keybindings not listed there.
Patch by Stas Boukarev.
--- /project/slime/cvsroot/slime/doc/slime.texi 2009/01/10 12:21:09 1.68
+++ /project/slime/cvsroot/slime/doc/slime.texi 2009/02/26 21:50:00 1.69
@@ -12,7 +12,7 @@
@set EDITION 3.0-alpha
@set SLIMEVER 3.0-alpha
@c @set UPDATED @today{}
- at set UPDATED @code{$Date: 2009/01/10 12:21:09 $}
+ at set UPDATED @code{$Date: 2009/02/26 21:50:00 $}
@set TITLE SLIME User Manual
@settitle @value{TITLE}, version @value{EDITION}
@@ -503,9 +503,12 @@
(sbcl ("/opt/sbcl/bin/sbcl") :coding-system utf-8-unix)))
@end lisp
+ at vindex slime-default-lisp
This variable holds a list of programs and if you invoke @SLIME{} with
a negative prefix argument, @kbd{M-- M-x slime}, you can select a
-program from that list. The elements of the list should look like
+program from that list. When called without a prefix, either the name
+specified in @code{slime-default-lisp}, or the first item of the list will be used.
+The elements of the list should look like
@lisp
(NAME (PROGRAM PROGRAM-ARGS...) &key CODING-SYSTEM INIT INIT-FUNCTION ENV)
@@ -520,7 +523,7 @@
@item PROGRAM-ARGS
is a list of command line arguments.
@item CODING-SYSTEM
-the coding system for the connection. (@pxref{slime-net-coding-system})
+the coding system for the connection. (@pxref{slime-net-coding-system})x
@item INIT
should be a function which takes two arguments: a filename and a
character encoding. The function should return a Lisp expression as a
@@ -687,7 +690,7 @@
makes it sometimes difficult to change the printer or reader behaviour
for new threads. The variable
@code{swank:*default-worker-thread-bindings*} was introduced for such
-situtuations: instead of modifying the global value of a variable, add a
+situations: instead of modifying the global value of a variable, add a
binding the @code{swank:*default-worker-thread-bindings*}. E.g., with
the following code, new threads will read floating point values as
doubles by default:
@@ -749,7 +752,7 @@
@end table
@emph{Note:} In this documentation the designation @kbd{C-h} is a
- at dfn{cannonical key} which might actually mean Ctrl-h, or F1, or
+ at dfn{canonical key} which might actually mean Ctrl-h, or F1, or
whatever you have @code{help-command} bound to in your
@code{.emacs}. Here is a common situation:
@@ -852,11 +855,11 @@
@cindex Compiling Functions
@kbditem{C-c C-c, slime-compile-defun}
Compile the top-level form at point. The region blinks shortly to
-give some feedback which part was choosen.
+give some feedback which part was chosen.
With (positive) prefix argument the form is compiled with maximal
-debug settings. With negative prefix argument it is compiled for
-speed.
+debug settings (@kbd{C-u C-c C-c}). With negative prefix argument it is compiled for
+speed (@kbd{M-- C-c C-c}).
The code for the region is executed after compilation. In principle,
the command writes the region to a file, compiles that file, and loads
@@ -864,8 +867,8 @@
@kbditem{C-c C-k, slime-compile-and-load-file}
Compile and load the current buffer's source file. If the compilation
-step failes, the file is not loaded. It's not always easy to tell
-whether the compilation failed: occasionaly you may end up in the
+step fails, the file is not loaded. It's not always easy to tell
+whether the compilation failed: occasionally you may end up in the
debugger during the load step.
@kbditem{C-c M-k, slime-compile-file}
@@ -896,7 +899,7 @@
@kbditem{C-x `, next-error}
Visit the next-error message. This is not actually a @SLIME{} command
but @SLIME{} creates a hidden buffer so that most of the Compilation
-mode commands (@inforef{Compilation Mode,, emacs}) work similarily for
+mode commands (@inforef{Compilation Mode,, emacs}) work similarly for
Lisp as for batch compilers.
@end table
@@ -948,7 +951,7 @@
backtracking when @kbd{M-.} has been used several times.
@kbditem{C-x 4 ., slime-edit-definition-other-window}
-Like @code{slime-edit-definition} but switchs to the other window to
+Like @code{slime-edit-definition} but switches to the other window to
edit the definition in.
@kbditem{C-x 5 ., slime-edit-definition-other-frame}
@@ -1027,6 +1030,10 @@
the key bindings as shown here or with the control modified on the
last key, @xref{Key bindings}.
+ at menu
+* Xref buffer commands::
+ at end menu
+
@table @kbd
@kbditem{C-c C-w c, slime-who-calls}
Show function callers.
@@ -1066,6 +1073,25 @@
@end table
+ at node Xref buffer commands
+ at subsection Xref buffer commands
+Commands available in Xref buffers
+ at table @kbd
+
+ at kbditem{RET, slime-show-xref}
+Show definition at point in the other window. Do not leave Xref buffer.
+
+ at kbditem{Space, slime-goto-xref}
+Show definition at point in the other window and close Xref buffer.
+
+ at kbditem{C-c C-c, slime-recompile-xref}
+Recompile definition at point.
+
+ at kbditem{C-c C-c, slime-recompile-all-xrefs}
+Recompile all definitions.
+
+ at end table
+
@c -----------------------
@node Macro-expansion
@section Macro-expansion commands
@@ -1084,7 +1110,7 @@
Display the compiler-macro expansion of sexp at point.
@cmditem{slime-compiler-macroexpand}
-Repeatedy expamd compiler macros of sexp at point.
+Repeatedy expand compiler macros of sexp at point.
@end table
@@ -1163,7 +1189,7 @@
@table @kbd
@kbditem{RET, slime-inspector-operate-on-point}
-If point is on a value then recursivly call the inspcetor on that
+If point is on a value then recursively call the inspector on that
value. If point is on an action then call that action.
@kbditem{d, slime-inspector-describe}
@@ -1179,13 +1205,27 @@
@kbditem{n, slime-inspector-next}
The inverse of @kbd{l}. Also bound to @kbd{SPC}.
+ at kbditem{g, slime-inspector-reinspect}
+Reinspect.
+
@kbditem{q, slime-inspector-quit}
Dismiss the inspector buffer.
+ at kbditem{p, slime-inspector-pprint}
+Pretty print in another buffer object at point.
+
+ at kbditem{., slime-inspector-show-source}
+Find source of object at point.
+
@kbditem{M-RET, slime-inspector-copy-down}
Store the value under point in the variable `*'. This can
then be used to access the object in the REPL.
+ at kbditempair{TAB, S-TAB, slime-inspector-next-inspectable-object,
+slime-inspector-previous-inspectable-object}
+
+Jump to the next and previous inspectable object respectively.
+
@end table
@c -----------------------
@@ -1327,6 +1367,10 @@
@kbditem{i, sldb-inspect-in-frame}
Inspect the result of evaluating an expression in the frame.
+
+ at kbditem{C-c C-c, sldb-recompile-frame-source}
+Recompile frame. @kbd{C-u C-c C-c} for recompiling with maximum debug settings.
+
@end table
@c -----------------------
@@ -1381,11 +1425,11 @@
are reachable from the current code location.
@kbditem{x, sldb-next}
-[Step to the next form in the current function.]
+Step to the next form in the current function.
- at kbditem{o, sldb-next}
-[Stop single-stepping temporarily, but resume it once the current
-function returns.]
+ at kbditem{o, sldb-out}
+Stop single-stepping temporarily, but resume it once the current
+function returns.
@end table
@@ -1407,8 +1451,12 @@
Exit @SLDB{} and debug the condition using the Lisp system's default
debugger.
+ at kbditem{C, sldb-inspect-condition}
+Inspect the condition currently being debugged.
+
@kbditem{:, slime-interactive-eval}
Evaluate an expression entered in the minibuffer.
+
@end table
@@ -1480,6 +1528,9 @@
@kbditem{q, slime-temp-buffer-quit}
Close the expansion buffer.
+ at kbditem{C-_, slime-macroexpand-undo}
+Undo last macroexpansion operation.
+
@end table
@c -----------------------
@@ -1594,7 +1645,7 @@
@item slime-filename-translations
This variable controls filename translation between Emacs and the Lisp
system. It is useful if you run Emacs and Lisp on separate machines
-which don't share a common file system or if they share the filessytem
+which don't share a common file system or if they share the filesystem
but have different layouts, as is the case with @acronym{SMB}-based
file sharing.
@@ -1845,7 +1896,7 @@
@end example
inside a running lisp image at footnote{@SLIME{} also provides an
- at acronym{ASDF} system definiton which does the same thing}. Now all we
+ at acronym{ASDF} system definition which does the same thing}. Now all we
need to do is startup our swank server. The first example assumes we're
using the default settings.
@@ -1938,17 +1989,17 @@
NFS or similar, the remote machine's hard disk on the local machine's
file system in such a fashion that a filename like
@file{/opt/project/source.lisp} refers to the same file on both
-machines. Unfortunetly NFS is usually slow, often buggy, and not
-always feasable, fortunetely we have an ssh connection and Emacs'
+machines. Unfortunately NFS is usually slow, often buggy, and not
+always feasible, fortunately we have an ssh connection and Emacs'
@code{tramp-mode} can do the rest.
(See @inforef{Top, TRAMP User Manual,tramp}.)
What we do is teach Emacs how to take a filename on the remote machine
and translate it into something that tramp can understand and access
-(and vice-versa). Assuming the remote machine's host name is
+(and vice versa). Assuming the remote machine's host name is
@code{remote.example.com}, @code{cl:machine-instance} returns
``remote'' and we login as the user ``user'' we can use @SLIME{}'s
-built-in mechanism to setup the proper transaltions by simply doing:
+built-in mechanism to setup the proper translations by simply doing:
@example
(push (slime-create-filename-translator :machine-instance "remote.example.com"
@@ -2073,7 +2124,7 @@
@end itemize
To load the REPL call @code{(slime-setup '(slime-repl))} in your
- at code{./emacs}.
+ at code{.emacs}.
@table @kbd
@@ -2106,6 +2157,9 @@
Close any unmatched parenthesis and then evaluate the current input in
Lisp. Also bound to @kbd{M-RET}.
+ at kbditem{TAB, slime-indent-and-complete-symbol}
+Indent the current line and perform symbol completion.
+
@kbditem{C-j, slime-repl-newline-and-indent}
Open and indent a new line.
@@ -2193,16 +2247,18 @@
@item change-directory (aka !d, cd)
Change the current directory.
- at item change-package (aka !p)
+ at item change-package (aka !p, in, in-package)
Change the current package.
@item compile-and-load (aka cl)
-Compile (if neccessary) and load a lisp file.
-
+Compile (if necessary) and load a lisp file.
@item defparameter (aka !)
Define a new global, special, variable.
+ at item disconnect
+Disconnect all connections.
+
@item help (aka ?)
Display the help.
@@ -2227,7 +2283,6 @@
@item resend-form
Resend the last form.
-
@item restart-inferior-lisp
Restart *inferior-lisp* and reconnect SLIME.
@@ -2298,7 +2353,7 @@
point should be placed after completion. E.g. the possible
completions for @code{f-o} are @code{finish-output} and
@code{force-output}. By the default point is moved after the
- at code{f}, because that is the unambigous prefix. If
+ at code{f}, because that is the unambiguous prefix. If
@code{slime-c-p-c-unambiguous-prefix-p} is nil, point moves to
the end of the inserted text, after the @code{o} in this case.
@@ -2404,7 +2459,7 @@
Autodoc mode is an additional minor-mode for automatically showing
information about symbols near the point. For function names the
argument list is displayed, and for global variables, the value.
-This is a clone of @code{eldoc-mode} for Emacs Lisp.
+Autodoc is implemented by means of @code{eldoc-mode} of Emacs.
The mode can be enabled by default in the @code{slime-setup} call of your
@code{~/.emacs}:
@@ -2463,7 +2518,7 @@
@vindex slime-startup-animation
@vindex slime-header-line-p
By setting the variable @code{slime-startup-animation} to nil you can
-disable the animation respectivly with the
+disable the animation respectively with the
variable @code{slime-header-line-p} the header line.
@node Editing Commands
@@ -2481,7 +2536,7 @@
will be reindented. If the current defun has unbalanced parens,
an attempt will be made to fix it before reindenting.
- at cmditem{slime-close-all-parens-in-sexp}
+ at kbditem{C-c C-], slime-close-all-parens-in-sexp}
Balance parentheses of open s-expressions at point.
Insert enough right parentheses to balance unmatched left parentheses.
Delete extra left parentheses. Reformat trailing parentheses
@@ -2711,7 +2766,7 @@
@node Xref and Class Browser
@section Xref and Class Browser
-A rudimentary class browser is provied by
+A rudimentary class browser is provided by
the @code{slime-xref-browser} package.
@table @kbd
@@ -2732,7 +2787,7 @@
@code{slime-highlight-edits} is a minor mode to highlight those
regions in a Lisp source file which are modified. This is useful to
-quickly find those functions which need to be recompiled (whith
+quickly find those functions which need to be recompiled (with
@kbd{C-c C-c})
@table @kbd
@@ -2807,7 +2862,7 @@
Martin's initial work on the LispWorks backend!
@ignore
-This index is currently ingored, because texinfo's built-in indexing
+This index is currently ignored, because texinfo's built-in indexing
produces nicer results. -- Helmut Eller
@c at node Index to Functions
More information about the slime-cvs
mailing list