mirror of https://github.com/curl/curl.git synced 2024-12-09 06:30:06 +08:00

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

909 B

Raw Blame History

SPDX-License-Identifier

Title

Section

Source

See-also

curl

curl_slist_free_all

libcurl

curl_slist_append (3)

NAME

curl_slist_free_all - free an entire curl_slist list

SYNOPSIS

#include <curl/curl.h>

void curl_slist_free_all(struct curl_slist *list);

DESCRIPTION

curl_slist_free_all() removes all traces of a previously built curl_slist linked list.

Passing in a NULL pointer in list makes this function return immediately with no action.

EXAMPLE

int main(void)
{
  CURL *handle;
  struct curl_slist *slist = NULL;

  slist = curl_slist_append(slist, "X-libcurl: coolness");

  if(!slist)
    return -1;

  curl_easy_setopt(handle, CURLOPT_HTTPHEADER, slist);

  curl_easy_perform(handle);

  curl_slist_free_all(slist); /* free the list again */
}

AVAILABILITY

Always

RETURN VALUE

Nothing.

909 B Raw Blame History