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

Fri Apr 16 11:54:04 UTC 2004

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

Modified Files:
	slime.texi 
Log Message:
(Top): The Top node is now smaller, with details moved into
Introduction. This makes the Info front page easier to
navigate. (Patch from Richard M Kreuter.)

Date: Fri Apr 16 07:54:04 2004
Author: lgorrie

Index: slime/doc/slime.texi
diff -u slime/doc/slime.texi:1.7 slime/doc/slime.texi:1.8

--- slime/doc/slime.texi:1.7	Wed Apr 14 15:14:48 2004
+++ slime/doc/slime.texi	Fri Apr 16 07:54:03 2004
@@ -38,7 +38,7 @@
 @end macro
 
 @set EDITION DRAFT
- at set UPDATED @code{$Id: slime.texi,v 1.7 2004/04/14 19:14:48 lgorrie Exp $}
+ at set UPDATED @code{$Id: slime.texi,v 1.8 2004/04/16 11:54:03 lgorrie Exp $}
 
 @titlepage
 @title SLIME User Manual
@@ -51,58 +51,21 @@
 
 @contents
 
- at node Top, Getting started, (dir), (dir)
+ at node Top, Introduction, (dir), (dir)
 
- at c @node Introduction, Getting started, Top, Top
- at chapter Introduction
+ at ifinfo
+ at top SLIME
 
 @SLIME{} is the ``Superior Lisp Interaction Mode for Emacs.''
 
- at SLIME{} extends Emacs with new support interactive programming in
-Common Lisp. The features are centred around @code{slime-mode}, an
-Emacs minor-mode that compliments the standard @code{lisp-mode}. While
- at code{lisp-mode} supports editing Lisp source files, @code{slime-mode}
-adds support for interacting with a running Common Lisp process for
-compilation, debugging, documentation lookup, and so on.
-
-The @code{slime-mode} programming environment follows the example of
-Emacs's native Emacs Lisp environment. We have also included good
-ideas from similar systems (such as @acronym{ILISP}) and some new
-ideas of our own.
-
- at SLIME{} is constructed from two parts: a user-interface written in
-Emacs Lisp, and a supporting server program written in Common
-Lisp. The two sides are connected together with a socket and
-communicate using an @acronym{RPC}-like protocol.
-
-The Lisp server is primarily written in portable Common Lisp. The
-required implementation-specific functionality is specified by a
-well-defined interface and implemented separately for each Lisp
-implementation. This makes @SLIME{} readily portable.
-
- at c @node Status,  , Introduction, Introduction
- at section Status: under development
+Like @SLIME{}, this manual is a work in progress. It documents an
+unreleased version of @SLIME{}.
 
- at SLIME{} is a program under development and has not yet been
-``released.'' Unlike many other free software projects, we are not
-making ``0.x'' releases, but instead evolving directly towards a
-``1.0'' release. We find this continuous style of development very
-comfortable, so rather than setting short-term milestones we've taken
-to merrily hacking away as @SLIME{} progresses towards a ``final''
-shape at its own pace.
-
-We warmly invite Lisp hackerdom to join in the development in any way
-you like. As frugal hospitality we offer access to the @CVS{} tree and
-a cosy mailing list, but not yet such luxuries as supported tarballs,
-a snazzy website, or guarantees of backward-compatibility.
-
-We hope that nowadays @SLIME{} is suitable for doing ``real work''
-with. To make support easy we do expect @SLIME{} users to keep fairly
-up-to-date with the current code-base, so an adventurous nature is an
-advantage. For people looking for something to just install and not
-have to upgrade or muck about with, we ain't yet it.
+For a list of hackers who've worked on @SLIME{}, @ref{Credits}.
 
+ at end ifinfo
 @menu
+* Introduction::                
 * Getting started::             
 * slime-mode::                  
 * REPL::                        
@@ -152,6 +115,7 @@
 
 * REPL commands::               
 * Input Navigation::            
+* Shortcuts::                   
 
 @SLDB{}: the @SLIME{} debugger
 
@@ -183,7 +147,56 @@
 @end detailmenu
 @end menu
 
- at node Getting started, slime-mode, Top, Top
+ at node Introduction, Getting started, Top, Top
+ at chapter Introduction
+
+ at SLIME{} is the ``Superior Lisp Interaction Mode for Emacs.''
+
+ at SLIME{} extends Emacs with new support interactive programming in
+Common Lisp. The features are centred around @code{slime-mode}, an
+Emacs minor-mode that compliments the standard @code{lisp-mode}. While
+ at code{lisp-mode} supports editing Lisp source files, @code{slime-mode}
+adds support for interacting with a running Common Lisp process for
+compilation, debugging, documentation lookup, and so on.
+
+The @code{slime-mode} programming environment follows the example of
+Emacs's native Emacs Lisp environment. We have also included good
+ideas from similar systems (such as @acronym{ILISP}) and some new
+ideas of our own.
+
+ at SLIME{} is constructed from two parts: a user-interface written in
+Emacs Lisp, and a supporting server program written in Common
+Lisp. The two sides are connected together with a socket and
+communicate using an @acronym{RPC}-like protocol.
+
+The Lisp server is primarily written in portable Common Lisp. The
+required implementation-specific functionality is specified by a
+well-defined interface and implemented separately for each Lisp
+implementation. This makes @SLIME{} readily portable.
+
+ at c @node Status,  , Introduction, Introduction
+ at section Status: under development
+
+ at SLIME{} is a program under development and has not yet been
+``released.'' Unlike many other free software projects, we are not
+making ``0.x'' releases, but instead evolving directly towards a
+``1.0'' release. We find this continuous style of development very
+comfortable, so rather than setting short-term milestones we've taken
+to merrily hacking away as @SLIME{} progresses towards a ``final''
+shape at its own pace.
+
+We warmly invite Lisp hackerdom to join in the development in any way
+you like. As frugal hospitality we offer access to the @CVS{} tree and
+a cosy mailing list, but not yet such luxuries as supported tarballs,
+a snazzy website, or guarantees of backward-compatibility.
+
+We hope that nowadays @SLIME{} is suitable for doing ``real work''
+with. To make support easy we do expect @SLIME{} users to keep fairly
+up-to-date with the current code-base, so an adventurous nature is an
+advantage. For people looking for something to just install and not
+have to upgrade or muck about with, we ain't yet it.
+
+ at node Getting started, slime-mode, Introduction, Top
 @chapter Getting started
 
 This chapter tells you how to get @SLIME{} up and running.
@@ -727,6 +740,7 @@
 @menu
 * REPL commands::               
 * Input Navigation::            
+* Shortcuts::                   
 @end menu
 
 @node REPL commands, Input Navigation, REPL, REPL
@@ -761,7 +775,7 @@
 
 @end table
 
- at node Input Navigation,  , REPL commands, REPL
+ at node Input Navigation, Shortcuts, REPL commands, REPL
 @section Input navigation
 
 @table @kbd
@@ -791,7 +805,8 @@
 
 @end table
 
- at node Shortcuts
+ at comment  node-name,  next,  previous,  up
+ at node Shortcuts,  , Input Navigation, REPL
 @section Shortcuts
 
 ``Shortcuts'' are a special set of @REPL{} commands that are invoked



