]> Raphaƫl G. Git Repositories - youtubedl/blob - debian/youtube-dl.pod
78f44eb7920e7fb7a85047b05a1936800b971417
[youtubedl] / debian / youtube-dl.pod
1 # -*- pod -*-
2 =head1 NAME
3
4 youtube-dl - download videos from youtube.com or other video platforms
5
6 =head1 SYNOPSIS
7
8 youtube-dl [options] url ...
9
10 =head1 DESCRIPTION
11
12 youtube-dl is a script to download videos from youtube.com or any other of
13 the supported video platforms.
14
15 Currently supported sites are: CollegeHumor, Comedy Central, Dailymotion,
16 Facebook, Metacafe, MyVideo, Photobucket, The Escapist, Vimeo, Yahoo!,
17 YouTube, blip.tv, depositfiles.com, video.google.com, xvideos, Soundcloud,
18 InfoQ, Mixcloud, OpenClassRoom.
19
20 Once it is installed in your system, you should be able to call it from
21 the command line. Usage instructions are easy. Use youtube-dl followed
22 by a video URL or identifier. As an example, consider:
23
24 youtube-dl "http://www.youtube.com/watch?v=foobar"
25
26 The video will be saved to the file C<foobar.flv> in that example. Many
27 YouTube.com videos are in Flash Video format and their extension would
28 be C<flv>. Other videos are encoded in H.264 and these usually have the
29 extension C<mp4>. In Linux and other unices, video players using a
30 recent version of ffmpeg can play them. That includes MPlayer, VLC,
31 xine, among others.
32
33 =head1 OPTIONS
34
35 B<youtube-dl> accepts options in the following categories
36
37 =over
38
39 =item -h, --help
40
41 Print help text and exit.
42
43 =item -v, --version
44
45 Print program version and exit.
46
47 =item -U, --update
48
49 Update this program to the latest stable version.
50
51 =item -i, --ignore-errors
52
53 Ignore errors during download and continue processing.
54
55 =item -r B<L>, --rate-limit=B<L>
56
57 Limit the download speed to the specified maximum B<L> (e.g., 50k or 44.6m).
58
59 =item -R B<R>, --retries=B<R>
60
61 Number B<R> of retries for a given download (default is 10).
62
63 =item --playlist-start=B<N>
64
65 The number B<N> of the video in a playlist where we should start downlading
66 (default is 1).
67
68 =item --playlist-end=B<N>
69
70 The number B<N> of the video in a playlist where we should stop downloading
71 (default is -1, which stands for the last video in the playlist).
72
73 =item --dump-user-agent
74
75 Display how youtube-dl will identify itself (the User-Agent string) to the
76 remote server.
77
78 =item -u B<UN>, --username=B<UN>
79
80 Specify the youtube account username B<UN>. Some videos require an
81 account to be downloaded, mostly because they're flagged as mature
82 content.
83
84 =item -p B<PW>, --password=B<PW>
85
86 Like the username, specifies the account password to be B<PW>.
87
88 =item -n, --netrc
89
90 Get authentication data from the standard unix .netrc file on the user's
91 home directory. The machine name is youtube regarding this usage.
92
93 =item -f B<FMT>, --format=B<FMT>
94
95 Specify the video format (quality) in which to download the video.
96
97 For youtube.com, in particular, the meaning of the format codes is given as:
98
99 =over
100
101 =item WebM video at 480p: 43
102
103 =item WebM video at 720p: 45
104
105 =item H264 video in MP4 container at 480p: 18
106
107 =item H264 video in MP4 container at 720p: 22
108
109 =item H264 video in MP4 container at 1080p: 37
110
111 =item H264 video in FLV container at 360p: 34
112
113 =item H264 video in FLV container at 480p: 35
114
115 =item H263 video at 240p: 5
116
117 =item 3GP video: 17
118
119 =back
120
121 Note that not all videos are available in all formats and that other
122 sites supported by B<youtube-dl> may have different conventions for
123 their video formats.
124
125 By default, youtube-dl will download the best available format; if you want
126 to download the worst format to save bandwidth and time, use C<-f> I<worst>.
127
128 =item --all-formats
129
130 Downloads all formats for which a video may be available.
131
132 =item --max-quality=B<FMT>
133
134 Limit the maximum quality of the videos to downloads to B<FMT>.
135
136 =item -q, --quiet
137
138 Activates quiet mode, avoiding many messages being written to the
139 terminal.
140
141 =item -s, --simulate
142
143 Simulate the operation, but do not download the video. Useful for
144 testing.
145
146 =item -g, --get-url
147
148 Simulate the operation, like quiet mode, but show the URL that would be
149 used to download the video. Can be used with other download tools like
150 wget or aria2c.
151
152 =item -e, --get-title
153
154 Simulate the operation, like quiet mode, but show the title of the video
155 that would be downloaded.
156
157 =item --get-thumbnail
158
159 Simulate the operation, like quiet mode, but print the URL of of the video's
160 thumbnail.
161
162 =item --get-description
163
164 Simulate the operation, like quiet mode, but print the description of the
165 video.
166
167 =item --get-filename
168
169 Simulate the operation, like quiet mode, but print the output filename.
170
171 =item --no-progress
172
173 Do not print the progress bar during downloads.
174
175 =item --console-title
176
177 If possible, set the title of the console window with the progress of the
178 download.
179
180 =item -t, --title
181
182 Use the title of the video in the file name used to download the video.
183
184 =item -l, --literal
185
186 Use the literal title of the video in file name used to download the
187 video. Can contain "weird" characters that are not filtered like with
188 the -t option.
189
190 =item -A, --auto-number
191
192 When downloading multiple videos from a playlist, automatically number them,
193 in sequence, starting from 00000.
194
195 =item -o B<TPL>, --output=B<TPL>
196
197 Specify a template B<TPL> for the names of the files to be created when
198 they are downloaded. The default filename is video_id.flv. But you can
199 also use the video title in the filename with the C<-t> or C<--title>
200 option, or preserve the literal title in the filename with the C<-l> or
201 C<--literal> option.
202
203 =item -a B<F>, --batch-file=B<F>
204
205 Specify the name of a file containing URLs of videos to download from
206 youtube in batch mode. The file must contain one URL per line.
207
208 =item -w, --no-overwrites
209
210 Do no overwrite already existing files.
211
212 =item -c, --continue
213
214 Resume partially downloaded files.
215
216 =item --cookies=B<F>
217
218 Store the received cookies to file B<F> (the "cookie jar").
219
220 =item --no-part
221
222 Do not append the I<.part> suffix do files that have not yet been completed.
223
224 =item --no-mtime
225
226 Do not use the I<Last-modified> header to set the file modification time.
227
228 =item --extract-audio
229
230 Create an audio-only file extracted from the video downloaded. Requires that
231 ffmpeg and ffprobe be installed.
232
233 =item --audio-format=B<FORMAT>
234
235 Set the audio format to be used for the extraction. Possible values are
236 I<best>, I<aac>, I<mp3>, with I<best> being the default.
237
238 =back
239
240 =head1 OUTPUT TEMPLATE
241
242 The -o option allows users to indicate a template for the output file
243 names. The basic usage is not to set any template arguments when
244 downloading a single file, like in youtube-dl -o funny_video.flv
245 "http://some/video". However, it may contain special sequences that will
246 be replaced when downloading each video.
247
248 The special sequences have the format C<%(NAME)s>. To clarify, that's a
249 percent symbol followed by a name in parenthesis, followed by a
250 lowercase S. Allowed names are:
251
252 =over
253
254 =item id
255
256 The sequence will be replaced by the video identifier.
257
258 =item url
259
260 The sequence will be replaced by the video URL.
261
262 =item uploader
263
264 The sequence will be replaced by the nickname of the person who uploaded
265 the video.
266
267 =item title
268
269 The sequence will be replaced by the literal video title.
270
271 =item stitle
272
273 The sequence will be replaced by a simplified video title, restricted to
274 alphanumeric characters and dashes.
275
276 =item ext
277
278 The sequence will be replaced by the appropriate extension (like C<flv>
279 or C<mp4>).
280
281 =item epoch
282
283 The sequence will be replaced by the Unix epoch when creating the file.
284
285 =back
286
287 As you may have guessed, the default template is C<%(id)s.%(ext)s>. When
288 some command line options are used, it's replaced by other templates
289 like C<%(title)s-%(id)s.%(ext)s>. You can specify your own.
290
291 =head1 AUTHOR
292
293 youtube-dl was written by Ricardo Garcia Gonzalez and many contributors
294 from all around the internet. This manpage was written by Rogerio Brito
295 <rbrito@users.sf.net>.
296
297 =cut