mirror of https://github.com/curl/curl.git synced 2024-12-09 06:30:06 +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.5 KiB

Raw Blame History

SPDX-License-Identifier

Title

Section

Source

See-also

Protocol

curl

curl_mime_addpart

libcurl

curl_mime_data (3)

curl_mime_data_cb (3)

curl_mime_encoder (3)

curl_mime_filedata (3)

curl_mime_filename (3)

curl_mime_headers (3)

curl_mime_init (3)

curl_mime_name (3)

curl_mime_subparts (3)

curl_mime_type (3)

HTTP

IMAP

SMTP

NAME

curl_mime_addpart - append a new empty part to a mime structure

SYNOPSIS

#include <curl/curl.h>

curl_mimepart *curl_mime_addpart(curl_mime *mime);

DESCRIPTION

curl_mime_addpart(3) creates and appends a new empty part to the given mime structure and returns a handle to it. The returned part handle can subsequently be populated using functions from the mime API.

mime is the handle of the mime structure in which the new part must be appended.

EXAMPLE

int main(void)
{
  curl_mime *mime;
  curl_mimepart *part;

  CURL *curl = curl_easy_init();
  if(curl) {
    /* create a mime handle */
    mime = curl_mime_init(curl);

    /* add a part */
    part = curl_mime_addpart(mime);

    /* continue and set name + data to the part */
    curl_mime_data(part, "This is the field data", CURL_ZERO_TERMINATED);
    curl_mime_name(part, "data");
  }
}

AVAILABILITY

As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.

RETURN VALUE

A mime part structure handle, or NULL upon failure.

1.5 KiB Raw Blame History