aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ssh/doc/src/ssh_sftp.xml
diff options
context:
space:
mode:
authorHans Nilsson <[email protected]>2014-11-18 14:49:45 +0100
committerHans Nilsson <[email protected]>2014-11-18 14:49:45 +0100
commit2feb7638d47f2d1012871de3040fa7d50f058e3a (patch)
tree16cb88e6b0a432b7a574d713e325b81a5a91b05d /lib/ssh/doc/src/ssh_sftp.xml
parent9366932892711cc4cce7a54b1e098e6d5c3db468 (diff)
parent0c6532f8068d0f748fefd3dd0fb41907f1255844 (diff)
downloadotp-2feb7638d47f2d1012871de3040fa7d50f058e3a.tar.gz
otp-2feb7638d47f2d1012871de3040fa7d50f058e3a.tar.bz2
otp-2feb7638d47f2d1012871de3040fa7d50f058e3a.zip
Merge branch 'hans/ssh/erl_tar_sftp/OTP-12180' into maint
* hans/ssh/erl_tar_sftp/OTP-12180: ssh: update vsn.mk ssh: Add ssh_sftp:open_tar/3,4 which opens a tar file at the server side of a channel. erl_tar: Extend api to define own storage media access functions.
Diffstat (limited to 'lib/ssh/doc/src/ssh_sftp.xml')
-rw-r--r--lib/ssh/doc/src/ssh_sftp.xml18
1 files changed, 18 insertions, 0 deletions
diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml
index f1091e9eca..251f5a4be3 100644
--- a/lib/ssh/doc/src/ssh_sftp.xml
+++ b/lib/ssh/doc/src/ssh_sftp.xml
@@ -194,6 +194,24 @@
can be used for reading directory contents.</p>
</desc>
</func>
+
+ <func>
+ <name>open_tar(ChannelPid, Path) -></name>
+ <name>open_tar(ChannelPid, Path, Timeout) -> {ok, Handle} | {error, Reason}</name>
+ <fsummary>Open a tar file on the server to which <v>ChannelPid</v> is connected and return a handle</fsummary>
+ <type>
+ <v>ChannelPid = pid()</v>
+ <v>Path = string()</v>
+ <v>Timeout = timeout()</v>
+ <v>Reason = term()</v>
+ </type>
+ <desc>
+ <p>Opens a handle to a tar file on the server, the handle
+ can be used for remote tar manipulation as defined by the
+ <seealso marker="stdlib:erl_tar#init/3">erl_tar:init/3</seealso> function.</p>
+ </desc>
+ </func>
+
<func>
<name>close(ChannelPid, Handle) -> </name>
<name>close(ChannelPid, Handle, Timeout) -> ok | {error, Reason}</name>