mirror of https://github.com/curl/curl.git synced 2025-02-05 14:30:10 +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

890 B

Raw Blame History

SPDX-License-Identifier

Title

Section

Source

See-also

Protocol

curl

CURLOPT_TRAILERDATA

libcurl

CURLOPT_TRAILERFUNCTION (3)

CURLOPT_WRITEFUNCTION (3)

HTTP

NAME

CURLOPT_TRAILERDATA - pointer passed to trailing headers callback

SYNOPSIS

#include <curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TRAILERDATA, void *userdata);

DESCRIPTION

Data pointer to be passed to the HTTP trailer callback function.

DEFAULT

NULL

PROTOCOLS

HTTP

EXAMPLE

struct MyData {
  void *custom;
};

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    struct MyData data;
    curl_easy_setopt(curl, CURLOPT_TRAILERDATA, &data);
  }
}

AVAILABILITY

This option was added in curl 7.64.0 and is present if HTTP support is enabled

RETURN VALUE

Returns CURLE_OK.

890 B Raw Blame History