[slime-cvs] CVS slime/doc
heller
heller at common-lisp.net
Mon Sep 17 13:44:48 UTC 2007
Update of /project/slime/cvsroot/slime/doc
In directory clnet:/tmp/cvs-serv18363
Modified Files:
slime.texi
Log Message:
Add keystroke, variable indices and use the built-in command index.
Disable the previous function index.
--- /project/slime/cvsroot/slime/doc/slime.texi 2007/09/16 16:41:56 1.56
+++ /project/slime/cvsroot/slime/doc/slime.texi 2007/09/17 13:44:48 1.57
@@ -1,33 +1,41 @@
-\input texinfo @c -*-texinfo-*-
- at c %**start of header
- at setfilename slime.info
+\input texinfo
+- at c %**start of header
+ at setfilename slime.info
@settitle The Superior Lisp Interaction Mode for Emacs
+
@dircategory Emacs
@direntry
* SLIME: (slime). Superior Lisp Interaction Mode for Emacs.
@end direntry
- at c %**end of header
+- at c %**end of header
@set EDITION 3.0-alpha
+ at set SLIMEVER 3.0-alpha
@c @set UPDATED @today{}
- at set UPDATED @code{$Date: 2007/09/16 16:41:56 $}
+ at set UPDATED @code{$Date: 2007/09/17 13:44:48 $}
@set TITLE SLIME User Manual
@settitle @value{TITLE}, version @value{EDITION}
+ at copying
+Written by Luke Gorrie.
+
+Additional contributions: Jeff Cunningham,
+
+This file has been placed in the public domain.
+ at end copying
+
@titlepage
@title @value{TITLE}
@titlefont{version @value{EDITION}}
@sp 2
- at image{slime-small}
+ at center @image{slime-small}
@sp 4
@subtitle Compiled: @value{UPDATED}
- at end titlepage
- at c Written by Luke Gorrie.
- at c
- at c Additional contributions: Jeff Cunningham,
- at c
- at c This file has been placed in the public domain.
+ at page
+ at insertcopying
+
+ at end titlepage
@macro SLIME
@@ -48,13 +56,26 @@
@macro kbditem{key, command}
@item \key\
- at code{\command\}@*
+ at itemx M-x \command\
+ at kindex \key\
+ at findex \command\
+ at c
@end macro
- at macro kbdanchor{key, command}
- at anchor{\command\}
- at item \key\
- at code{\command\}@*
+ at macro kbditempair{key1, key2, command1, command2}
+ at item \key1\, M-x \command1\
+ at itemx \key2\, M-x \command2\
+ at kindex \key1\
+ at kindex \key2\
+ at findex \command1\
+ at findex \command2\
+ at c
+ at end macro
+
+ at macro cmditem{command}
+ at item M-x \command\
+ at findex \command\
+ at c
@end macro
@macro kbdanchorc{key, command, comment}
@@ -64,35 +85,25 @@
@i{\comment\}@*
@end macro
- at macro kbdindex{key, command}
- at item \key\
- at xref{\command\}.
- at end macro
-
- at macro fcnanchor{name}
- at anchor{\name\}
- at item M-x
- at code{\name\}@*
- at end macro
-
@macro fcnindex{name}
@item \name\
@xref{\name\}.
@end macro
@c @setchapternewpage off
+ at c @shortcontents
@contents
- at c -----------------------
- at node Top, Introduction, (dir), (dir)
-
- at ifinfo
+ at ifnottex
+ at node Top
@top SLIME
@SLIME{} is the ``Superior Lisp Interaction Mode for Emacs''. This is
-the manual for version 3.0-alpha.
+the manual for version @value{SLIMEVER}.
+
+ at insertcopying
+ at end ifnottex
- at end ifinfo
@menu
* Introduction::
* Getting started::
@@ -103,11 +114,14 @@
* Customization::
* Tips and Tricks::
* Credits::
-* Index to Functions::
+ at c * Index to Functions::
+* Key Index::
+* Command Index::
+* Variable Index::
@end menu
@c -----------------------
- at node Introduction, Getting started, Top, Top
+ at node Introduction
@chapter Introduction
@SLIME{} is the ``Superior Lisp Interaction Mode for Emacs.''
@@ -135,7 +149,7 @@
implementation. This makes @SLIME{} readily portable.
@c -----------------------
- at node Getting started, slime-mode, Introduction, Top
+ at node Getting started
@chapter Getting started
This chapter tells you how to get @SLIME{} up and running.
@@ -269,7 +283,9 @@
With a Lisp implementation that can be started from the command-line,
installation just requires a few lines in your @file{~/.emacs}:
- at example
+ at vindex inferior-lisp-program
+ at vindex load-path
+ at example
(setq inferior-lisp-program "@emph{the path to your Lisp system}")
(add-to-list 'load-path "@emph{the path of your @file{slime} directory}")
(require 'slime)
@@ -301,7 +317,7 @@
You can restart the @code{inferior-lisp} process using the function:
@table @kbd
- at fcnanchor{slime-restart-inferior-lisp}
+ at cmditem{slime-restart-inferior-lisp}
@end table
@node Setup Tuning
@@ -351,6 +367,7 @@
@code{slime-lisp-implementations} variable in your @file{.emacs}. For
example here we define two programs:
+ at vindex slime-lisp-implementations
@lisp
(setq slime-lisp-implementations
'((cmucl ("cmucl" "-quiet"))
@@ -429,9 +446,7 @@
@subsection Loading Contribs
... to be written ...
- at c -----------------------
- at node slime-mode, REPL, Getting started, Top
- at c @chapter @code{slime-mode}
+ at node slime-mode
@chapter Using slime-mode
@SLIME{}'s commands are provided via @code{slime-mode}, a minor-mode
@@ -447,7 +462,7 @@
@end menu
@c -----------------------
- at node User-interface conventions, Key bindings, slime-mode, slime-mode
+ at node User-interface conventions
@section User-interface conventions
To use @SLIME{} comfortably it is important to understand a few
@@ -461,7 +476,7 @@
@end menu
@c -----------------------
- at node Temporary buffers, Inferior-lisp, User-interface conventions, User-interface conventions
+ at node Temporary buffers
@subsection Temporary buffers
Some @SLIME{} commands create temporary buffers to display their
@@ -487,7 +502,7 @@
function definitions, and so on.
@c -----------------------
- at node Inferior-lisp, Multithreading, Temporary buffers, User-interface conventions
+ at node Inferior-lisp
@subsection @code{*inferior-lisp*} buffer
@SLIME{} internally uses the @code{comint} package to start Lisp
@@ -503,7 +518,7 @@
@code{*inferior-lisp*} buffer.
@c -----------------------
- at node Multithreading, , Inferior-lisp, User-interface conventions
+ at node Multithreading
@subsection Multithreading
If the Lisp system supports multithreading, SLIME spawns a new thread
@@ -530,7 +545,7 @@
@end example
@c -----------------------
- at node Key bindings, Commands, User-interface conventions, slime-mode
+ at node Key bindings
@section Key bindings
@quotation
@@ -555,8 +570,11 @@
@kbdanchorc{C-h l, view-lossage, ``Woah at comma{} what key chord did I just do?''}
Shows you the literal sequence of keys you've pressed in order.
- at kbdanchorc{<key> l, , ``What starts with?''}
-Lists all keybindings that begin with @code{<key>} for the focus buffer mode.
+
+ at c <key> is breaks links PDF, despite that it's not l it's C-h
+ at c @kbdanchorc{ <key> l, , ``What starts with?''}
+ at c Lists all keybindings that begin with @code{<key>} for the focus buffer mode.
+
@end table
@@ -611,14 +629,14 @@
@code{slime-insert-balanced-comments} in the REPL buffer.
@c -----------------------
- at node Commands, Semantic indentation, Key bindings, slime-mode
+ at node Commands
@section Commands
@acronym{SLIME} commands are divided into the following general
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}).
+are also comprehensive indices to commands by function
+(@pxref{Command Index}).
@menu
* Programming::
@@ -631,7 +649,7 @@
@end menu
@c -----------------------
- at node Programming, Compilation, , Commands
+ at node Programming
@subsection Programming commands
Programming commands are divided into the following categories:
@@ -651,7 +669,7 @@
@end menu
@c -----------------------
- at node Completion, Closure, , Programming
+ at node Completion
@subsubsection Completion commands
Completion commands are used to complete a symbol or form based on
@@ -660,18 +678,15 @@
completion tries harder.
@table @kbd
- at anchor{slime-complete-symbol}
- at item M-TAB
+ at kbditem{M-TAB,slime-complete-symbol}
@itemx ESC TAB
@itemx C-c C-i
@itemx C-M-i
- at code{slime-complete-symbol}@* Complete the symbol at point. Note that
-three styles of completion are available in @SLIME{}, and the default
-differs from normal Emacs completion
-(@pxref{slime-complete-symbol-function}). @xref{Emacs-side
-customization}.
+Complete the symbol at point. Note that three styles of completion are
+available in @SLIME{}, and the default differs from normal Emacs
+completion (@pxref{slime-complete-symbol-function}).
- at kbdanchor{C-c C-s, slime-complete-form}
+ at 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
completes an incomplete form with a template for the missing arguments.
@@ -699,7 +714,8 @@
--inserts--> :bar bar :blub blub initargs...)
@end example
- at kbdanchor{C-c M-i, slime-fuzzy-complete-symbol}
+ at anchor{slime-fuzzy-complete-symbol}
+ at kbditem{C-c M-i, slime-fuzzy-complete-symbol}
Presents a list of likely completions to choose from for an
abbreviation at point. This is a third completion method and it is
very different from the more traditional completion to which
@@ -710,24 +726,24 @@
selected as the method of completion used for
@code{slime-complete-symbol}.
- at fcnanchor{slime-fuzzy-completions-mode}
- at fcnanchor{slime-fuzzy-abort}
+ at cmditem{slime-fuzzy-completions-mode}
+ at cmditem{slime-fuzzy-abort}
@end table
@c -----------------------
- at node Closure, Indentation, Completion, Programming
+ at node Closure
@subsubsection Closure commands
Closure commands are used to fill in missing parenthesis.
@table @kbd
- at kbdanchor{C-c C-q, slime-close-parens-at-point}
+ at kbditem{C-c C-q, slime-close-parens-at-point}
Closes parentheses at point to complete the top-level-form by inserting ')'
characters at until @code{beginning-of-defun} and @code{end-of-defun}
execute without errors, or @code{slime-close-parens-limit} is exceeded.
- at kbdanchor{C-], slime-close-all-sexp}
+ at kbditem{C-], slime-close-all-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
@@ -739,11 +755,11 @@
@c -----------------------
- at node Indentation, Documentation, Closure, Programming
+ at node Indentation
@subsubsection Indentation commands
@table @kbd
- at kbdanchor{C-c M-q, slime-reindent-defun}
+ at kbditem{C-c M-q, slime-reindent-defun}
Re-indents the current defun, or refills the current paragraph.
If point is inside a comment block, the text around point will be
treated as a paragraph and will be filled with @code{fill-paragraph}.
@@ -751,7 +767,7 @@
will be reindented. If the current defun has unbalanced parens,
an attempt will be made to fix it before reindenting.
- at kbdanchor{C-M-q, indent-sexp}
+ at kbditem{C-M-q, indent-sexp}
Indents the list immediately following point to match the level at point.
When given a prefix argument, the text around point will always
@@ -760,7 +776,7 @@
@c -----------------------
- at node Documentation, Cross-reference, Indentation, Programming
+ at node Documentation
@subsubsection Documentation commands
@SLIME{}'s online documentation commands follow the example of Emacs
@@ -769,31 +785,31 @@
@table @kbd
- at kbdanchor{SPC, slime-space}
+ at kbditem{SPC, 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.
- at kbdanchor{C-c C-d d, slime-describe-symbol}
+ at kbditem{C-c C-d d, slime-describe-symbol}
Describe the symbol at point.
[1045 lines skipped]
More information about the slime-cvs
mailing list