mirror of
https://github.com/curl/curl.git
synced 2026-05-30 09:37:28 +03:00
eefcc1bda4
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
46 lines
755 B
Markdown
46 lines
755 B
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: curl_version
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- curl_version_info (3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
curl_version - returns the libcurl version string
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#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
|
|
|
|
~~~c
|
|
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.
|