diff options
author | Hans Nilsson <[email protected]> | 2016-06-01 16:43:29 +0200 |
---|---|---|
committer | Hans Nilsson <[email protected]> | 2016-06-01 17:41:19 +0200 |
commit | d7d109ca8ab68d7a62772305d543123233d4eea4 (patch) | |
tree | c2a5a91ec7e84b70b920a344ff4552fad33cd71a /lib/ssh/doc/src/ssh_sftp.xml | |
parent | d7e91348bc49a8f46a4d8223d522e2d92469f6da (diff) | |
download | otp-d7d109ca8ab68d7a62772305d543123233d4eea4.tar.gz otp-d7d109ca8ab68d7a62772305d543123233d4eea4.tar.bz2 otp-d7d109ca8ab68d7a62772305d543123233d4eea4.zip |
ssh: update connect doc
Diffstat (limited to 'lib/ssh/doc/src/ssh_sftp.xml')
-rw-r--r-- | lib/ssh/doc/src/ssh_sftp.xml | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml index 67531b7d99..eb6f43d417 100644 --- a/lib/ssh/doc/src/ssh_sftp.xml +++ b/lib/ssh/doc/src/ssh_sftp.xml @@ -526,10 +526,6 @@ </func> <func> - <name>start_channel(TcpSocket) -></name> - <name>start_channel(TcpSocket, Options) -> - {ok, Pid, ConnectionRef} | {error, reason()|term()}</name> - <name>start_channel(ConnectionRef) -></name> <name>start_channel(ConnectionRef, Options) -> {ok, Pid} | {error, reason()|term()}</name> @@ -537,13 +533,18 @@ <name>start_channel(Host, Options) -></name> <name>start_channel(Host, Port, Options) -> {ok, Pid, ConnectionRef} | {error, reason()|term()}</name> + + <name>start_channel(TcpSocket) -></name> + <name>start_channel(TcpSocket, Options) -> + {ok, Pid, ConnectionRef} | {error, reason()|term()}</name> + <fsummary>Starts an SFTP client.</fsummary> <type> <v>Host = string()</v> <v>ConnectionRef = ssh_connection_ref()</v> <v>Port = integer()</v> <v>TcpSocket = port()</v> - <d>The socket is supposed to be from <c>gen_tcp:connect</c> with option <c>{active,false}</c></d> + <d>The socket is supposed to be from <seealso marker="kernel:gen_tcp#connect-3">gen_tcp:connect</seealso> or <seealso marker="kernel:gen_tcp#accept-1">gen_tcp:accept</seealso> with option <c>{active,false}</c></d> <v>Options = [{Option, Value}]</v> </type> <desc> |