From f5c36bf6fe736ce4c9e5ca3a8a5511b42a6bf9a9 Mon Sep 17 00:00:00 2001 From: Emanuele Torre Date: Wed, 26 Apr 2023 08:17:57 +0200 Subject: docs/libcurl/curl_*escape.3: rename "url" argument to "input"/"string" Also reword the DESCRIPTION section to mention "input"/"string" argument in bold. Closes #11027 --- docs/libcurl/curl_easy_unescape.3 | 10 +++++----- docs/libcurl/curl_escape.3 | 12 ++++++------ docs/libcurl/curl_unescape.3 | 6 +++--- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/libcurl/curl_easy_unescape.3 b/docs/libcurl/curl_easy_unescape.3 index 72026eb48..c6033f56a 100644 --- a/docs/libcurl/curl_easy_unescape.3 +++ b/docs/libcurl/curl_easy_unescape.3 @@ -33,13 +33,13 @@ char *curl_easy_unescape(CURL *curl, const char *input, int inlength, int *outlength); .fi .SH DESCRIPTION -This function converts the given URL encoded \fBinput\fP string to a "plain -string" and returns that in an allocated memory area. All input characters -that are URL encoded (%XX where XX is a two-digit hexadecimal number) are -converted to their binary versions. +This function converts the URL encoded string \fBinput\fP to a "plain string" +and returns that in an allocated memory area. All input characters that are URL +encoded (%XX where XX is a two-digit hexadecimal number) are converted to their +binary versions. If the \fBlength\fP argument is set to 0 (zero), \fIcurl_easy_unescape(3)\fP -will use strlen() on the input \fBurl\fP string to find out the size. +will use strlen() on \fBinput\fP to find out the size. If \fBoutlength\fP is non-NULL, the function will write the length of the returned string in the integer it points to. This allows proper handling even diff --git a/docs/libcurl/curl_escape.3 b/docs/libcurl/curl_escape.3 index e22aa8caa..1b29c8e70 100644 --- a/docs/libcurl/curl_escape.3 +++ b/docs/libcurl/curl_escape.3 @@ -28,18 +28,18 @@ curl_escape - URL encodes the given string .nf #include -char *curl_escape(const char *url, int length); +char *curl_escape(const char *string, int length); .fi .SH DESCRIPTION Obsolete function. Use \fIcurl_easy_escape(3)\fP instead! -This function will convert the given input string to a URL encoded string and -return that as a new allocated string. All input characters that are not a-z, -A-Z or 0-9 will be converted to their "URL escaped" version (\fB%NN\fP where -\fBNN\fP is a two-digit hexadecimal number). +This function will convert the given input \fBstring\fP to a URL encoded string +and return that as a new allocated string. All input characters that are not +a-z, A-Z or 0-9 will be converted to their "URL escaped" version (\fB%NN\fP +where \fBNN\fP is a two-digit hexadecimal number). If the \fBlength\fP argument is set to 0, \fIcurl_escape(3)\fP will use -strlen() on the input \fBurl\fP string to find out the size. +strlen() on \fBstring\fP to find out the size. You must \fIcurl_free(3)\fP the returned string when you are done with it. .SH EXAMPLE diff --git a/docs/libcurl/curl_unescape.3 b/docs/libcurl/curl_unescape.3 index 70645fe6c..5aef2e912 100644 --- a/docs/libcurl/curl_unescape.3 +++ b/docs/libcurl/curl_unescape.3 @@ -28,18 +28,18 @@ curl_unescape - URL decodes the given string .nf #include -char *curl_unescape(const char *url, int length); +char *curl_unescape(const char *input, int length); .fi .SH DESCRIPTION Obsolete function. Use \fIcurl_easy_unescape(3)\fP instead! -This function will convert the given URL encoded input string to a "plain +This function will convert the URL encoded string \fBinput\fP 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) will be converted to their plain text versions. If the \fBlength\fP argument is set to 0, \fIcurl_unescape(3)\fP will use -strlen() on the input \fBurl\fP string to find out the size. +strlen() on \fBinput\fP to find out the size. You must \fIcurl_free(3)\fP the returned string when you are done with it. .SH EXAMPLE -- cgit v1.2.1