aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ssh/doc/src/ssh_sftp.xml
diff options
context:
space:
mode:
authorHans Nilsson <[email protected]>2014-11-10 17:14:01 +0100
committerHans Nilsson <[email protected]>2014-11-18 14:48:16 +0100
commit0f660bdf34f4c04367febffc95bad63ee9016299 (patch)
treec4352f4831735113965b772939f840022b6265c3 /lib/ssh/doc/src/ssh_sftp.xml
parentb2171f6bf65c5897d37103afec102fa565bc134e (diff)
downloadotp-0f660bdf34f4c04367febffc95bad63ee9016299.tar.gz
otp-0f660bdf34f4c04367febffc95bad63ee9016299.tar.bz2
otp-0f660bdf34f4c04367febffc95bad63ee9016299.zip
ssh: Add ssh_sftp:open_tar/3,4 which opens a tar file at the server side of a channel.
Depends on erl_tar.erl having the function erl_tar:init/3 defined.
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>