aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ssh/doc
diff options
context:
space:
mode:
authorHans Nilsson <[email protected]>2016-04-07 16:30:35 +0200
committerHans Nilsson <[email protected]>2016-04-28 20:37:30 +0200
commitb90f22861404f2a2cdd305055c786bb73464af01 (patch)
tree0f22a7b8b122e3ac6c1a7f52daeaa56d24bf9584 /lib/ssh/doc
parentb9e3e212009162d8223436032282efbc5c826cc7 (diff)
downloadotp-b90f22861404f2a2cdd305055c786bb73464af01.tar.gz
otp-b90f22861404f2a2cdd305055c786bb73464af01.tar.bz2
otp-b90f22861404f2a2cdd305055c786bb73464af01.zip
ssh: make ssh:daemon choose port when Port=0 in the arguments
Diffstat (limited to 'lib/ssh/doc')
-rw-r--r--lib/ssh/doc/src/ssh.xml15
1 files changed, 14 insertions, 1 deletions
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>
@@ -680,6 +681,18 @@
</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>
<desc>