From 25dcbb01c1ab0aae80ddfead19396312e1629b1a Mon Sep 17 00:00:00 2001 From: hyc Date: Fri, 5 Mar 2010 20:31:18 +0000 Subject: [PATCH] Add HTML versions of manpages git-svn-id: svn://svn.mplayerhq.hu/rtmpdump/trunk@298 400ebc74-4327-4243-bc38-086b20814532 --- rtmpdump.1 | 4 + rtmpdump.1.html | 410 ++++++++++++++++++++++++++++++++++++++++++++++++ rtmpgw.8 | 6 +- rtmpgw.8.html | 380 ++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 799 insertions(+), 1 deletion(-) create mode 100644 rtmpdump.1.html create mode 100644 rtmpgw.8.html diff --git a/rtmpdump.1 b/rtmpdump.1 index a6f06cc..52a42a4 100644 --- a/rtmpdump.1 +++ b/rtmpdump.1 @@ -1,4 +1,6 @@ .TH RTMPDUMP 1 "2010-03-04" "RTMPDump v2.2" +.\" Copyright 2010 Howard Chu. +.\" Copying permitted according to the GNU General Public License V2. .SH NAME rtmpdump \- RTMP streaming media client .SH SYNOPSIS @@ -284,3 +286,5 @@ Cache of SWF Verification information .BR rtmpgw (8) .SH AUTHORS Andrej Stepanchuk, Howard Chu, The Flvstreamer Team +.br + diff --git a/rtmpdump.1.html b/rtmpdump.1.html new file mode 100644 index 0000000..07543f7 --- /dev/null +++ b/rtmpdump.1.html @@ -0,0 +1,410 @@ + + +RTMPDUMP(1): + + + + + +
RTMPDUMP(1)RTMPDUMP(1) +
RTMPDump v2.22010-03-04RTMPDUMP(1) +


    + +
+ +

NAME

    +rtmpdump − RTMP streaming media client +
+ +

SYNOPSIS

    +rtmpdump +−r url +[−n hostname] +[−c port] +[−l protocol] +[−S host:port] +[−a app] +[−t tcUrl] +[−p pageUrl] +[−s swfUrl] +[−f flashVer] +[−u auth] +[−C conndata] +[−y playpath] +[−v] +[−d subscription] +[−e] +[−k skip] +[−A start] +[−B stop] +[−b buffer] +[−m timeout] +[−T key] +[−w swfHash] +[−x swfSize] +[−W swfUrl] +[−X swfAge] +[−o output] +[−#] +[−q] +[−V] +[−z] +
    +rtmpdump −h +
+ +

DESCRIPTION

    +rtmpdump +is a tool for dumping media content streamed over RTMP. +

    +rtmpdump +makes a connection to the specified RTMP server and plays the media +specified by the given +url. +The url should be of the form +

    +  rtmp[e]://hostname[:port][/app[/playpath]]
+
    +

    +Both plaintext +rtmp:// +and encrypted +rtmpe:// +sessions are supported. +

+ +

OPTIONS

    +
+ +

Network Parameters

    +These options define how to connect to the media server. +

    +

    +−−rtmp −r url +
    +URL of the server and media content. +
    +

    +

    +−−host −n hostname +
    +Overrides the hostname in the RTMP URL. +
    +

    +

    +−−port −c port +
    +Overrides the port number in the RTMP URL. +
    +

    +

    +−−protocol −l number +
    +Overrides the protocol in the RTMP URL. 0 = rtmp, 3 = rtmpe +
    +

    +

    +−−socks −S host:port +
    +Use the specified SOCKS4 proxy. +
    +
+ +

Connection Parameters

    +These options define the content of the RTMP Connect request packet. +If correct values are not provided, the media server will reject the +connection attempt. +

    +

    +−−app −a app +
    +Name of application to connect to on the RTMP server. Overrides +the app in the RTMP URL. Sometimes the rtmpdump URL parser cannot +determine the app name automatically, so it must be given explicitly +using this option. +
    +

    +

    +−−tcUrl −t url +
    +URL of the target stream. Defaults to rtmp[e]://host[:port]/app/playpath. +
    +

    +

    +−−pageUrl −p url +
    +URL of the web page in which the media was embedded. By default no +value will be sent. +
    +

    +

    +−−swfUrl −s url +
    +URL of the SWF player for the media. By default no value will be sent. +
    +

    +

    +−−flashVer −f version +
    +Version of the Flash plugin used to run the SWF player. The +default is "LNX 10,0,22,87". +
    +

    +

    +−−auth −a string +
    +An authentication string to be appended to the Connect message. Using +this option will append a Boolean TRUE and then the specified string. +This option is only used by some particular servers and is +deprecated. The more general +−−conn +option should be used instead. +
    +

    +

    +−−conn −C type:data +
    +Append arbitrary AMF data to the Connect message. The type +must be B for Boolean, N for number, S for string, O for object, or Z +for null. For Booleans the data must be either 0 or 1 for FALSE or TRUE, +respectively. Likewise for Objects the data must be 0 or 1 to end or +begin an object, respectively. Data items in subobjects may be named, by +prefixing the type with 'N' and specifying the name before the value, e.g. +NB:myFlag:1. This option may be used multiple times to construct arbitrary +AMF sequences. E.g. +
    +  -C B:1 -C S:authMe -C O:1 -C NN:code:1.23 -C NS:flag:ok -C O:0
+
    +
    +
+ +

Session Parameters

    +These options take effect after the Connect request has succeeded. +

    +

    +−−playpath −y path +
    +Overrides the playpath parsed from the RTMP URL. Sometimes the +rtmpdump URL parser cannot determine the correct playpath +automatically, so it must be given explicitly using this option. +
    +

    +

    +−−live −v +
    +Specify that the media is a live stream. No resuming or seeking in +live streams is possible. +
    +

    +

    +−−subscribe −d stream +
    +Name of live stream to subscribe to. Defaults to +playpath. +
    +

    +

    +−−resume −e +
    +Resume an incomplete RTMP download. +
    +

    +

    +−−skip −k num +
    +Skip +num +keyframes when looking for the last keyframe from which to resume. This +may be useful if a regular attempt to resume fails. The default is 0. +
    +

    +

    +−−start −A num +
    +Start at +num +seconds into the stream. Not valid for live streams. +
    +

    +

    +−−stop −B num +
    +Stop at +num +seconds into the stream. +
    +

    +

    +−−buffer −b num +
    +Set buffer time to +num +milliseconds. The default is 36000000. +
    +

    +

    +−−timeout −m num +
    +Timeout the session after +num +seconds without receiving any data from the server. The default is 120. +
    +
+ +

Security Parameters

    +These options handle additional authentication requests from the server. +

    +

    +−−token −T key +
    +Key for SecureToken response, used if the server requires SecureToken +authentication. +
    +

    +

    +−−swfhash −w hexstring +
    +SHA256 hash of the decompressed SWF file. This option may be needed if +the server uses SWF Verification, but see the +−−swfVfy +option below. The hash is 32 bytes, and must be +given in hexadecimal. The +−−swfsize +option must always be used with this option. +
    +

    +

    +−−swfsize −x num +
    +Size of the decompressed SWF file. This option may be needed if the +server uses SWF Verification, but see the +−−swfVfy +option below. The +−−swfhash +option must always be used with this option. +
    +

    +

    +−−swfVfy −W url +
    +URL of the SWF player for this media. This option replaces all three +of the +−−swfUrl, +−−swfhash, +and +−−swfsize +options. When this option is used, the SWF player is retrieved from the +specified URL and the hash and size are computed automatically. Also +the information is cached in a +.swfinfo +file in the user's home directory, so that it doesn't need to be retrieved +and recalculated every time rtmpdump is run. The .swfinfo file records +the URL, the time it was fetched, the modification timestamp of the SWF +file, its size, and its hash. By default, the cached info will be used +for 30 days before re-checking. +
    +

    +

    +−−swfAge −X days +
    +Specify how many days to use the cached SWF info before re-checking. Use +0 to always check the SWF URL. Note that if the check shows that the +SWF file has the same modification timestamp as before, it will not be +retrieved again. +
    +
+ +

Miscellaneous

    +

    +

    +−−flv −o output +
    +Specify the output file name. If the name is − or is omitted, the +stream is written to stdout. +
    +

    +

    +−−hashes −# +
    +Display streaming progress with a hash mark for each 1% of progress, instead +of a byte counter. +
    +

    +

    +−−quiet −q +
    +Suppress all command output. +
    +

    +

    +−−verbose −V +
    +Verbose command output. +
    +

    +

    +−−debug −z +
    +Debug level output. Extremely verbose, including hex dumps of all packet data. +
    +

    +

    +−−help −h +
    +Print a summary of command options. +
    +
+ +

EXIT STATUS

    +

    +

    +0 +
    +Successful program execution. +
    +

    +

    +1 +
    +Unrecoverable error. +
    +

    +

    +2 +
    +Incomplete transfer, resuming may get further. +
    +
+ +

ENVIRONMENT

    +

    +

    +HOME +
    +The value of +$HOME +is used as the location for the +.swfinfo +file. +
    +
+ +

FILES

    +

    +

    +$HOME/.swfinfo +
    +Cache of SWF Verification information +
    +
+ +

SEE ALSO

+ +

AUTHORS

diff --git a/rtmpgw.8 b/rtmpgw.8 index 1acb2a3..6a2327f 100644 --- a/rtmpgw.8 +++ b/rtmpgw.8 @@ -1,4 +1,6 @@ -.TH RTMPGW 1 "2010-03-04" "RTMPDump v2.2" +.TH RTMPGW 8 "2010-03-04" "RTMPDump v2.2" +.\" Copyright 2010 Howard Chu. +.\" Copying permitted according to the GNU General Public License V2. .SH NAME rtmpgw \- RTMP streaming media gateway .SH SYNOPSIS @@ -270,3 +272,5 @@ Cache of SWF Verification information .BR rtmpdump (1) .SH AUTHORS Andrej Stepanchuk, Howard Chu, The Flvstreamer Team +.br + diff --git a/rtmpgw.8.html b/rtmpgw.8.html new file mode 100644 index 0000000..1254638 --- /dev/null +++ b/rtmpgw.8.html @@ -0,0 +1,380 @@ + + +RTMPGW(8): + + + + + +
RTMPGW(8)RTMPGW(8) +
RTMPDump v2.22010-03-04RTMPGW(8) +


    + +
+ +

NAME

    +rtmpgw − RTMP streaming media gateway +
+ +

SYNOPSIS

    +rtmpgw +[−r url] +[−n hostname] +[−c port] +[−l protocol] +[−S host:port] +[−a app] +[−t tcUrl] +[−p pageUrl] +[−s swfUrl] +[−f flashVer] +[−u auth] +[−C conndata] +[−y playpath] +[−v] +[−d subscription] +[−e] +[−k skip] +[−A start] +[−B stop] +[−b buffer] +[−m timeout] +[−T key] +[−w swfHash] +[−x swfSize] +[−W swfUrl] +[−X swfAge] +[−D address] +[−g port] +[−q] +[−V] +[−z] +
    +rtmpgw −h +
+ +

DESCRIPTION

    +rtmpgw +is a server for streaming media content from RTMP out to HTTP. +

    +rtmpgw +listens for HTTP requests that specify RTMP stream parameters and +then returns the RTMP data in the HTTP response. The only valid +HTTP request is "GET /" but additional options can be provided +in URL-encoded fashion. Options specified on the command line will +be used as defaults, which can be overridden by options in the HTTP +request. +

+ +

OPTIONS

    +
+ +

Network Parameters

    +These options define how to connect to the media server. +

    +

    +−−rtmp −r url +
    +URL of the server and media content. +
    +

    +

    +−−host −n hostname +
    +Overrides the hostname in the RTMP URL. +
    +

    +

    +−−port −c port +
    +Overrides the port number in the RTMP URL. +
    +

    +

    +−−protocol −l number +
    +Overrides the protocol in the RTMP URL. 0 = rtmp, 3 = rtmpe +
    +

    +

    +−−socks −S host:port +
    +Use the specified SOCKS4 proxy. +
    +
+ +

Connection Parameters

    +These options define the content of the RTMP Connect request packet. +If correct values are not provided, the media server will reject the +connection attempt. +

    +

    +−−app −a app +
    +Name of application to connect to on the RTMP server. Overrides +the app in the RTMP URL. Sometimes the rtmpdump URL parser cannot +determine the app name automatically, so it must be given explicitly +using this option. +
    +

    +

    +−−tcUrl −t url +
    +URL of the target stream. Defaults to rtmp[e]://host[:port]/app/playpath. +
    +

    +

    +−−pageUrl −p url +
    +URL of the web page in which the media was embedded. By default no +value will be sent. +
    +

    +

    +−−swfUrl −s url +
    +URL of the SWF player for the media. By default no value will be sent. +
    +

    +

    +−−flashVer −f version +
    +Version of the Flash plugin used to run the SWF player. The +default is "LNX 10,0,22,87". +
    +

    +

    +−−auth −a string +
    +An authentication string to be appended to the Connect message. Using +this option will append a Boolean TRUE and then the specified string. +This option is only used by some particular servers and is +deprecated. The more general +−−conn +option should be used instead. +
    +

    +

    +−−conn −C type:data +
    +Append arbitrary AMF data to the Connect message. The type +must be B for Boolean, N for number, S for string, O for object, or Z +for null. For Booleans the data must be either 0 or 1 for FALSE or TRUE, +respectively. Likewise for Objects the data must be 0 or 1 to end or +begin an object, respectively. Data items in subobjects may be named, by +prefixing the type with 'N' and specifying the name before the value, e.g. +NB:myFlag:1. This option may be used multiple times to construct arbitrary +AMF sequences. E.g. +
    +  -C B:1 -C S:authMe -C O:1 -C NN:code:1.23 -C NS:flag:ok -C O:0
+
    +
    +
+ +

Session Parameters

    +These options take effect after the Connect request has succeeded. +

    +

    +−−playpath −y path +
    +Overrides the playpath parsed from the RTMP URL. Sometimes the +rtmpdump URL parser cannot determine the correct playpath +automatically, so it must be given explicitly using this option. +
    +

    +

    +−−live −v +
    +Specify that the media is a live stream. No resuming or seeking in +live streams is possible. +
    +

    +

    +−−subscribe −d stream +
    +Name of live stream to subscribe to. Defaults to +playpath. +
    +

    +

    +−−start −A num +
    +Start at +num +seconds into the stream. Not valid for live streams. +
    +

    +

    +−−stop −B num +
    +Stop at +num +seconds into the stream. +
    +

    +

    +−−buffer −b num +
    +Set buffer time to +num +milliseconds. The default is 20000. +
    +

    +

    +−−timeout −m num +
    +Timeout the session after +num +seconds without receiving any data from the server. The default is 120. +
    +
+ +

Security Parameters

    +These options handle additional authentication requests from the server. +

    +

    +−−token −T key +
    +Key for SecureToken response, used if the server requires SecureToken +authentication. +
    +

    +

    +−−swfhash −w hexstring +
    +SHA256 hash of the decompressed SWF file. This option may be needed if +the server uses SWF Verification, but see the +−−swfVfy +option below. The hash is 32 bytes, and must be +given in hexadecimal. The +−−swfsize +option must always be used with this option. +
    +

    +

    +−−swfsize −x num +
    +Size of the decompressed SWF file. This option may be needed if the +server uses SWF Verification, but see the +−−swfVfy +option below. The +−−swfhash +option must always be used with this option. +
    +

    +

    +−−swfVfy −W url +
    +URL of the SWF player for this media. This option replaces all three +of the +−−swfUrl, +−−swfhash, +and +−−swfsize +options. When this option is used, the SWF player is retrieved from the +specified URL and the hash and size are computed automatically. Also +the information is cached in a +.swfinfo +file in the user's home directory, so that it doesn't need to be retrieved +and recalculated every time rtmpdump is run. The .swfinfo file records +the URL, the time it was fetched, the modification timestamp of the SWF +file, its size, and its hash. By default, the cached info will be used +for 30 days before re-checking. +
    +

    +

    +−−swfAge −X days +
    +Specify how many days to use the cached SWF info before re-checking. Use +0 to always check the SWF URL. Note that if the check shows that the +SWF file has the same modification timestamp as before, it will not be +retrieved again. +
    +
+ +

Miscellaneous

    +

    +

    +−−device −D address +
    +Listener IP address. The default is 0.0.0.0, i.e., any IP address. +
    +

    +

    +−−sport −g port +
    +Listener port. The default is 80. +
    +

    +

    +−−quiet −q +
    +Suppress all command output. +
    +

    +

    +−−verbose −V +
    +Verbose command output. +
    +

    +

    +−−debug −z +
    +Debug level output. Extremely verbose, including hex dumps of all packet data. +
    +

    +

    +−−help −h +
    +Print a summary of command options. +
    +
+ +

EXAMPLES

    +The HTTP request +
    +	GET /?r=rtmp:%2f%2fserver%2fmyapp&y=somefile HTTP/1.0
+
    +is equivalent to the +rtrmpdump(1) +invocation +
    +	rtmpdump -r rtmp://server/myapp -y somefile
+
    +

    +Note that only the shortform (single letter) options are supported. +

+ +

ENVIRONMENT

    +

    +

    +HOME +
    +The value of +$HOME +is used as the location for the +.swfinfo +file. +
    +
+ +

FILES

    +

    +

    +$HOME/.swfinfo +
    +Cache of SWF Verification information +
    +
+ +

SEE ALSO

+ +

AUTHORS

-- 2.40.0