Merge branch 'hans/ssh/improve_docs'

3 files changed, 63 insertions, 60 deletions

diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index 6f1c2bcba3..d49d3ac2a7 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -41,6 +41,7 @@
       <item>Supported SSH version is 2.0.</item>
       <item>Supported MAC algorithms: hmac-sha2-256 and hmac-sha1.</item>
       <item>Supported encryption algorithms: aes128-ctr, aes128-cb and 3des-cbc.</item>
+      <item>Supported key exchange algorithms: diffie-hellman-group1-sha1.</item>
       <item>Supports unicode filenames if the emulator and the underlaying OS support it.
       See section DESCRIPTION in the
       <seealso marker="kernel:file">file</seealso> manual page in <c>kernel</c>
@@ -105,9 +106,9 @@
 	<d><c><![CDATA[22]]></c> is default, the assigned well-known port
 	number for SSH.</d>
 	<v>Options = [{Option, Value}]</v>
-	<v>Timeout = infinity | integer(milliseconds)</v>
-	<d>Negotiation time-out. For connection time-out, use option
-	<c>{connect_timeout, timeout()}</c>.</d>
+	<v>Timeout = infinity | integer()</v>
+	<d>Negotiation time-out in milli-seconds. The default value is <c>infinity</c>.
+	For connection time-out, use option <c>{connect_timeout, timeout()}</c>.</d>
       </type>
       <desc>
 	<p>Connects to an SSH server. No channel is started. This is done
@@ -176,7 +177,8 @@
 	  <tag><c><![CDATA[{connect_timeout, timeout()}]]></c></tag>
 	  <item>
 	    <p>Sets a time-out on the transport layer
-	    connection. Defaults to <c>infinity</c>.</p>
+	    connection. For <c>gen_tcp</c> the time is in milli-seconds and the default value is
+	    <c>infinity</c>.</p>
 	  </item>
 	  <tag><c><![CDATA[{user, string()}]]></c></tag>
           <item>
@@ -238,7 +240,7 @@
 	<v>Value = [option_value()] </v>
 	<v>option_value() = {{Major::integer(), Minor::integer()}, VersionString::string()} |
 	User::string() |  Peer::{inet:hostname(), {inet::ip_adress(), inet::port_number()}} |
-	Sockname::{inet::ip_adress(), inet::port_number()} () </v>
+	Sockname::{inet::ip_adress(), inet::port_number()}</v>
       </type>
       <desc>
         <p>Retrieves information about a connection.</p>
diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml
index 4ed5a38de4..1a3705b341 100644
--- a/lib/ssh/doc/src/ssh_sftp.xml
+++ b/lib/ssh/doc/src/ssh_sftp.xml
@@ -46,7 +46,7 @@
       <tag><c>ssh_connection_ref()</c></tag>
       <item><p>Opaque to the user, returned by <c>ssh:connect/3</c></p></item>
       <tag><c>timeout()</c></tag>
-      <item><p>= <c>infinity | integer() in milliseconds</c></p></item>
+      <item><p>= <c>infinity | integer() in milliseconds. Default infinity.</c></p></item>
     </taglist>
    </section>
 
diff --git a/lib/ssh/doc/src/using_ssh.xml b/lib/ssh/doc/src/using_ssh.xml
index 9da839d072..cd7b64ac43 100644
--- a/lib/ssh/doc/src/using_ssh.xml
+++ b/lib/ssh/doc/src/using_ssh.xml
@@ -102,8 +102,8 @@
     <code type="erl">
       1> ssh:start().
       ok
-      2> {ok, Sshd} = ssh:daemon(8989,  [{system_dir, "/tmp/ssh_daemon"},
-      {user_dir, "/tmp/otptest_user/.ssh"}]).
+      2> {ok, Sshd} = ssh:daemon(8989, [{system_dir, "/tmp/ssh_daemon"},
+                                        {user_dir, "/tmp/otptest_user/.ssh"}]).
       {ok,&lt;0.54.0>}
       3>
     </code>
@@ -154,8 +154,8 @@
 
     <note><p>The number of received messages in this example depends on which OS
     and which shell that is used on the machine running the <c>ssh</c> daemon.
-    See also <seealso marker="ssh_connection#exec-4">ssh_connection:exec/4</seealso>
-    </p>.</note>
+    See also <seealso marker="ssh_connection#exec-4">ssh_connection:exec/4</seealso>.
+    </p></note>
 
     <p>Do a one-time execution of a remote command over <c>ssh</c>:</p>
 
@@ -194,9 +194,10 @@
     <code type="erl" >
       1> ssh:start().
       ok
-      2> ssh:daemon(8989,  [{system_dir, "/tmp/ssh_daemon"},
-         {user_dir, "/tmp/otptest_user/.ssh"},
-         {subsystems, [ssh_sftpd:subsystem_spec([{cwd, "/tmp/sftp/example"}])]}]).
+      2> ssh:daemon(8989, [{system_dir, "/tmp/ssh_daemon"},
+                           {user_dir, "/tmp/otptest_user/.ssh"},
+                           {subsystems, [ssh_sftpd:subsystem_spec([{cwd, "/tmp/sftp/example"}])
+                                        ]}]).
       {ok,&lt;0.54.0>}
       3>
     </code>
@@ -248,50 +249,50 @@
 
     <p>The previous write and read example can be extended with encryption and decryption as follows:</p>
     <code type="erlang">
-      %% First three parameters depending on which crypto type we select:
-      Key = &lt;&lt;"This is a 256 bit key. abcdefghi">>,
-      Ivec0 = crypto:rand_bytes(16),
-      DataSize = 1024,  % DataSize rem 16 = 0 for aes_cbc
-
-      %% Initialization of the CryptoState, in this case it is the Ivector.
-      InitFun = fun() -> {ok, Ivec0, DataSize} end,
-
-      %% How to encrypt:
-      EncryptFun =
-      fun(PlainBin,Ivec) ->
-      EncryptedBin = crypto:block_encrypt(aes_cbc256, Key, Ivec, PlainBin),
-      {ok, EncryptedBin, crypto:next_iv(aes_cbc,EncryptedBin)}
-      end,
-
-      %% What to do with the very last block:
-      CloseFun =
-      fun(PlainBin, Ivec) ->
-      EncryptedBin = crypto:block_encrypt(aes_cbc256, Key, Ivec,
-      pad(16,PlainBin) %% Last chunk
-      ),
-      {ok, EncryptedBin}
-      end,
-
-      Cw = {InitFun,EncryptFun,CloseFun},
-      {ok,HandleWrite} = ssh_sftp:open_tar(ChannelPid, ?tar_file_name, [write,{crypto,Cw}]),
-      ok = erl_tar:add(HandleWrite, .... ),
-      ok = erl_tar:add(HandleWrite, .... ),
-      ...
-      ok = erl_tar:add(HandleWrite, .... ),
-      ok = erl_tar:close(HandleWrite),
-
-      %% And for decryption (in this crypto example we could use the same InitFun
-      %% as for encryption):
-      DecryptFun =
-      fun(EncryptedBin,Ivec) ->
-      PlainBin = crypto:block_decrypt(aes_cbc256, Key, Ivec, EncryptedBin),
-      {ok, PlainBin, crypto:next_iv(aes_cbc,EncryptedBin)}
-      end,
-
-      Cr = {InitFun,DecryptFun},
-      {ok,HandleRead} = ssh_sftp:open_tar(ChannelPid, ?tar_file_name, [read,{crypto,Cw}]),
-      {ok,NameValueList} = erl_tar:extract(HandleRead,[memory]),
-      ok = erl_tar:close(HandleRead),
+%% First three parameters depending on which crypto type we select:
+Key = &lt;&lt;"This is a 256 bit key. abcdefghi">>,
+Ivec0 = crypto:rand_bytes(16),
+DataSize = 1024,  % DataSize rem 16 = 0 for aes_cbc
+
+%% Initialization of the CryptoState, in this case it is the Ivector.
+InitFun = fun() -> {ok, Ivec0, DataSize} end,
+
+%% How to encrypt:
+EncryptFun =
+    fun(PlainBin,Ivec) ->
+        EncryptedBin = crypto:block_encrypt(aes_cbc256, Key, Ivec, PlainBin),
+        {ok, EncryptedBin, crypto:next_iv(aes_cbc,EncryptedBin)}
+    end,
+
+%% What to do with the very last block:
+CloseFun =
+    fun(PlainBin, Ivec) ->
+        EncryptedBin = crypto:block_encrypt(aes_cbc256, Key, Ivec,
+                                            pad(16,PlainBin) %% Last chunk
+                                           ),
+       {ok, EncryptedBin}
+    end,
+
+Cw = {InitFun,EncryptFun,CloseFun},
+{ok,HandleWrite} = ssh_sftp:open_tar(ChannelPid, ?tar_file_name, [write,{crypto,Cw}]),
+ok = erl_tar:add(HandleWrite, .... ),
+ok = erl_tar:add(HandleWrite, .... ),
+...
+ok = erl_tar:add(HandleWrite, .... ),
+ok = erl_tar:close(HandleWrite),
+
+%% And for decryption (in this crypto example we could use the same InitFun
+%% as for encryption):
+DecryptFun =
+    fun(EncryptedBin,Ivec) ->
+        PlainBin = crypto:block_decrypt(aes_cbc256, Key, Ivec, EncryptedBin),
+       {ok, PlainBin, crypto:next_iv(aes_cbc,EncryptedBin)}
+    end,
+
+Cr = {InitFun,DecryptFun},
+{ok,HandleRead} = ssh_sftp:open_tar(ChannelPid, ?tar_file_name, [read,{crypto,Cw}]),
+{ok,NameValueList} = erl_tar:extract(HandleRead,[memory]),
+ok = erl_tar:close(HandleRead),
     </code>
   </section>
 
@@ -360,9 +361,9 @@ terminate(_Reason, _State) ->
  <code type="erl" >
    1> ssh:start().
    ok
-   2>  ssh:daemon(8989, [{system_dir, "/tmp/ssh_daemon"},
-   {user_dir, "/tmp/otptest_user/.ssh"}
-   {subsystems, [{"echo_n", {ssh_echo_server, [10]}}]}]).
+   2> ssh:daemon(8989, [{system_dir, "/tmp/ssh_daemon"},
+                        {user_dir, "/tmp/otptest_user/.ssh"}
+                        {subsystems, [{"echo_n", {ssh_echo_server, [10]}}]}]).
    {ok,&lt;0.54.0>}
    3>
  </code>