From: Daniel Stenberg <daniel@haxx.se>
Date: Fri, 13 Sep 2013 12:06:00 +0000 (+0200)
Subject: curl_easy_setopt.3: mention RTMP URL quirks
X-Git-Tag: curl-7_33_0~99
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=8a6dba520bfc81a5bc6ffcd38bedc73b8e520c8e;p=curl

curl_easy_setopt.3: mention RTMP URL quirks

URL: http://curl.haxx.se/bug/view.cgi?id=1278
Reported-by: Gorilla Maguila
---

diff --git a/docs/libcurl/curl_easy_setopt.3 b/docs/libcurl/curl_easy_setopt.3
index b370855f9..a2b40e0c3 100644
--- a/docs/libcurl/curl_easy_setopt.3
+++ b/docs/libcurl/curl_easy_setopt.3
@@ -891,6 +891,19 @@ Active Directory server.
 For more information about the individual components of a LDAP URL please
 see RFC4516.
 
+.B RTMP
+
+There's no official URL spec for RTMP so libcurl uses the URL syntax supported
+by the underlying librtmp library. It has a syntax where it wants a
+traditional URL, followed by a space and a series of space-separated
+name=value pairs.
+
+While space is not typically a "legal" letter, libcurl accepts them. When a
+user wants to pass in a '#' (hash) character it will be treated as a fragment
+and get cut off by libcurl if provided literally. You will instead have to
+escape it by providing it as backslash and its ASCII value in hexadecimal:
+"\\23".
+
 .B NOTES
 
 Starting with version 7.20.0, the fragment part of the URI will not be sent as