mirror of
https://github.com/curl/curl.git
synced 2025-02-11 14:50:40 +08:00
The mandatory header now has a mandatory list of protocols for which the manpage is relevant. Most man pages already has a "PROTOCOLS" section, but this introduces a stricter way to specify the relevant protocols. cd2nroff verifies that at least one protocol is mentioned (which can be `*`). This information is not used just yet, but A) the PROTOCOLS section can now instead get generated and get a unified wording across all manpages and B) this allows us to more reliably filter/search for protocol specific manpages/options. Closes #13166
79 lines
1.4 KiB
Markdown
79 lines
1.4 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLOPT_FTPSSLAUTH
|
|
Section: 3
|
|
Source: libcurl
|
|
Protocol:
|
|
- FTP
|
|
See-also:
|
|
- CURLOPT_FTP_SSL_CCC (3)
|
|
- CURLOPT_USE_SSL (3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLOPT_FTPSSLAUTH - order in which to attempt TLS vs SSL
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTPSSLAUTH, long order);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Pass a long using one of the values from below, to alter how libcurl issues
|
|
"AUTH TLS" or "AUTH SSL" when FTP over SSL is activated. This is only
|
|
interesting if CURLOPT_USE_SSL(3) is also set.
|
|
|
|
Possible *order* values:
|
|
|
|
## CURLFTPAUTH_DEFAULT
|
|
|
|
Allow libcurl to decide.
|
|
|
|
## CURLFTPAUTH_SSL
|
|
|
|
Try "AUTH SSL" first, and only if that fails try "AUTH TLS".
|
|
|
|
## CURLFTPAUTH_TLS
|
|
|
|
Try "AUTH TLS" first, and only if that fails try "AUTH SSL".
|
|
|
|
# DEFAULT
|
|
|
|
CURLFTPAUTH_DEFAULT
|
|
|
|
# PROTOCOLS
|
|
|
|
FTP
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
CURLcode res;
|
|
curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/file.txt");
|
|
curl_easy_setopt(curl, CURLOPT_USE_SSL, CURLUSESSL_TRY);
|
|
/* funny server, ask for SSL before TLS */
|
|
curl_easy_setopt(curl, CURLOPT_FTPSSLAUTH, (long)CURLFTPAUTH_SSL);
|
|
res = curl_easy_perform(curl);
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
Added in 7.12.2
|
|
|
|
# RETURN VALUE
|
|
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|