diff options
author | Hans Nilsson <[email protected]> | 2019-06-27 16:29:19 +0200 |
---|---|---|
committer | Hans Nilsson <[email protected]> | 2019-08-12 17:09:16 +0200 |
commit | 42a916716671d6f553f5c25d8a8c98d34a7f1da5 (patch) | |
tree | 943256f65e1b33772e9179276e5a620b2944bdc0 /lib/ssh/doc/src/using_ssh.xml | |
parent | 8bf1bd07face1af84fbded1281e4877f28e0e9fa (diff) | |
download | otp-42a916716671d6f553f5c25d8a8c98d34a7f1da5.tar.gz otp-42a916716671d6f553f5c25d8a8c98d34a7f1da5.tar.bz2 otp-42a916716671d6f553f5c25d8a8c98d34a7f1da5.zip |
ssh: The ssh_sftp documentation is now generated
Diffstat (limited to 'lib/ssh/doc/src/using_ssh.xml')
-rw-r--r-- | lib/ssh/doc/src/using_ssh.xml | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/lib/ssh/doc/src/using_ssh.xml b/lib/ssh/doc/src/using_ssh.xml index 4455d5ecc5..5c56dee81d 100644 --- a/lib/ssh/doc/src/using_ssh.xml +++ b/lib/ssh/doc/src/using_ssh.xml @@ -232,9 +232,10 @@ </section> <section> - <title>SFTP Client with TAR Compression and Encryption</title> - - <p>Example of writing and then reading a tar file follows:</p> + <title>SFTP Client with TAR Compression</title> + <section> + <title>Basic example</title> + <p>This is an example of writing and then reading a tar file:</p> <code type="erl"> {ok,HandleWrite} = ssh_sftp:open_tar(ChannelPid, ?tar_file_name, [write]), ok = erl_tar:add(HandleWrite, .... ), @@ -248,8 +249,12 @@ {ok,NameValueList} = erl_tar:extract(HandleRead,[memory]), ok = erl_tar:close(HandleRead), </code> + </section> - <p>The previous write and read example can be extended with encryption and decryption as follows:</p> + <section> + <title>Example with encryption</title> + <p>The previous <seealso marker="using_ssh#basic-example">Basic example</seealso> + can be extended with encryption and decryption as follows:</p> <code type="erl"> %% First three parameters depending on which crypto type we select: Key = <<"This is a 256 bit key. abcdefghi">>, @@ -297,6 +302,7 @@ Cr = {InitFun,DecryptFun}, ok = erl_tar:close(HandleRead), </code> </section> + </section> <section> <marker id="usersguide_creating_a_subsystem"/> |