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