From: hyc Date: Sat, 3 Jul 2010 10:25:48 +0000 (+0000) Subject: Document the escape coding used for special characters in values X-Git-Tag: v2.4~31 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=8a5901c8a74280c898deb4ebf1a2f5d6f68bce42;p=rtmpdump Document the escape coding used for special characters in values git-svn-id: svn://svn.mplayerhq.hu/rtmpdump/trunk@538 400ebc74-4327-4243-bc38-086b20814532 --- diff --git a/librtmp/librtmp.3 b/librtmp/librtmp.3 index 055b52b..a5a7558 100644 --- a/librtmp/librtmp.3 +++ b/librtmp/librtmp.3 @@ -57,14 +57,19 @@ The session handle is freed using .BR RTMP_Free (). All data is transferred using FLV format. The basic session requires -an RTMP URL. Additional options may be specified by appending -space-separated key=value pairs to the URL. The RTMP URL format -is of the form +an RTMP URL. The RTMP URL format is of the form .nf rtmp[t][e|s]://hostname[:port][/app[/playpath]] .fi Plain rtmp, as well as tunneled and encrypted sessions are supported. + +Additional options may be specified by appending space-separated +key=value pairs to the URL. Special characters in values may need +to be escaped to prevent misinterpretation by the option parser. +The escape encoding uses a backslash followed by two hexadecimal digits +representing the ASCII value of the character. E.g., spaces must +be escaped as \fB\\20\fP and backslashes must be escaped as \fB\\5c\fP. .SH OPTIONS .SS "Network Parameters" These options define how to connect to the media server.