]> Raphaƫl G. Git Repositories - youtubedl/blob - debian/youtube-dl.pod
Imported Debian patch 2010.10.24-1
[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 -u B<UN>, --username=B<UN>
58
59 Specify the youtube account username B<UN>. Some videos require an
60 account to be downloaded, mostly because they're flagged as mature
61 content.
62
63 =item -p B<PW>, --password=B<PW>
64
65 Like the username, specifies the account password to be B<PW>.
66
67 =item -n, --netrc
68
69 Get authentication data from the standard unix .netrc file on the user's
70 home directory. The machine name is youtube regarding this usage.
71
72 =item -f B<FMT>, --format=B<FMT>
73
74 Specify the video format (quality) in which to download the video. Note
75 that not all videos are available in all formats.
76
77 =item -b, --best-quality
78
79 This option is deprecated, does nothing currently, and is expected to be
80 removed in a next release, as it is the current behavior of youtube-dl.
81
82 =item -m, --mobile-version
83
84 Synonymous to the option "-f 17", to download videos playable on some
85 mobile phones.
86
87 =item --all-formats
88
89 Downloads all formats for which a video may be available.
90
91 =item --max-quality=B<FMT>
92
93 Limit the maximum quality of the videos to downloads to B<FMT>.
94
95 =item -q, --quiet
96
97 Activates quiet mode, avoiding many messages being written to the
98 terminal.
99
100 =item -s, --simulate
101
102 Simulate the operation, but do not download the video. Useful for
103 testing.
104
105 =item -g, --get-url
106
107 Simulate the operation, like quiet mode, but show the URL that would be
108 used to download the video. Can be used with other download tools like
109 wget or aria2c.
110
111 =item -e, --get-title
112
113 Simulate the operation, like quiet mode, but show the title of the video
114 that would be downloaded.
115
116 =item --get-thumbnail
117
118 Simulate the operation, like quiet mode, but print the URL of of the video's
119 thumbnail.
120
121 =item --get-description
122
123 Simulate the operation, like quiet mode, but print the description of the
124 video.
125
126 =item --no-progress
127
128 Do not print the progress bar during downloads.
129
130 =item -t, --title
131
132 Use the title of the video in the file name used to download the video.
133
134 =item -l, --literal
135
136 Use the literal title of the video in file name used to download the
137 video. Can contain "weird" characters that are not filtered like with
138 the -t option.
139
140 =item -o B<TPL>, --output=B<TPL>
141
142 Specify a template B<TPL> for the names of the files to be created when
143 they are downloaded. The default filename is video_id.flv. But you can
144 also use the video title in the filename with the C<-t> or C<--title>
145 option, or preserve the literal title in the filename with the C<-l> or
146 C<--literal> option.
147
148 =item -a B<F>, --batch-file=B<F>
149
150 Specify the name of a file containing URLs of videos to download from
151 youtube in batch mode. The file must contain one URL per line.
152
153 =item -w, --no-overwrites
154
155 Do no overwrite already existing files.
156
157 =item -c, --continue
158
159 Resume partially downloaded files.
160
161 =back
162
163 =head1 OUTPUT TEMPLATE
164
165 The -o option allows users to indicate a template for the output file
166 names. The basic usage is not to set any template arguments when
167 downloading a single file, like in youtube-dl -o funny_video.flv
168 "http://some/video". However, it may contain special sequences that will
169 be replaced when downloading each video.
170
171 The special sequences have the format C<%(NAME)s>. To clarify, that's a
172 percent symbol followed by a name in parenthesis, followed by a
173 lowercase S. Allowed names are:
174
175 =over
176
177 =item id
178
179 The sequence will be replaced by the video identifier.
180
181 =item url
182
183 The sequence will be replaced by the video URL.
184
185 =item uploader
186
187 The sequence will be replaced by the nickname of the person who uploaded
188 the video.
189
190 =item title
191
192 The sequence will be replaced by the literal video title.
193
194 =item stitle
195
196 The sequence will be replaced by a simplified video title, restricted to
197 alphanumeric characters and dashes.
198
199 =item ext
200
201 The sequence will be replaced by the appropriate extension (like C<flv>
202 or C<mp4>).
203
204 =item epoch
205
206 The sequence will be replaced by the Unix epoch when creating the file.
207
208 =back
209
210 As you may have guessed, the default template is C<%(id)s.%(ext)s>. When
211 some command line options are used, it's replaced by other templates
212 like C<%(title)s-%(id)s.%(ext)s>. You can specify your own.
213
214 =head1 AUTHOR
215
216 youtube-dl was written by Ricardo Garcia Gonzalez and many contributors
217 from all around the internet. This manpage was written by Rogerio Brito
218 <rbrito@users.sf.net>.
219
220 =cut