summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorArtyom V. Poptsov <poptsov.artyom@gmail.com>2015-12-04 21:37:42 +0300
committerArtyom V. Poptsov <poptsov.artyom@gmail.com>2015-12-04 21:37:42 +0300
commit82b5396a1f1d45c7ea7eebd1544ba8099bcee9a4 (patch)
tree1dc5e7e7904f74d2dc50d573bd1948ee5f3af61c /doc
parentsession.scm: Implement SSH config parsing (diff)
downloadguile-ssh-82b5396a1f1d45c7ea7eebd1544ba8099bcee9a4.tar.gz
channel.scm: Add remote pipes
* modules/ssh/channel.scm (open-remote-pipe, open-remote-pipe*): New procedures. * doc/api-channels.texi: Add "Remote Pipes" section. * NEWS: Update.
Diffstat (limited to 'doc')
-rw-r--r--doc/api-channels.texi17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/api-channels.texi b/doc/api-channels.texi
index 71278d2..6123027 100644
--- a/doc/api-channels.texi
+++ b/doc/api-channels.texi
@@ -8,6 +8,7 @@
@menu
* Channel Management::
+* Remote Pipes::
* Port Forwarding::
* Tunnels::
@end menu
@@ -139,6 +140,22 @@ instruction). The @var{channel} must be open. Return the exist status, or
@code{guile-ssh-error} on error.
@end deffn
+@node Remote Pipes
+@subsection Remote Pipes
+@cindex Remote Pipes
+
+@deffn {Scheme Procedure} open-remote-pipe session command
+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).
+@end deffn
+
+@deffn {Scheme Procedure} open-remote-pipe* session 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).
+@end deffn
+
@node Port Forwarding
@subsection Port Forwarding