diff options
Diffstat (limited to 'lib/ftp/doc/src')
| -rw-r--r-- | lib/ftp/doc/src/ftp.xml | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/lib/ftp/doc/src/ftp.xml b/lib/ftp/doc/src/ftp.xml index 0a147c721d..cbe6771f81 100644 --- a/lib/ftp/doc/src/ftp.xml +++ b/lib/ftp/doc/src/ftp.xml @@ -98,7 +98,8 @@ <item> <marker id="port"></marker> <p>Port = <c>integer() > 0</c></p> - <p>Default is <c>21</c>.</p> + <p>Default is <c>0</c> which aliases to <c>21</c> or <c>990</c> when used with + <seeerl marker="#open"><c>{tls_sec_method,ftps}</c></seeerl>).</p> </item> <tag>{mode, Mode}</tag> @@ -546,11 +547,12 @@ <v>start_option() = {verbose, verbose()} | {debug, debug()}</v> <v>verbose() = boolean() (default is false)</v> <v>debug() = disable | debug | trace (default is disable)</v> - <v>open_option() = {ipfamily, ipfamily()} | {port, port()} | {mode, mode()} | {tls, tls_options()} | {timeout, timeout()} | {dtimeout, dtimeout()} | {progress, progress() | {sock_ctrl, sock_opts()} | {sock_data_act, sock_opts()} | {sock_data_pass, sock_opts()} }</v> + <v>open_option() = {ipfamily, ipfamily()} | {port, port()} | {mode, mode()} | {tls, tls_options()} | {tls_sec_method, tls_sec_method()} | {timeout, timeout()} | {dtimeout, dtimeout()} | {progress, progress() | {sock_ctrl, sock_opts()} | {sock_data_act, sock_opts()} | {sock_data_pass, sock_opts()} }</v> <v>ipfamily() = inet | inet6 | inet6fb4 (default is inet)</v> - <v>port() = integer() > 0 (default is 21)</v> + <v>port() = non_neg_integer() (default is 0 which aliases to 21 or 990 when used with {tls_sec_method,ftps})</v> <v>mode() = active | passive (default is passive)</v> <v>tls_options() = [<seetype marker="ssl:ssl#tls_option">ssl:tls_option()</seetype>]</v> + <v>tls_sec_method() = ftps | ftpes (default is ftpes)</v> <v>sock_opts() = [<seetype marker="kernel:gen_tcp#option">gen_tcp:option()</seetype> except for ipv6_v6only, active, packet, mode, packet_size and header</v> <v>timeout() = integer() > 0 (default is 60000 milliseconds)</v> <v>dtimeout() = integer() > 0 | infinity (default is infinity)</v> @@ -574,6 +576,12 @@ is used for securing both the control connection and the data sessions. </p> + <p>The suboption <c>{tls_sec_method, tls_sec_method()}</c> (defaults to + <c>ftpes</c>) when set to <c>ftps</c> will connect immediately with SSL + instead of upgrading with STARTTLS. This suboption is ignored unless + the suboption <c>tls</c> is also set. + </p> + <p>The options <c>sock_ctrl</c>, <c>sock_data_act</c> and <c>sock_data_pass</c> passes options down to the underlying transport layer (tcp). The default value for <c>sock_ctrl</c> is <c>[]</c>. Both <c>sock_data_act</c> and <c>sock_data_pass</c> uses the value of <c>sock_ctrl</c> as default value. |