From b90f22861404f2a2cdd305055c786bb73464af01 Mon Sep 17 00:00:00 2001
From: Hans Nilsson <hans@erlang.org>
Date: Thu, 7 Apr 2016 16:30:35 +0200
Subject: ssh: make ssh:daemon choose port when Port=0 in the arguments

---
 lib/ssh/doc/src/ssh.xml | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

(limited to 'lib/ssh/doc/src/ssh.xml')

diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index 850557444d..a9e843c36c 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -359,7 +359,8 @@
       </type>
       <desc>
         <p>Starts a server listening for SSH connections on the given
-        port.</p>
+        port. If the <c>Port</c> is 0, a random free port is selected. See
+	<seealso marker="#daemon_info/1">daemon_info/1</seealso> about how to find the selected port number.</p>
 	<p>Options:</p>
         <taglist>
 	  <tag><c><![CDATA[{inet, inet | inet6}]]></c></tag>
@@ -679,6 +680,18 @@
       </desc>   
     </func>
 
+    <func>
+      <name>daemon_info(Daemon) -> {ok, [{port,Port}]} | {error,Error}</name>
+      <fsummary>Get info about a daemon</fsummary>
+      <type>
+        <v>Port = integer()</v>
+	<v>Error = bad_daemon_ref</v>
+      </type>
+      <desc>
+	<p>Returns a key-value list with information about the daemon. For now, only the listening port is returned. This is intended for the case the daemon is started with the port set to 0.</p>
+      </desc>
+    </func>
+
     <func>
       <name>default_algorithms() -> algs_list()</name>
       <fsummary>Get a list declaring the supported algorithms</fsummary>
-- 
cgit v1.2.3