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
66 lines
1.4 KiB
Markdown
66 lines
1.4 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: curl_unescape
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- RFC 2396
|
|
- curl_easy_escape (3)
|
|
- curl_easy_unescape (3)
|
|
- curl_free (3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
curl_unescape - URL decodes the given string
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
char *curl_unescape(const char *input, int length);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Obsolete function. Use curl_easy_unescape(3) instead.
|
|
|
|
This function converts the URL encoded string **input** to a "plain string"
|
|
and return that as a new allocated string. All input characters that are URL
|
|
encoded (%XX where XX is a two-digit hexadecimal number) are converted to
|
|
their plain text versions.
|
|
|
|
If the **length** argument is set to 0, curl_unescape(3) calls
|
|
strlen() on **input** to find out the size.
|
|
|
|
You must curl_free(3) the returned string when you are done with it.
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
char *decoded = curl_unescape("%63%75%72%6c", 12);
|
|
if(decoded) {
|
|
/* do not assume printf() works on the decoded data */
|
|
printf("Decoded: ");
|
|
/* ... */
|
|
curl_free(decoded);
|
|
}
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
Since 7.15.4, curl_easy_unescape(3) should be used. This function might
|
|
be removed in a future release.
|
|
|
|
# RETURN VALUE
|
|
|
|
A pointer to a null-terminated string or NULL if it failed.
|