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