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

Daniel Stenberg b935fd4a07

docs: make each libcurl man specify protocol(s)

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

2024-03-21 15:27:06 +01:00

1.3 KiB

Raw Blame History

c: Copyright (C) Daniel Stenberg, daniel@haxx.se, et al. SPDX-License-Identifier: curl Title: CURLOPT_DISALLOW_USERNAME_IN_URL Section: 3 Source: libcurl See-also: - CURLOPT_PROTOCOLS (3) - CURLOPT_URL (3) - curl_url_set (3) - libcurl-security (3) Protocol: - *

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.

PROTOCOLS

Several

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