Tell gcc about log format strings
[rtmpdump.git] / rtmpdump.1.html
blob826f722d9f149c6176f6fc4f56fa4b80b7a48b42
1 <HTML>
2 <HEAD>
3 <title>RTMPDUMP(1): </title></head>
4 <table>
5 <thead>
6 <tr><td>RTMPDUMP(1)<td align="center"><td align="right">RTMPDUMP(1)
7 </thead>
8 <tfoot>
9 <tr><td>RTMPDump v2.4<td align="center">2011-07-20<td align="right">RTMPDUMP(1)
10 </tfoot>
11 <tbody><tr><td colspan="3"><br><br><ul>
12 <!-- Copyright 2011 Howard Chu.
13 Copying permitted according to the GNU General Public License V2.-->
14 </ul>
16 <h3>NAME</h3><ul>
17 rtmpdump &minus; RTMP streaming media client
18 </ul>
20 <h3>SYNOPSIS</h3><ul>
21 <b>rtmpdump</b>
22 <b>&minus;r</b><i>&nbsp;url</i>
23 [<b>&minus;n</b><i>&nbsp;hostname</i>]
24 [<b>&minus;c</b><i>&nbsp;port</i>]
25 [<b>&minus;l</b><i>&nbsp;protocol</i>]
26 [<b>&minus;S</b><i>&nbsp;host:port</i>]
27 [<b>&minus;a</b><i>&nbsp;app</i>]
28 [<b>&minus;t</b><i>&nbsp;tcUrl</i>]
29 [<b>&minus;p</b><i>&nbsp;pageUrl</i>]
30 [<b>&minus;s</b><i>&nbsp;swfUrl</i>]
31 [<b>&minus;f</b><i>&nbsp;flashVer</i>]
32 [<b>&minus;u</b><i>&nbsp;auth</i>]
33 [<b>&minus;C</b><i>&nbsp;conndata</i>]
34 [<b>&minus;y</b><i>&nbsp;playpath</i>]
35 [<b>&minus;Y</b>]
36 [<b>&minus;v</b>]
37 [<b>&minus;d</b><i>&nbsp;subscription</i>]
38 [<b>&minus;e</b>]
39 [<b>&minus;k</b><i>&nbsp;skip</i>]
40 [<b>&minus;A</b><i>&nbsp;start</i>]
41 [<b>&minus;B</b><i>&nbsp;stop</i>]
42 [<b>&minus;b</b><i>&nbsp;buffer</i>]
43 [<b>&minus;m</b><i>&nbsp;timeout</i>]
44 [<b>&minus;T</b><i>&nbsp;key</i>]
45 [<b>&minus;j</b><i>&nbsp;JSON</i>]
46 [<b>&minus;w</b><i>&nbsp;swfHash</i>]
47 [<b>&minus;x</b><i>&nbsp;swfSize</i>]
48 [<b>&minus;W</b><i>&nbsp;swfUrl</i>]
49 [<b>&minus;X</b><i>&nbsp;swfAge</i>]
50 [<b>&minus;o</b><i>&nbsp;output</i>]
51 [<b>&minus;#</b>]
52 [<b>&minus;q</b>]
53 [<b>&minus;V</b>]
54 [<b>&minus;z</b>]
55 <br>
56 <b>rtmpdump &minus;h</b>
57 </ul>
59 <h3>DESCRIPTION</h3><ul>
60 <b>rtmpdump</b>
61 is a tool for dumping media content streamed over RTMP.
62 <p>
63 <b>rtmpdump</b>
64 makes a connection to the specified RTMP server and plays the media
65 specified by the given
66 <i>url</i>.
67 The url should be of the form
68 <pre>
69 rtmp[t][e]://hostname[:port][/app[/playpath]]
70 </pre>
71 <p>
72 Plain rtmp, as well as tunneled and encrypted sessions are supported.
73 </ul>
75 <h3>OPTIONS</h3><ul>
76 </ul>
78 <h4>Network Parameters</h4><ul>
79 These options define how to connect to the media server.
80 <p>
81 <dl compact><dt>
82 <b>&minus;&minus;rtmp &minus;r</b>&nbsp;<i>url</i>
83 <dd>
84 URL of the server and media content.
85 </dl>
86 <p>
87 <dl compact><dt>
88 <b>&minus;&minus;host &minus;n</b>&nbsp;<i>hostname</i>
89 <dd>
90 Overrides the hostname in the RTMP URL.
91 </dl>
92 <p>
93 <dl compact><dt>
94 <b>&minus;&minus;port &minus;c</b>&nbsp;<i>port</i>
95 <dd>
96 Overrides the port number in the RTMP URL.
97 </dl>
98 <p>
99 <dl compact><dt>
100 <b>&minus;&minus;protocol &minus;l</b>&nbsp;<i>number</i>
101 <dd>
102 Overrides the protocol in the RTMP URL.
103 <pre>
104 0 = rtmp
105 1 = rtmpt
106 2 = rtmpe
107 3 = rtmpte
108 4 = rtmps
109 5 = rtmpts
110 </pre>
111 </dl>
113 <dl compact><dt>
114 <b>&minus;&minus;socks &minus;S</b>&nbsp;<i>host:port</i>
115 <dd>
116 Use the specified SOCKS4 proxy.
117 </dl>
118 </ul>
120 <h4>Connection Parameters</h4><ul>
121 These options define the content of the RTMP Connect request packet.
122 If correct values are not provided, the media server will reject the
123 connection attempt.
125 <dl compact><dt>
126 <b>&minus;&minus;app &minus;a</b>&nbsp;<i>app</i>
127 <dd>
128 Name of application to connect to on the RTMP server. Overrides
129 the app in the RTMP URL. Sometimes the rtmpdump URL parser cannot
130 determine the app name automatically, so it must be given explicitly
131 using this option.
132 </dl>
134 <dl compact><dt>
135 <b>&minus;&minus;tcUrl &minus;t</b>&nbsp;<i>url</i>
136 <dd>
137 URL of the target stream. Defaults to rtmp[e]://host[:port]/app/playpath.
138 </dl>
140 <dl compact><dt>
141 <b>&minus;&minus;pageUrl &minus;p</b>&nbsp;<i>url</i>
142 <dd>
143 URL of the web page in which the media was embedded. By default no
144 value will be sent.
145 </dl>
147 <dl compact><dt>
148 <b>&minus;&minus;swfUrl &minus;s</b>&nbsp;<i>url</i>
149 <dd>
150 URL of the SWF player for the media. By default no value will be sent.
151 </dl>
153 <dl compact><dt>
154 <b>&minus;&minus;flashVer &minus;f</b>&nbsp;<i>version</i>
155 <dd>
156 Version of the Flash plugin used to run the SWF player. The
157 default is "LNX 10,0,32,18".
158 </dl>
160 <dl compact><dt>
161 <b>&minus;&minus;auth &minus;u</b>&nbsp;<i>string</i>
162 <dd>
163 An authentication string to be appended to the Connect message. Using
164 this option will append a Boolean TRUE and then the specified string.
165 This option is only used by some particular servers and is
166 deprecated. The more general
167 <b>&minus;&minus;conn</b>
168 option should be used instead.
169 </dl>
171 <dl compact><dt>
172 <b>&minus;&minus;conn &minus;C</b>&nbsp;<i>type:data</i>
173 <dd>
174 Append arbitrary AMF data to the Connect message. The type
175 must be B for Boolean, N for number, S for string, O for object, or Z
176 for null. For Booleans the data must be either 0 or 1 for FALSE or TRUE,
177 respectively. Likewise for Objects the data must be 0 or 1 to end or
178 begin an object, respectively. Data items in subobjects may be named, by
179 prefixing the type with 'N' and specifying the name before the value, e.g.
180 NB:myFlag:1. This option may be used multiple times to construct arbitrary
181 AMF sequences. E.g.
182 <pre>
183 &minus;C B:1 &minus;C S:authMe &minus;C O:1 &minus;C NN:code:1.23 &minus;C NS:flag:ok &minus;C O:0
184 </pre>
185 </dl>
186 </ul>
188 <h4>Session Parameters</h4><ul>
189 These options take effect after the Connect request has succeeded.
191 <dl compact><dt>
192 <b>&minus;&minus;playpath &minus;y</b>&nbsp;<i>path</i>
193 <dd>
194 Overrides the playpath parsed from the RTMP URL. Sometimes the
195 rtmpdump URL parser cannot determine the correct playpath
196 automatically, so it must be given explicitly using this option.
197 </dl>
199 <dl compact><dt>
200 <b>&minus;&minus;playlist &minus;Y</b>
201 <dd>
202 Issue a set_playlist command before sending the play command. The
203 playlist will just contain the current playpath.
204 </dl>
206 <dl compact><dt>
207 <b>&minus;&minus;live &minus;v</b>
208 <dd>
209 Specify that the media is a live stream. No resuming or seeking in
210 live streams is possible.
211 </dl>
213 <dl compact><dt>
214 <b>&minus;&minus;subscribe &minus;d</b>&nbsp;<i>stream</i>
215 <dd>
216 Name of live stream to subscribe to. Defaults to
217 <i>playpath</i>.
218 </dl>
220 <dl compact><dt>
221 <b>&minus;&minus;resume &minus;e</b>
222 <dd>
223 Resume an incomplete RTMP download.
224 </dl>
226 <dl compact><dt>
227 <b>&minus;&minus;skip &minus;k</b>&nbsp;<i>num</i>
228 <dd>
229 Skip
230 <i>num</i>
231 keyframes when looking for the last keyframe from which to resume. This
232 may be useful if a regular attempt to resume fails. The default is 0.
233 </dl>
235 <dl compact><dt>
236 <b>&minus;&minus;start &minus;A</b>&nbsp;<i>num</i>
237 <dd>
238 Start at
239 <i>num</i>
240 seconds into the stream. Not valid for live streams.
241 </dl>
243 <dl compact><dt>
244 <b>&minus;&minus;stop &minus;B</b>&nbsp;<i>num</i>
245 <dd>
246 Stop at
247 <i>num</i>
248 seconds into the stream.
249 </dl>
251 <dl compact><dt>
252 <b>&minus;&minus;buffer &minus;b</b>&nbsp;<i>num</i>
253 <dd>
254 Set buffer time to
255 <i>num</i>
256 milliseconds. The default is 36000000.
257 </dl>
259 <dl compact><dt>
260 <b>&minus;&minus;timeout &minus;m</b>&nbsp;<i>num</i>
261 <dd>
262 Timeout the session after
263 <i>num</i>
264 seconds without receiving any data from the server. The default is 120.
265 </dl>
266 </ul>
268 <h4>Security Parameters</h4><ul>
269 These options handle additional authentication requests from the server.
271 <dl compact><dt>
272 <b>&minus;&minus;token &minus;T</b>&nbsp;<i>key</i>
273 <dd>
274 Key for SecureToken response, used if the server requires SecureToken
275 authentication.
276 </dl>
278 <dl compact><dt>
279 <b>&minus;&minus;jtv &minus;j</b>&nbsp;<i>JSON</i>
280 <dd>
281 JSON token used by legacy Justin.tv servers. Invokes NetStream.Authenticate.UsherToken
282 </dl>
284 <dl compact><dt>
285 <b>&minus;&minus;swfhash &minus;w</b>&nbsp;<i>hexstring</i>
286 <dd>
287 SHA256 hash of the decompressed SWF file. This option may be needed if
288 the server uses SWF Verification, but see the
289 <b>&minus;&minus;swfVfy</b>
290 option below. The hash is 32 bytes, and must be
291 given in hexadecimal. The
292 <b>&minus;&minus;swfsize</b>
293 option must always be used with this option.
294 </dl>
296 <dl compact><dt>
297 <b>&minus;&minus;swfsize &minus;x</b>&nbsp;<i>num</i>
298 <dd>
299 Size of the decompressed SWF file. This option may be needed if the
300 server uses SWF Verification, but see the
301 <b>&minus;&minus;swfVfy</b>
302 option below. The
303 <b>&minus;&minus;swfhash</b>
304 option must always be used with this option.
305 </dl>
307 <dl compact><dt>
308 <b>&minus;&minus;swfVfy &minus;W</b>&nbsp;<i>url</i>
309 <dd>
310 URL of the SWF player for this media. This option replaces all three
311 of the
312 <b>&minus;&minus;swfUrl</b>,
313 <b>&minus;&minus;swfhash</b>,
315 <b>&minus;&minus;swfsize</b>
316 options. When this option is used, the SWF player is retrieved from the
317 specified URL and the hash and size are computed automatically. Also
318 the information is cached in a
319 <i>.swfinfo</i>
320 file in the user's home directory, so that it doesn't need to be retrieved
321 and recalculated every time rtmpdump is run. The .swfinfo file records
322 the URL, the time it was fetched, the modification timestamp of the SWF
323 file, its size, and its hash. By default, the cached info will be used
324 for 30 days before re-checking.
325 </dl>
327 <dl compact><dt>
328 <b>&minus;&minus;swfAge &minus;X</b>&nbsp;<i>days</i>
329 <dd>
330 Specify how many days to use the cached SWF info before re-checking. Use
331 0 to always check the SWF URL. Note that if the check shows that the
332 SWF file has the same modification timestamp as before, it will not be
333 retrieved again.
334 </dl>
335 </ul>
337 <h4>Miscellaneous</h4><ul>
339 <dl compact><dt>
340 <b>&minus;&minus;flv &minus;o</b>&nbsp;<i>output</i>
341 <dd>
342 Specify the output file name. If the name is &minus; or is omitted, the
343 stream is written to stdout.
344 </dl>
346 <dl compact><dt>
347 <b>&minus;&minus;hashes &minus;#</b>
348 <dd>
349 Display streaming progress with a hash mark for each 1% of progress, instead
350 of a byte counter.
351 </dl>
353 <dl compact><dt>
354 <b>&minus;&minus;quiet &minus;q</b>
355 <dd>
356 Suppress all command output.
357 </dl>
359 <dl compact><dt>
360 <b>&minus;&minus;verbose &minus;V</b>
361 <dd>
362 Verbose command output.
363 </dl>
365 <dl compact><dt>
366 <b>&minus;&minus;debug &minus;z</b>
367 <dd>
368 Debug level output. Extremely verbose, including hex dumps of all packet data.
369 </dl>
371 <dl compact><dt>
372 <b>&minus;&minus;help &minus;h</b>
373 <dd>
374 Print a summary of command options.
375 </dl>
376 </ul>
378 <h3>EXIT STATUS</h3><ul>
380 <dl compact><dt>
381 <b>0</b>
382 <dd>
383 Successful program execution.
384 </dl>
386 <dl compact><dt>
387 <b>1</b>
388 <dd>
389 Unrecoverable error.
390 </dl>
392 <dl compact><dt>
393 <b>2</b>
394 <dd>
395 Incomplete transfer, resuming may get further.
396 </dl>
397 </ul>
399 <h3>ENVIRONMENT</h3><ul>
401 <dl compact><dt>
402 <b>HOME</b>
403 <dd>
404 The value of
405 $<b>HOME</b>
406 is used as the location for the
407 <i>.swfinfo</i>
408 file.
409 </dl>
410 </ul>
412 <h3>FILES</h3><ul>
414 <dl compact><dt>
415 <i>$HOME/.swfinfo</i>
416 <dd>
417 Cache of SWF Verification information
418 </dl>
419 </ul>
421 <h3>SEE ALSO</h3><ul>
422 <a href="../man8/rtmpgw.8"><b>rtmpgw</b></a>(8)
423 </ul>
425 <h3>AUTHORS</h3><ul>
426 Andrej Stepanchuk, Howard Chu, The Flvstreamer Team
427 <br>
428 &lt;<a href="http://rtmpdump.mplayerhq.hu">http://rtmpdump.mplayerhq.hu</a>>
429 </ul></tbody></table></html>