]> granicus.if.org Git - curl/commitdiff
curl_easy_escape.3: mention the (lack of) encoding
authorDaniel Stenberg <daniel@haxx.se>
Fri, 7 Jul 2017 08:47:46 +0000 (10:47 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Fri, 7 Jul 2017 08:47:46 +0000 (10:47 +0200)
Fixes #1612
Reported-by: Jeroen Ooms
docs/libcurl/curl_easy_escape.3

index d2b6cd28614363e0554f752dc203751567dc684c..c8b7b6a4b1d815a18a91b6438e04834513886300 100644 (file)
@@ -5,7 +5,7 @@
 .\" *                            | (__| |_| |  _ <| |___
 .\" *                             \___|\___/|_| \_\_____|
 .\" *
-.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
+.\" * Copyright (C) 1998 - 2017, 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
@@ -39,6 +39,15 @@ If \fIlength\fP is set to 0 (zero), \fIcurl_easy_escape(3)\fP uses strlen() on
 the input \fIstring\fP to find out the size.
 
 You must \fIcurl_free(3)\fP the returned string when you're done with it.
+.SH ENCODING
+libcurl is typically not aware of, nor does it care about, character
+encodings. \fIcurl_easy_escape(3)\fP encodes the data byte-by-byte into the
+URL encoded version without knowledge or care for what particular character
+encoding the application or the receiving server may assume that the data
+uses.
+
+The caller of \fIcurl_easy_escape(3)\fP must make sure that the data passed in
+to the funtion is encoded correctly.
 .SH AVAILABILITY
 Added in 7.15.4 and replaces the old \fIcurl_escape(3)\fP function.
 .SH RETURN VALUE