diff options
| author | Artyom V. Poptsov <poptsov.artyom@gmail.com> | 2015-10-17 11:43:52 +0300 |
|---|---|---|
| committer | Artyom V. Poptsov <poptsov.artyom@gmail.com> | 2015-10-17 11:43:52 +0300 |
| commit | 0042710555ad7f807b2b430f86bde177a4d3cda4 (patch) | |
| tree | 26b62d09ff8e2c3d83fa550cfd0e5fe1697544d8 /doc/api-dist.texi | |
| parent | node.scm (run-rrepl-server, rrepl-running?): Rename (diff) | |
| download | guile-ssh-0042710555ad7f807b2b430f86bde177a4d3cda4.tar.gz | |
api-dist.texi: Update
* doc/api-dist.texi: Update description of 'make-node'. Add description of
'node-run-server', 'node-guile-version', 'node-server-running?'.
Diffstat (limited to 'doc/api-dist.texi')
| -rw-r--r-- | doc/api-dist.texi | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/doc/api-dist.texi b/doc/api-dist.texi index a8e0ff6..c6dcc8f 100644 --- a/doc/api-dist.texi +++ b/doc/api-dist.texi @@ -23,9 +23,13 @@ instead of @code{#<unspecified>}. Node management procedures: -@deffn {Scheme Procedure} make-node session [repl-port=37146] +@deffn {Scheme Procedure} make-node session [repl-port=37146] [#:start-repl-server?=#t] Make a new node that uses an SSH @var{session} to connect to a @var{repl-port} number on the remote side. Return a new node. + +If @var{start-repl-server?} is set to @code{#t} (which is by default) then +start a REPL server on a remote host automatically in case when it is not +started yet. @end deffn @deffn {Scheme Procedure} node? x @@ -153,6 +157,20 @@ on another node. Open a remote REPL (RREPL). Return a new RREPL channel. @end deffn +@deffn {Scheme Procedure} node-run-server node +Run a REPL server on a @var{node}. +@end deffn + +@deffn {Scheme Procedure} node-guile-version node +Get Guile version installed on a @var{node}, return the version string. +Return @code{#f} if Guile is not installed. +@end deffn + +@deffn {Scheme Procedure} node-server-running? node +Check if a REPL server is running on a @var{node}, return @code{#t} if it is +running and listens on an expected port, return @code{#f} otherwise. +@end deffn + @deffn {Scheme Procedure} rrepl-eval rrepl-channel expr Evaluate expression @var{expr} using @var{rrepl-channel}, return four values: an evaluation result, a number of the evaluation, a module name and a language |
