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

974 B

Raw Blame History

SPDX-License-Identifier

Title

Section

Source

See-also

curl

curl_url_dup

libcurl

CURLOPT_CURLU (3)

curl_url (3)

curl_url_cleanup (3)

curl_url_get (3)

curl_url_set (3)

NAME

curl_url_dup - duplicate a URL handle

SYNOPSIS

#include <curl/curl.h>

CURLU *curl_url_dup(const CURLU *inhandle);

DESCRIPTION

Duplicates the URL object the input CURLU inhandle identifies and returns a pointer to the copy as a new CURLU handle. The new handle also needs to be freed with curl_url_cleanup(3).

EXAMPLE

int main(void)
{
  CURLUcode rc;
  CURLU *url = curl_url();
  CURLU *url2;
  rc = curl_url_set(url, CURLUPART_URL, "https://example.com", 0);
  if(!rc) {
    url2 = curl_url_dup(url); /* clone it! */
    curl_url_cleanup(url2);
  }
  curl_url_cleanup(url);
}

AVAILABILITY

Added in 7.62.0

RETURN VALUE

Returns a new handle or NULL if out of memory.

974 B Raw Blame History