curl/docs/libcurl/curl_version.md
Viktor Szakats 3040971d12
GHA: silence proselint warnings and an error
Fix new issues found by `proselint`.

Also:
- silence this technical warning:
  ```
  :0: DeprecationWarning: /home/runner/.proselintrc was found instead of a JSON file. Rename to /home/runner/.proselintrc.json.
  ```
- fix an input filename.
  `proselints` fails now if an input file is missing.

Reported-by: Jay Satiro
Bug: https://github.com/curl/curl/pull/15291#issuecomment-2410505100
Closes #15293
2024-10-15 16:44:17 +02:00

50 lines
801 B
Markdown

---
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:
- All
Added-in: 7.1
---
# 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.
# %PROTOCOLS%
# EXAMPLE
~~~c
int main(void)
{
printf("libcurl version %s\n", curl_version());
}
~~~
# %AVAILABILITY%
# 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.