mirror of https://github.com/curl/curl.git synced 2025-01-24 14:15:18 +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

1.3 KiB

Raw Blame History

SPDX-License-Identifier

Title

Section

Source

See-also

curl

CURLOPT_FRESH_CONNECT

libcurl

CURLOPT_FORBID_REUSE (3)

CURLOPT_MAXAGE_CONN (3)

CURLOPT_MAXLIFETIME_CONN (3)

NAME

CURLOPT_FRESH_CONNECT - force a new connection to be used

SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FRESH_CONNECT, long fresh);

DESCRIPTION

Pass a long. Set to 1 to make the next transfer use a new (fresh) connection by force instead of trying to reuse an existing one. This option should be used with caution and only if you understand what it does as it may impact performance negatively.

Related functionality is CURLOPT_FORBID_REUSE(3) which makes sure the connection is closed after use so that it cannot be reused.

Set fresh to 0 to have libcurl attempt reusing an existing connection (default behavior).

DEFAULT

PROTOCOLS

Most

EXAMPLE

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
    curl_easy_setopt(curl, CURLOPT_FRESH_CONNECT, 1L);
    /* this transfer must use a new connection, not reuse an existing */
    curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}

AVAILABILITY

Always

RETURN VALUE

Returns CURLE_OK

1.3 KiB Raw Blame History