diff options
| author | Artyom V. Poptsov <poptsov.artyom@gmail.com> | 2015-12-06 14:22:18 +0300 |
|---|---|---|
| committer | Artyom V. Poptsov <poptsov.artyom@gmail.com> | 2015-12-06 14:22:18 +0300 |
| commit | 7a3e6f80d25dcd32e2eb6158ac3191c129946ed9 (patch) | |
| tree | 9d04878245bb8cbef7a77bef4298ee1fa65416bc | |
| parent | popen.scm: New module (diff) | |
| download | guile-ssh-7a3e6f80d25dcd32e2eb6158ac3191c129946ed9.tar.gz | |
doc/api-popen.texi: Add to the repository
* doc/api-popen.texi: Add to the repository.
* doc/Makefile.am (guile_ssh_TEXINFOS): Add 'api-popen.texi'.
* doc/api-channels.texi: Move description of remote pipes to 'api-popen.texi'.
* doc/guile-ssh.texi: Add reference to "Remote Pipes" node.
* doc/version.texi: Update.
| -rw-r--r-- | doc/Makefile.am | 1 | ||||
| -rw-r--r-- | doc/api-channels.texi | 34 | ||||
| -rw-r--r-- | doc/api-popen.texi | 41 | ||||
| -rw-r--r-- | doc/guile-ssh.texi | 3 | ||||
| -rw-r--r-- | doc/version.texi | 4 |
5 files changed, 47 insertions, 36 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index e168c55..b50c77d 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -13,6 +13,7 @@ guile_ssh_TEXINFOS = \ api-version.texi \ api-dist.texi \ api-sftp.texi \ + api-popen.texi \ examples.texi \ fdl.texi \ indices.texi diff --git a/doc/api-channels.texi b/doc/api-channels.texi index 7af82a3..3f1ae86 100644 --- a/doc/api-channels.texi +++ b/doc/api-channels.texi @@ -8,7 +8,6 @@ @menu * Channel Management:: -* Remote Pipes:: * Port Forwarding:: * Tunnels:: @end menu @@ -144,39 +143,6 @@ 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 - -@code{(ssh channel)} provides API for working with remote pipes, akin to -@code{(ice-9 popen)} procedures. - -@var{mode} argument allows to specify what kind of pipe should be created. -Allowed values are: @code{OPEN_READ}, @code{OPEN_WRITE}, @code{OPEN_BOTH}. - -@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. Returns newly created channel port with the specified @var{mode}. -@end deffn - -@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. 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 @subsection Port Forwarding diff --git a/doc/api-popen.texi b/doc/api-popen.texi new file mode 100644 index 0000000..ccde3c0 --- /dev/null +++ b/doc/api-popen.texi @@ -0,0 +1,41 @@ +@c -*-texinfo-*- +@c This file is part of Guile-SSH Reference Manual. +@c Copyright (C) 2015 Artyom V. Poptsov +@c See the file guile-ssh.texi for copying conditions. + +@node Remote Pipes +@section Remote Pipes +@cindex remote pipes + +@code{(ssh popen)} provides API for working with remote pipes, akin to +@code{(ice-9 popen)} procedures. + +@var{mode} argument allows to specify what kind of pipe should be created. +Allowed values are: @code{OPEN_READ}, @code{OPEN_WRITE}, @code{OPEN_BOTH}. + +@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. Returns newly created channel port with the specified @var{mode}. +@end deffn + +@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. 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 + +@c Local Variables: +@c TeX-master: "guile-ssh.texi" +@c End: diff --git a/doc/guile-ssh.texi b/doc/guile-ssh.texi index 8789e8e..af37995 100644 --- a/doc/guile-ssh.texi +++ b/doc/guile-ssh.texi @@ -139,6 +139,8 @@ and it will give you a suggestion. * Auth:: Authentication procedures * Keys:: Public and private keys * Channels:: Channel manipulation procedures +* Remote Pipes:: Creating of input, output or bidirectional pipes to remote + processes * Logging:: Interface to the libssh logging * Version:: Get information about versions @@ -164,6 +166,7 @@ Distributed Computing @include api-version.texi @include api-dist.texi @include api-sftp.texi +@include api-popen.texi @include examples.texi diff --git a/doc/version.texi b/doc/version.texi index 2373b1c..5a749d5 100644 --- a/doc/version.texi +++ b/doc/version.texi @@ -1,4 +1,4 @@ -@set UPDATED 1 November 2015 -@set UPDATED-MONTH November 2015 +@set UPDATED 6 December 2015 +@set UPDATED-MONTH December 2015 @set EDITION 0.8.0 @set VERSION 0.8.0 |
