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

776 B

Raw Blame History

c: Copyright (C) Daniel Stenberg, daniel@haxx.se, et al. SPDX-License-Identifier: curl Title: curl_version Section: 3 Source: libcurl See-also: - curl_version_info (3) Protocol: - *

NAME

curl_version - returns the libcurl version string

SYNOPSIS

#include <curl/curl.h>

char *curl_version();

DESCRIPTION

Returns a human readable string with the version number of libcurl and some of its important components (like OpenSSL version).

We recommend using curl_version_info(3) instead!

EXAMPLE

int main(void)
{
  printf("libcurl version %s\n", curl_version());
}

AVAILABILITY

Always

RETURN VALUE

A pointer to a null-terminated string. The string resides in a statically allocated buffer and must not be freed by the caller.

776 B Raw Blame History