mirror of
https://github.com/curl/curl.git
synced 2025-01-18 14:04:30 +08: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
53 lines
867 B
Markdown
53 lines
867 B
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: curl_free
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- curl_easy_escape (3)
|
|
- curl_easy_unescape (3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
curl_free - reclaim memory that has been obtained through a libcurl call
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
void curl_free(void *ptr);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
curl_free reclaims memory that has been obtained through a libcurl call. Use
|
|
curl_free(3) 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 *ptr* makes this function return immediately
|
|
with no action.
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
int main(void)
|
|
{
|
|
char *width = curl_getenv("COLUMNS");
|
|
if(width) {
|
|
/* it was set! */
|
|
curl_free(width);
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
Always
|
|
|
|
# RETURN VALUE
|
|
|
|
None
|