aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ssh/doc/src/ssh.xml
diff options
context:
space:
mode:
authorHans Nilsson <[email protected]>2016-05-02 13:10:11 +0200
committerHans Nilsson <[email protected]>2016-05-02 13:10:11 +0200
commit857a1d4b17508608241e10315f17988cf2d22ecc (patch)
tree3542e6dee0f802baae8bcb0ed7100c89b3b331b0 /lib/ssh/doc/src/ssh.xml
parent7cc731c30c4701251fec17d93a88ce2a8739b5b1 (diff)
parent6282a81eca93e015445e04d09be9ac7854bb96d6 (diff)
downloadotp-857a1d4b17508608241e10315f17988cf2d22ecc.tar.gz
otp-857a1d4b17508608241e10315f17988cf2d22ecc.tar.bz2
otp-857a1d4b17508608241e10315f17988cf2d22ecc.zip
Merge branch 'hans/ssh/daemon_port_0/OTP-13527'
Conflicts: lib/ssh/test/ssh_test_lib.erl
Diffstat (limited to 'lib/ssh/doc/src/ssh.xml')
-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 33aacb8ffe..ff2d6e082a 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -360,7 +360,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>
@@ -682,6 +683,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>