url encode docs: mention '-', '.', '_' and '~'
authorDaniel Stenberg <daniel@haxx.se>
Mon, 2 May 2011 09:14:30 +0000 (11:14 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Mon, 2 May 2011 09:14:30 +0000 (11:14 +0200)
Clarify that the '-', '.', '_' or '~' letters are also not escaped since
they shouldn't according to RFC3986 section 2.3.

This is how this function has behaved since sep 2010, commit
5df13c31735fa0.

docs/libcurl/curl_easy_escape.3

index 2c09875..3a98e6f 100644 (file)
@@ -5,7 +5,7 @@
 .\" *                            | (__| |_| |  _ <| |___
 .\" *                             \___|\___/|_| \_\_____|
 .\" *
-.\" * Copyright (C) 1998 - 2008, Daniel Stenberg, <daniel@haxx.se>, et al.
+.\" * Copyright (C) 1998 - 2011, 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
@@ -31,8 +31,8 @@ curl_easy_escape - URL encodes the given string
 .SH DESCRIPTION
 This function converts the given input string to an URL encoded string and
 returns that as a new allocated string. All input characters that are not a-z,
-A-Z or 0-9 are converted to their "URL escaped" version (%NN where NN is a
-two-digit hexadecimal number).
+A-Z, 0-9, '-', '.', '_' or '~' are converted to their "URL escaped" version
+(%NN where NN is a two-digit hexadecimal number).
 
 If the \fBlength\fP argument is set to 0 (zero), \fIcurl_easy_escape(3)\fP
 uses strlen() on the input \fBurl\fP to find out the size.