From 787dfe7cdec35d43f5f88311b60b6288e39e7ffb Mon Sep 17 00:00:00 2001
From: Hans Nilsson
Date: Wed, 13 Nov 2013 15:05:50 +0100
Subject: ftp: Add ftps documentation
---
lib/inets/doc/src/ftp.xml | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/lib/inets/doc/src/ftp.xml b/lib/inets/doc/src/ftp.xml
index f8f11ec705..ac14d3f274 100644
--- a/lib/inets/doc/src/ftp.xml
+++ b/lib/inets/doc/src/ftp.xml
@@ -547,15 +547,14 @@
Opts = options()
options() = [option()]
option() = start_option() | open_option()
-
start_option() = {verbose, verbose()} | {debug, debug()}
verbose() = boolean() (defaults to false)
debug() = disable | debug | trace (defaults to disable)
-
- open_option() = {ipfamily, ipfamily()} | {port, port()} | {mode, mode()} | {timeout, timeout()} | {dtimeout, dtimeout()} | {progress, progress()}
+ open_option() = {ipfamily, ipfamily()} | {port, port()} | {mode, mode()} | {tls, tls_options()} | {timeout, timeout()} | {dtimeout, dtimeout()} | {progress, progress()}
ipfamily() = inet | inet6 | inet6fb4 (defaults to inet)
port() = integer() > 0 (defaults to 21)
mode() = active | passive (defaults to passive)
+ tls_options() = [ssl:ssloption()]
timeout() = integer() > 0 (defaults to 60000 milliseconds)
dtimeout() = integer() > 0 | infinity (defaults to infinity)
pogress() = ignore | {module(), function(), initial_data()} (defaults to ignore)
@@ -570,6 +569,9 @@
(without the inets service framework) and
open a session with the FTP server at Host.
+ If the option {tls, tls_options()} is present, the ftp session will be transported over tls (ftps, see RFC 4217). The list tls_options() may be empty. The function ssl:connect/3 is used for establishing both the control connection and the data sessions.
+
+
A session opened in this way, is closed using the
close function.
--
cgit v1.2.3