[slime-cvs] CVS slime/doc

[heller]

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

Modified Files:
	slime.texi 
Log Message:
Documentation patch for swank:create-server 
from Ury Marshak <urym at two-bytes.com>.


--- /project/slime/cvsroot/slime/doc/slime.texi	2006/09/20 18:37:47	1.48
+++ /project/slime/cvsroot/slime/doc/slime.texi	2006/11/21 21:58:47	1.49
@@ -34,7 +34,7 @@
 @end macro
 
 @set EDITION 2.0
- at set UPDATED @code{$Date: 2006/09/20 18:37:47 $}
+ at set UPDATED @code{$Date: 2006/11/21 21:58:47 $}
 
 @titlepage
 @title SLIME User Manual
@@ -1460,10 +1460,8 @@
 
 inside a running lisp image at footnote{@SLIME{} also provides an
 @acronym{ASDF} system definiton which does the same thing}. Now all we
-need to do is startup our swank server. This example assumes we're
-using the default settings, if you need to do anything particular
-(like be able to reconnect to swank after you're done, look into
- at code{swank:create-server}'s other arguments).
+need to do is startup our swank server. The first example assumes we're
+using the default settings.
 
 @example
 (swank:create-server)
@@ -1480,6 +1478,38 @@
 (setf swank:*use-dedicated-output-stream* nil)
 @end example
 
+If you need to do anything particular
+(like be able to reconnect to swank after you're done), look into
+ at code{swank:create-server}'s other arguments. Some of these arguments
+are
+ at table @code
+
+ at item :PORT
+Port number for the server to listen on (default: 4005).
+ at item :STYLE
+See @xref{Communication style}.
+ at item :DONT-CLOSE
+Boolean indicating if the server will continue to accept connections
+after the first one (default: @code{NIL}). For ``long-running'' lisp processes
+to which you want to be able to connect from time to time,
+specify @code{:dont-close t}
+ at item :CODING-SYSTEM
+String designating the encoding to be used to communicate between the
+Emacs and Lisp.
+ at end table
+
+So the more complete example will be
+ at example
+(swank:create-server :port 4005  :dont-close t :coding-system "utf-8-unix")
+ at end example
+On the emacs side you will use something like
+ at example
+(setq slime-net-coding-system 'utf-8-unix)
+(slime-connect "127.0.0.1" 4005))
+ at end example
+to connect to this lisp image from the same machine.
+
+
 @node Setting up Emacs
 @subsection Setting up Emacs