mirror of https://github.com/curl/curl.git synced 2024-12-27 06:59:43 +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.3 KiB

Raw Blame History

SPDX-License-Identifier

Title

Section

Source

See-also

Protocol

curl

CURLOPT_DISALLOW_USERNAME_IN_URL

libcurl

CURLOPT_PROTOCOLS (3)

CURLOPT_URL (3)

curl_url_set (3)

libcurl-security (3)

All

NAME

CURLOPT_DISALLOW_USERNAME_IN_URL - disallow specifying username in the URL

SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DISALLOW_USERNAME_IN_URL,
                          long disallow);

DESCRIPTION

A long parameter set to 1 tells the library to not allow URLs that include a username.

This is the equivalent to the CURLU_DISALLOW_USER flag for the curl_url_set(3) function.

DEFAULT

0 (disabled) - usernames are allowed by default.

EXAMPLE

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {

    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
    curl_easy_setopt(curl, CURLOPT_DISALLOW_USERNAME_IN_URL, 1L);

    curl_easy_perform(curl);
  }
}

AVAILABILITY

Added in 7.61.0

RETURN VALUE

Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.

curl_easy_perform(3) returns CURLE_LOGIN_DENIED if this option is enabled and a URL containing a username is specified.

1.3 KiB Raw Blame History