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.1 KiB

Raw Blame History

c: Copyright (C) Daniel Stenberg, daniel@haxx.se, et al. SPDX-License-Identifier: curl Title: curl_easy_option_by_name Section: 3 Source: libcurl See-also: - curl_easy_option_by_id (3) - curl_easy_option_next (3) - curl_easy_setopt (3) Protocol: - *

NAME

curl_easy_option_by_name - find an easy setopt option by name

SYNOPSIS

#include <curl/curl.h>

const struct curl_easyoption *curl_easy_option_by_name(const char *name);

DESCRIPTION

Given a name, this function returns a pointer to the curl_easyoption struct, holding information about the curl_easy_setopt(3) option using that name. The name should be specified without the "CURLOPT_" prefix and the name comparison is made case insensitive.

If libcurl has no option with the given name, this function returns NULL.

EXAMPLE

int main(void)
{
  const struct curl_easyoption *opt = curl_easy_option_by_name("URL");
  if(opt) {
    printf("This option wants CURLoption %x\n", (int)opt->id);
  }
}

AVAILABILITY

This function was added in libcurl 7.73.0

RETURN VALUE

A pointer to the curl_easyoption struct for the option or NULL.

1.1 KiB Raw Blame History