summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorArtyom V. Poptsov <poptsov.artyom@gmail.com>2015-12-06 11:34:12 +0300
committerArtyom V. Poptsov <poptsov.artyom@gmail.com>2015-12-06 11:34:12 +0300
commitf2ec537aba8dc124c97dde8718b95a7d81474242 (patch)
tree586e205fdd001d2faeba67556036b208d76448e5 /doc
parentlibguile-ssh/channel-type.c (print_channel): Improve (diff)
downloadguile-ssh-f2ec537aba8dc124c97dde8718b95a7d81474242.tar.gz
channel.scm: Implement I/O pipes
* modules/ssh/channel.scm (open-remote-pipe, open-remote-pipe*): Accept pipe MODE as an argument. (open-remote-input-pipe, open-remote-input-pipe*) (open-remote-output-pipe, open-remote-output-pipe*): New procedures. * doc/api-channels.texi: Update description of remote pipes.
Diffstat (limited to 'doc')
-rw-r--r--doc/api-channels.texi23
1 files changed, 17 insertions, 6 deletions
diff --git a/doc/api-channels.texi b/doc/api-channels.texi
index 43725e9..cd4bde4 100644
--- a/doc/api-channels.texi
+++ b/doc/api-channels.texi
@@ -148,16 +148,27 @@ instruction). The @var{channel} must be open. Return the exist status, or
@subsection Remote Pipes
@cindex Remote Pipes
-@deffn {Scheme Procedure} open-remote-pipe session command
+@deffn {Scheme Procedure} open-remote-pipe session command mode
Execute a @var{command} on the remote host using a @var{session} with a pipe
-to it. The pipe works in both directions. Returns newly created port
-(channel).
+to it. Returns newly created channel port with the specified @var{mode}.
@end deffn
-@deffn {Scheme Procedure} open-remote-pipe* session prog [args...]
+@deffn {Scheme Procedure} open-remote-pipe* session mode prog [args...]
Execute @var{prog} on the remote host with the given @var{args} using a
-@var{session} with a pipe to it. The pipe works in both directions. Returns
-newly created port (channel).
+@var{session} with a pipe to it. Returns newly created channel port with the
+specified @var{mode}.
+@end deffn
+
+@deffn {Scheme Procedure} open-remote-input-pipe session command
+@deffnx {Scheme Procedure} open-remote-input-pipe* session prog [args...]
+Equvalent to @code{open-remote-pipe} and @code{open-remote-pipe*} respectively
+with mode @code{OPEN_READ}.
+@end deffn
+
+@deffn {Scheme Procedure} open-remote-output-pipe session command
+@deffnx {Scheme Procedure} open-remote-output-pipe session prog [args...]
+Equvalent to @code{open-remote-pipe} and @code{open-remote-pipe*} respectively
+with mode @code{OPEN_WRITE}.
@end deffn
@node Port Forwarding