summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNicolas Frattaroli <ffmpeg@fratti.ch>2019-10-27 00:37:32 +0200
committerMarton Balint <cus@passwd.hu>2019-11-03 12:24:19 +0100
commita8ec0685ac1cfbeb0e87f47b86d4f0b5cf75d745 (patch)
treec498d98b87c4e7474a8d43aa053483e5eacab050 /doc
parent5e3229df4ca86322f334bd098a9335f66ebdd649 (diff)
avformat/ftp: add AVOptions for authentication
This introduces two new AVOption options for the FTP protocol, one named ftp-user to supply the username to be used for auth, one named ftp-password to supply the password to be used for auth. These are useful for when an API user does not wish to deal with URL manipulation and percent encoding. Setting them while also having credentials in the URL will use the credentials from the URL. The rationale for this is that credentials embedded in the URL are probably more specific to what the user is trying to do than anything set by some API user. Signed-off-by: Nicolas Frattaroli <ffmpeg@fratti.ch> Signed-off-by: Marton Balint <cus@passwd.hu>
Diffstat (limited to 'doc')
-rw-r--r--doc/protocols.texi8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/protocols.texi b/doc/protocols.texi
index b03432e3e5..0e18a49dda 100644
--- a/doc/protocols.texi
+++ b/doc/protocols.texi
@@ -228,6 +228,14 @@ Set timeout in microseconds of socket I/O operations used by the underlying low
operation. By default it is set to -1, which means that the timeout is
not specified.
+@item ftp-user
+Set a user to be used for authenticating to the FTP server. This is overridden by the
+user in the FTP URL.
+
+@item ftp-password
+Set a password to be used for authenticating to the FTP server. This is overridden by
+the password in the FTP URL, or by @option{ftp-anonymous-password} if no user is set.
+
@item ftp-anonymous-password
Password used when login as anonymous user. Typically an e-mail address
should be used.