curl/docs/libcurl/curl_mime_name.md
Daniel Stenberg eefcc1bda4
docs: introduce "curldown" for libcurl man page format
curldown is this new file format for libcurl man pages. It is markdown
inspired with differences:

- Each file has a set of leading headers with meta-data
- Supports a small subset of markdown
- Uses .md file extensions for editors/IDE/GitHub to treat them nicely
- Generates man pages very similar to the previous ones
- Generates man pages that still convert nicely to HTML on the website
- Detects and highlights mentions of curl symbols automatically (when
  their man page section is specified)

tools:

- cd2nroff: converts from curldown to nroff man page
- nroff2cd: convert an (old) nroff man page to curldown
- cdall: convert many nroff pages to curldown versions
- cd2cd: verifies and updates a curldown to latest curldown

This setup generates .3 versions of all the curldown versions at build time.

CI:

Since the documentation is now technically markdown in the eyes of many
things, the CI runs many more tests and checks on this documentation,
including proselint, link checkers and tests that make sure we capitalize the
first letter after a period...

Closes #12730
2024-01-23 00:29:02 +01:00

1.3 KiB

c SPDX-License-Identifier Title Section Source See-also
Copyright (C) Daniel Stenberg, <daniel.se>, et al. curl curl_mime_name 3 libcurl
curl_mime_addpart (3)
curl_mime_data (3)
curl_mime_type (3)

NAME

curl_mime_name - set a mime part's name

SYNOPSIS

#include <curl/curl.h>

CURLcode curl_mime_name(curl_mimepart *part, const char *name);

DESCRIPTION

curl_mime_name(3) sets a mime part's name. This is the way HTTP form fields are named.

part is the part's handle to assign a name to.

name points to the null-terminated name string.

The name string is copied into the part, thus the associated storage may safely be released or reused after call. Setting a part's name multiple times is valid: only the value set by the last call is retained. It is possible to reset the name of a part by setting name to NULL.

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);

    /* give the part a name */
    curl_mime_name(part, "shoe_size");
  }
}

AVAILABILITY

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

RETURN VALUE

CURLE_OK or a CURL error code upon failure.