Raphaël G. Git Repositories - youtubedl/blob - 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.
 116
 117 =item --all-formats
 118
 119 Downloads all formats for which a video may be available.
 120
 121 =item --max-quality=B<FMT>
 122
 123 Limit the maximum quality of the videos to downloads to B<FMT>.
 124
 125 =item -q, --quiet
 126
 127 Activates quiet mode, avoiding many messages being written to the
 128 terminal.
 129
 130 =item -s, --simulate
 131
 132 Simulate the operation, but do not download the video. Useful for
 133 testing.
 134
 135 =item -g, --get-url
 136
 137 Simulate the operation, like quiet mode, but show the URL that would be
 138 used to download the video. Can be used with other download tools like
 139 wget or aria2c.
 140
 141 =item -e, --get-title
 142
 143 Simulate the operation, like quiet mode, but show the title of the video
 144 that would be downloaded.
 145
 146 =item --get-thumbnail
 147
 148 Simulate the operation, like quiet mode, but print the URL of of the video's
 149 thumbnail.
 150
 151 =item --get-description
 152
 153 Simulate the operation, like quiet mode, but print the description of the
 154 video.
 155
 156 =item --get-filename
 157
 158 Simulate the operation, like quiet mode, but print the output filename.
 159
 160 =item --no-progress
 161
 162 Do not print the progress bar during downloads.
 163
 164 =item --console-title
 165
 166 If possible, set the title of the console window with the progress of the
 167 download.
 168
 169 =item -t, --title
 170
 171 Use the title of the video in the file name used to download the video.
 172
 173 =item -l, --literal
 174
 175 Use the literal title of the video in file name used to download the
 176 video. Can contain "weird" characters that are not filtered like with
 177 the -t option.
 178
 179 =item -A, --auto-number
 180
 181 When downloading multiple videos from a playlist, automatically number them,
 182 in sequence, starting from 00000.
 183
 184 =item -o B<TPL>, --output=B<TPL>
 185
 186 Specify a template B<TPL> for the names of the files to be created when
 187 they are downloaded. The default filename is video_id.flv. But you can
 188 also use the video title in the filename with the C<-t> or C<--title>
 189 option, or preserve the literal title in the filename with the C<-l> or
 190 C<--literal> option.
 191
 192 =item -a B<F>, --batch-file=B<F>
 193
 194 Specify the name of a file containing URLs of videos to download from
 195 youtube in batch mode. The file must contain one URL per line.
 196
 197 =item -w, --no-overwrites
 198
 199 Do no overwrite already existing files.
 200
 201 =item -c, --continue
 202
 203 Resume partially downloaded files.
 204
 205 =item --cookies=B<F>
 206
 207 Store the received cookies to file B<F> (the "cookie jar").
 208
 209 =item --no-part
 210
 211 Do not append the I<.part> suffix do files that have not yet been completed.
 212
 213 =item --no-mtime
 214
 215 Do not use the I<Last-modified> header to set the file modification time.
 216
 217 =back
 218
 219 =head1 OUTPUT TEMPLATE
 220
 221 The -o option allows users to indicate a template for the output file
 222 names. The basic usage is not to set any template arguments when
 223 downloading a single file, like in youtube-dl -o funny_video.flv
 224 "http://some/video". However, it may contain special sequences that will
 225 be replaced when downloading each video.
 226
 227 The special sequences have the format C<%(NAME)s>. To clarify, that's a
 228 percent symbol followed by a name in parenthesis, followed by a
 229 lowercase S. Allowed names are:
 230
 231 =over
 232
 233 =item id
 234
 235 The sequence will be replaced by the video identifier.
 236
 237 =item url
 238
 239 The sequence will be replaced by the video URL.
 240
 241 =item uploader
 242
 243 The sequence will be replaced by the nickname of the person who uploaded
 244 the video.
 245
 246 =item title
 247
 248 The sequence will be replaced by the literal video title.
 249
 250 =item stitle
 251
 252 The sequence will be replaced by a simplified video title, restricted to
 253 alphanumeric characters and dashes.
 254
 255 =item ext
 256
 257 The sequence will be replaced by the appropriate extension (like C<flv>
 258 or C<mp4>).
 259
 260 =item epoch
 261
 262 The sequence will be replaced by the Unix epoch when creating the file.
 263
 264 =back
 265
 266 As you may have guessed, the default template is C<%(id)s.%(ext)s>. When
 267 some command line options are used, it's replaced by other templates
 268 like C<%(title)s-%(id)s.%(ext)s>. You can specify your own.
 269
 270 =head1 AUTHOR
 271
 272 youtube-dl was written by Ricardo Garcia Gonzalez and many contributors
 273 from all around the internet.  This manpage was written by Rogerio Brito
 274 <rbrito@users.sf.net>.
 275
 276 =cut