summaryrefslogtreecommitdiff
path: root/doc/ref/scheme-scripts.texi
diff options
context:
space:
mode:
authorAndy Wingo <wingo@pobox.com>2010-10-11 23:53:40 +0200
committerAndy Wingo <wingo@pobox.com>2010-10-11 23:53:40 +0200
commitf88dae81fe9dce0fd4af531899631ec070d10ea6 (patch)
treee94669d61cd7e21608fa0861275ffd387f8d232e /doc/ref/scheme-scripts.texi
parent9322905ce786b7240fc6243214d80bc8f08cfe95 (diff)
downloadguile-f88dae81fe9dce0fd4af531899631ec070d10ea6.tar.gz
add --listen docs
* doc/ref/scheme-scripts.texi (Invoking Guile): Add --listen documentation.
Diffstat (limited to 'doc/ref/scheme-scripts.texi')
-rw-r--r--doc/ref/scheme-scripts.texi22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/ref/scheme-scripts.texi b/doc/ref/scheme-scripts.texi
index 8d47746cb..5a151a4fd 100644
--- a/doc/ref/scheme-scripts.texi
+++ b/doc/ref/scheme-scripts.texi
@@ -189,6 +189,28 @@ interactive session. When executing a script with @code{-s} or
Do not use the debugging VM engine, even when entering an interactive
session.
+@item --listen[=@var{p}]
+While this program runs, listen on a local port or a path for REPL
+clients. If @var{p} starts with a number, it is assumed to be a local
+port on which to listen. If it starts with a forward slash, it is
+assumed to be a path to a UNIX domain socket on which to listen.
+
+If @var{p} is not given, the default is local port 37146. If you look
+at it upside down, it almost spells ``Guile''. If you have netcat
+installed, you should be able to @kbd{nc localhost 37146} and get a
+Guile prompt. Alternately you can fire up Emacs and connect to the
+procedure; see @ref{Using Guile in Emacs} for more details.
+
+Note that opening a port allows anyone who can connect to that port---in
+the TCP case, any local user---to do anything Guile can do, as the user
+that the Guile process is running as. Don't use @option{--listen} on
+multi-user machines. Of course, if there is no @option{--listen}
+argument, no port will be opened.
+
+That said, @code{--listen} is great for interactive debugging and
+development.
+
+@vnew{2.0}
@item -h@r{, }--help
Display help on invoking Guile, and then exit.