mirror of https://github.com/curl/curl.git synced 2025-01-12 13:55:11 +08:00

Daniel Stenberg e3fe020089

docs/libcurl: generate PROTOCOLS from meta-data

Remove the PROTOCOLS section from the source files completely and
instead generate them based on the header data in the curldown files.

It also generates TLS backend information for options marked for TLS as
protocol.

Closes #13175

2024-03-23 18:13:03 +01:00

1.4 KiB

Raw Blame History

SPDX-License-Identifier

Title

Section

Source

Protocol

See-also

curl

CURLOPT_FTP_ALTERNATIVE_TO_USER

libcurl

FTP

CURLOPT_FTP_ACCOUNT (3)

CURLOPT_FTP_SKIP_PASV_IP (3)

CURLOPT_SERVER_RESPONSE_TIMEOUT (3)

CURLOPT_USERNAME (3)

NAME

CURLOPT_FTP_ALTERNATIVE_TO_USER - command to use instead of USER with FTP

SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTP_ALTERNATIVE_TO_USER,
                          char *cmd);

DESCRIPTION

Pass a char pointer as parameter, pointing to a string which is used to authenticate if the usual FTP "USER user" and "PASS password" negotiation fails. This is currently only known to be required when connecting to Tumbleweed's Secure Transport FTPS server using client certificates for authentication.

The application does not have to keep the string around after setting this option.

DEFAULT

NULL

EXAMPLE

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode res;
    curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/foo.bin");
    curl_easy_setopt(curl, CURLOPT_FTP_ALTERNATIVE_TO_USER, "two users");
    res = curl_easy_perform(curl);

    curl_easy_cleanup(curl);
  }
}

AVAILABILITY

Added in 7.15.5

RETURN VALUE

Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space.

1.4 KiB Raw Blame History