mirror of
https://github.com/curl/curl.git
synced 2024-12-09 06:30:06 +08:00
230bb3e278
Make all libcurl related options use .nf (no fill) for the SYNOPSIS section - for consistent look. roffit then renders that section using <pre> (monospace font) in html for the website. Extended manpage-syntax (test 1173) with a basic check for it. Closes #8062
52 lines
1.8 KiB
Groff
52 lines
1.8 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) 1998 - 2021, 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_free 3 "12 Aug 2003" "libcurl 7.10" "libcurl Manual"
|
|
.SH NAME
|
|
curl_free - reclaim memory that has been obtained through a libcurl call
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
void curl_free(char *ptr);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
curl_free reclaims memory that has been obtained through a libcurl call. Use
|
|
\fIcurl_free(3)\fP instead of free() to avoid anomalies that can result from
|
|
differences in memory management between your application and libcurl.
|
|
|
|
Passing in a NULL pointer in \fIptr\fP will make this function return
|
|
immediately with no action.
|
|
.SH EXAMPLE
|
|
.nf
|
|
char *width = curl_getenv("COLUMNS");
|
|
if(width) {
|
|
/* it was set! */
|
|
curl_free(width);
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Always
|
|
.SH RETURN VALUE
|
|
None
|
|
.SH "SEE ALSO"
|
|
.BR curl_easy_unescape "(3), " curl_easy_escape "(3) "
|