aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ssh/doc/src/ssh.xml
diff options
context:
space:
mode:
authorIngela Anderton Andin <[email protected]>2013-11-06 10:54:02 +0100
committerIngela Anderton Andin <[email protected]>2013-11-13 10:58:20 +0100
commit422ed9ecd9c95c25964381b7ca2888a0320a8ee4 (patch)
treeb501003998429de1850d0b067f285dcfbd8dcf18 /lib/ssh/doc/src/ssh.xml
parent24f37acef3e7e33576bcd071569a94de980b6544 (diff)
downloadotp-422ed9ecd9c95c25964381b7ca2888a0320a8ee4.tar.gz
otp-422ed9ecd9c95c25964381b7ca2888a0320a8ee4.tar.bz2
otp-422ed9ecd9c95c25964381b7ca2888a0320a8ee4.zip
ssh: Simplify handling of connection attributes (e.i. user and sockname)
OTP-11296
Diffstat (limited to 'lib/ssh/doc/src/ssh.xml')
-rw-r--r--lib/ssh/doc/src/ssh.xml34
1 files changed, 5 insertions, 29 deletions
diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index b338241685..3409681af4 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -198,8 +198,11 @@
Value}] </name>
<fsummary> Retrieves information about a connection. </fsummary>
<type>
- <v>Option = client_version | server_version | peer</v>
- <v>Value = term() </v>
+ <v>Option = client_version | server_version | user | peer | sockname </v>
+ <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>
</type>
<desc>
<p> Retrieves information about a connection.
@@ -325,19 +328,6 @@
</desc>
</func>
- <func>
- <name>peername(ConnectionRef) -> {ok, {Address,Port}} | {error,Error} </name>
- <fsummary> </fsummary>
- <type>
- <v> ConnectionRef = ssh_connection_ref()</v>
- <v> Address = ip_address()</v>
- <v> Port = integer()</v>
- </type>
- <desc>
- <p>Returns the address and port for the other end of a connection.
- </p>
- </desc>
- </func>
<func>
<name>shell(Host) -> </name>
@@ -359,20 +349,6 @@
</func>
<func>
- <name>sockname(ConnectionRef) -> {ok, {Address,Port}} | {error,Error} </name>
- <fsummary> </fsummary>
- <type>
- <v> ConnectionRef = ssh_connection_ref()</v>
- <v> Address = ip_address()</v>
- <v> Port = integer()</v>
- </type>
- <desc>
- <p>Returns the local address and port number for a connection.
- </p>
- </desc>
- </func>
-
- <func>
<name>start() -> </name>
<name>start(Type) -> ok | {error, Reason}</name>
<fsummary>Starts the SSH application. </fsummary>