curl/docs/libcurl/curl_version.3

.\" **************************************************************************
.\" *                                  _   _ ____  _
.\" *  Project                     ___| | | |  _ \| |
.\" *                             / __| | | | |_) | |
.\" *                            | (__| |_| |  _ <| |___
.\" *                             \___|\___/|_| \_\_____|
.\" *
.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
.\" * are also available at https://curl.se/docs/copyright.html.
.\" *
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
.\" * copies of the Software, and permit persons to whom the Software is
.\" * furnished to do so, under the terms of the COPYING file.
.\" *
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
.\" * KIND, either express or implied.
.\" *
.\" **************************************************************************
.TH curl_version 3 "5 March 2001" "libcurl 7.0" "libcurl Manual"
.SH NAME
curl_version - returns the libcurl version string
.SH SYNOPSIS
.B #include <curl/curl.h>
.sp
.BI "char *curl_version( );"
.ad
.SH DESCRIPTION
Returns a human readable string with the version number of libcurl and some of
its important components (like OpenSSL version).

We recommend using \fIcurl_version_info(3)\fP instead!
.SH 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.
.SH "SEE ALSO"
.BR curl_version_info "(3)"
source header: added to more files 2011-03-11 18:14:32 -05:00			`.\" **************************************************************************`
			`.\" * _ _ ____ _`
			`.\" * Project ___\| \| \| \| _ \\| \|`
			`.\" * / __\| \| \| \| \|_) \| \|`
			`.\" * \| (__\| \|_\| \| _ <\| \|___`
			`.\" * \___\|\___/\|_\| \_\_____\|`
			`.\" *`
copyright: fix out-of-date copyright ranges and missing headers Reported by the new script 'scripts/copyright.pl'. The script has a regex whitelist for the files that don't need copyright headers. Removed three (mostly usesless) README files from docs/ Closes #5141 2020-03-23 09:44:29 -04:00			`.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.`
source header: added to more files 2011-03-11 18:14:32 -05:00			`.\" *`
			`.\" * This software is licensed as described in the file COPYING, which`
			`.\" * you should have received as part of this distribution. The terms`
curl.se: new home Closes #6172 2020-11-04 08:02:01 -05:00			`.\" * are also available at https://curl.se/docs/copyright.html.`
source header: added to more files 2011-03-11 18:14:32 -05:00			`.\" *`
			`.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell`
			`.\" * copies of the Software, and permit persons to whom the Software is`
			`.\" * furnished to do so, under the terms of the COPYING file.`
			`.\" *`
			`.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY`
			`.\" * KIND, either express or implied.`
			`.\" *`
			`.\" **************************************************************************`
ripped out from ../ and put in its own directory now 2002-03-04 05:09:48 -05:00			`.TH curl_version 3 "5 March 2001" "libcurl 7.0" "libcurl Manual"`
			`.SH NAME`
			`curl_version - returns the libcurl version string`
			`.SH SYNOPSIS`
			`.B #include <curl/curl.h>`
			`.sp`
			`.BI "char *curl_version( );"`
			`.ad`
			`.SH DESCRIPTION`
			`Returns a human readable string with the version number of libcurl and some of`
			`its important components (like OpenSSL version).`
curl_version.3: recommend using curl_version_info() instead 2014-02-18 02:59:56 -05:00
			`We recommend using \fIcurl_version_info(3)\fP instead!`
ripped out from ../ and put in its own directory now 2002-03-04 05:09:48 -05:00			`.SH RETURN VALUE`
terminology: call them null-terminated strings Updated terminology in docs, comments and phrases to refer to C strings as "null-terminated". Done to unify with how most other C oriented docs refer of them and what users in general seem to prefer (based on a single highly unscientific poll on twitter). Reported-by: coinhubs on github Fixes #5598 Closes #5608 2020-06-25 05:38:25 -04:00			`A pointer to a null-terminated string. The string resides in a statically`
libcurl documentation: clarifications and typos * Elaborates on default values of some curl_easy_setopt() options. * Reminds the user to cast variadic arguments to curl_easy_setopt() to 'void ' where curl internally interprets them as such. Clarifies the working of the CURLOPT_SEEKFUNCTION option for curl_easy_setopt(). * Fixes typo 'forth' → 'fourth'. * Elaborates on CURL_SOCKET_TIMEOUT. * Adds some missing periods. * Notes that the return value of curl_version() must not be passed to free(). 2013-02-22 07:06:54 -05:00			`allocated buffer and must not be freed by the caller.`
ripped out from ../ and put in its own directory now 2002-03-04 05:09:48 -05:00			`.SH "SEE ALSO"`
mention curl_version_info 2003-08-11 19:07:38 -04:00			`.BR curl_version_info "(3)"`