Raphaël G. Git Repositories - youtubedl/blob - README.txt

   1 NAME
   2 ====
   3
   4 youtube-dl - download videos from youtube.com or other video platforms
   5
   6 SYNOPSIS
   7 ========
   8
   9 youtube-dl OPTIONS URL [URL...]
  10
  11 DESCRIPTION
  12 ===========
  13
  14 youtube-dl is a small command-line program to download videos from
  15 YouTube.com and a few more sites. It requires the Python interpreter,
  16 version 2.6, 2.7, or 3.3+, and it is not platform specific. It should
  17 work on your Unix box, on Windows or on Mac OS X. It is released to the
  18 public domain, which means you can modify it, redistribute it or use it
  19 however you like.
  20
  21 OPTIONS
  22 =======
  23
  24     -h, --help                 print this help text and exit
  25     --version                  print program version and exit
  26     -U, --update               update this program to latest version
  27     -i, --ignore-errors        continue on download errors
  28     --dump-user-agent          display the current browser identification
  29     --user-agent UA            specify a custom user agent
  30     --referer REF              specify a custom referer, use if the video access
  31                                is restricted to one domain
  32     --list-extractors          List all supported extractors and the URLs they
  33                                would handle
  34     --extractor-descriptions   Output descriptions of all supported extractors
  35     --proxy URL                Use the specified HTTP/HTTPS proxy
  36     --no-check-certificate     Suppress HTTPS certificate validation.
  37
  38 Video Selection:
  39 ----------------
  40
  41     --playlist-start NUMBER    playlist video to start at (default is 1)
  42     --playlist-end NUMBER      playlist video to end at (default is last)
  43     --match-title REGEX        download only matching titles (regex or caseless
  44                                sub-string)
  45     --reject-title REGEX       skip download for matching titles (regex or
  46                                caseless sub-string)
  47     --max-downloads NUMBER     Abort after downloading NUMBER files
  48     --min-filesize SIZE        Do not download any videos smaller than SIZE
  49                                (e.g. 50k or 44.6m)
  50     --max-filesize SIZE        Do not download any videos larger than SIZE (e.g.
  51                                50k or 44.6m)
  52     --date DATE                download only videos uploaded in this date
  53     --datebefore DATE          download only videos uploaded before this date
  54     --dateafter DATE           download only videos uploaded after this date
  55
  56 Download Options:
  57 -----------------
  58
  59     -r, --rate-limit LIMIT     maximum download rate (e.g. 50k or 44.6m)
  60     -R, --retries RETRIES      number of retries (default is 10)
  61     --buffer-size SIZE         size of download buffer (e.g. 1024 or 16k)
  62                                (default is 1024)
  63     --no-resize-buffer         do not automatically adjust the buffer size. By
  64                                default, the buffer size is automatically resized
  65                                from an initial value of SIZE.
  66
  67 Filesystem Options:
  68 -------------------
  69
  70     -t, --title                use title in file name (default)
  71     --id                       use only video ID in file name
  72     -l, --literal              [deprecated] alias of --title
  73     -A, --auto-number          number downloaded files starting from 00000
  74     -o, --output TEMPLATE      output filename template. Use %(title)s to get
  75                                the title, %(uploader)s for the uploader name,
  76                                %(uploader_id)s for the uploader nickname if
  77                                different, %(autonumber)s to get an automatically
  78                                incremented number, %(ext)s for the filename
  79                                extension, %(upload_date)s for the upload date
  80                                (YYYYMMDD), %(extractor)s for the provider
  81                                (youtube, metacafe, etc), %(id)s for the video id
  82                                , %(playlist)s for the playlist the video is in,
  83                                %(playlist_index)s for the position in the
  84                                playlist and %% for a literal percent. Use - to
  85                                output to stdout. Can also be used to download to
  86                                a different directory, for example with -o '/my/d
  87                                ownloads/%(uploader)s/%(title)s-%(id)s.%(ext)s' .
  88     --autonumber-size NUMBER   Specifies the number of digits in %(autonumber)s
  89                                when it is present in output filename template or
  90                                --autonumber option is given
  91     --restrict-filenames       Restrict filenames to only ASCII characters, and
  92                                avoid "&" and spaces in filenames
  93     -a, --batch-file FILE      file containing URLs to download ('-' for stdin)
  94     -w, --no-overwrites        do not overwrite files
  95     -c, --continue             resume partially downloaded files
  96     --no-continue              do not resume partially downloaded files (restart
  97                                from beginning)
  98     --cookies FILE             file to read cookies from and dump cookie jar in
  99     --no-part                  do not use .part files
 100     --no-mtime                 do not use the Last-modified header to set the
 101                                file modification time
 102     --write-description        write video description to a .description file
 103     --write-info-json          write video metadata to a .info.json file
 104     --write-thumbnail          write thumbnail image to disk
 105
 106 Verbosity / Simulation Options:
 107 -------------------------------
 108
 109     -q, --quiet                activates quiet mode
 110     -s, --simulate             do not download the video and do not write
 111                                anything to disk
 112     --skip-download            do not download the video
 113     -g, --get-url              simulate, quiet but print URL
 114     -e, --get-title            simulate, quiet but print title
 115     --get-id                   simulate, quiet but print id
 116     --get-thumbnail            simulate, quiet but print thumbnail URL
 117     --get-description          simulate, quiet but print video description
 118     --get-filename             simulate, quiet but print output filename
 119     --get-format               simulate, quiet but print output format
 120     --newline                  output progress bar as new lines
 121     --no-progress              do not print progress bar
 122     --console-title            display progress in console titlebar
 123     -v, --verbose              print various debugging information
 124     --dump-intermediate-pages  print downloaded pages to debug problems(very
 125                                verbose)
 126
 127 Video Format Options:
 128 ---------------------
 129
 130     -f, --format FORMAT        video format code, specifiy the order of
 131                                preference using slashes: "-f 22/17/18"
 132     --all-formats              download all available video formats
 133     --prefer-free-formats      prefer free video formats unless a specific one
 134                                is requested
 135     --max-quality FORMAT       highest quality format to download
 136     -F, --list-formats         list all available formats (currently youtube
 137                                only)
 138     --write-sub                write subtitle file (currently youtube only)
 139     --write-auto-sub           write automatic subtitle file (currently youtube
 140                                only)
 141     --only-sub                 [deprecated] alias of --skip-download
 142     --all-subs                 downloads all the available subtitles of the
 143                                video (currently youtube only)
 144     --list-subs                lists all available subtitles for the video
 145                                (currently youtube only)
 146     --sub-format FORMAT        subtitle format [srt/sbv/vtt] (default=srt)
 147                                (currently youtube only)
 148     --sub-lang LANG            language of the subtitles to download (optional)
 149                                use IETF language tags like 'en'
 150
 151 Authentication Options:
 152 -----------------------
 153
 154     -u, --username USERNAME    account username
 155     -p, --password PASSWORD    account password
 156     -n, --netrc                use .netrc authentication data
 157     --video-password PASSWORD  video password (vimeo only)
 158
 159 Post-processing Options:
 160 ------------------------
 161
 162     -x, --extract-audio        convert video files to audio-only files (requires
 163                                ffmpeg or avconv and ffprobe or avprobe)
 164     --audio-format FORMAT      "best", "aac", "vorbis", "mp3", "m4a", "opus", or
 165                                "wav"; best by default
 166     --audio-quality QUALITY    ffmpeg/avconv audio quality specification, insert
 167                                a value between 0 (better) and 9 (worse) for VBR
 168                                or a specific bitrate like 128K (default 5)
 169     --recode-video FORMAT      Encode the video to another format if necessary
 170                                (currently supported: mp4|flv|ogg|webm)
 171     -k, --keep-video           keeps the video file on disk after the post-
 172                                processing; the video is erased by default
 173     --no-post-overwrites       do not overwrite post-processed files; the post-
 174                                processed files are overwritten by default
 175
 176 CONFIGURATION
 177 =============
 178
 179 You can configure youtube-dl by placing default arguments (such as
 180 --extract-audio --no-mtime to always extract the audio and not copy the
 181 mtime) into /etc/youtube-dl.conf and/or ~/.config/youtube-dl.conf.
 182
 183 OUTPUT TEMPLATE
 184 ===============
 185
 186 The -o option allows users to indicate a template for the output file
 187 names. The basic usage is not to set any template arguments when
 188 downloading a single file, like in
 189 youtube-dl -o funny_video.flv "http://some/video". However, it may
 190 contain special sequences that will be replaced when downloading each
 191 video. The special sequences have the format %(NAME)s. To clarify, that
 192 is a percent symbol followed by a name in parenthesis, followed by a
 193 lowercase S. Allowed names are:
 194
 195 -   id: The sequence will be replaced by the video identifier.
 196 -   url: The sequence will be replaced by the video URL.
 197 -   uploader: The sequence will be replaced by the nickname of the
 198     person who uploaded the video.
 199 -   upload_date: The sequence will be replaced by the upload date in
 200     YYYYMMDD format.
 201 -   title: The sequence will be replaced by the video title.
 202 -   ext: The sequence will be replaced by the appropriate extension
 203     (like flv or mp4).
 204 -   epoch: The sequence will be replaced by the Unix epoch when creating
 205     the file.
 206 -   autonumber: The sequence will be replaced by a five-digit number
 207     that will be increased with each download, starting at zero.
 208 -   playlist: The name or the id of the playlist that contains the
 209     video.
 210 -   playlist_index: The index of the video in the playlist, a five-digit
 211     number.
 212
 213 The current default template is %(title)s-%(id)s.%(ext)s.
 214
 215 In some cases, you don't want special characters such as 中, spaces, or
 216 &, such as when transferring the downloaded filename to a Windows system
 217 or the filename through an 8bit-unsafe channel. In these cases, add the
 218 --restrict-filenames flag to get a shorter title:
 219
 220     $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc
 221     youtube-dl test video ''_ä↭𝕐.mp4    # All kinds of weird characters
 222     $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
 223     youtube-dl_test_video_.mp4          # A simple file name
 224
 225 VIDEO SELECTION
 226 ===============
 227
 228 Videos can be filtered by their upload date using the options --date,
 229 --datebefore or --dateafter, they accept dates in two formats:
 230
 231 -   Absolute dates: Dates in the format YYYYMMDD.
 232 -   Relative dates: Dates in the format
 233     (now|today)[+-][0-9](day|week|month|year)(s)?
 234
 235 Examples:
 236
 237     $ youtube-dl --dateafter now-6months #will only download the videos uploaded in the last 6 months
 238     $ youtube-dl --date 19700101 #will only download the videos uploaded in January 1, 1970
 239     $ youtube-dl --dateafter 20000101 --datebefore 20100101 #will only download the videos uploaded between 2000 and 2010
 240
 241 FAQ
 242 ===
 243
 244 Can you please put the -b option back?
 245
 246 Most people asking this question are not aware that youtube-dl now
 247 defaults to downloading the highest available quality as reported by
 248 YouTube, which will be 1080p or 720p in some cases, so you no longer
 249 need the -b option. For some specific videos, maybe YouTube does not
 250 report them to be available in a specific high quality format you're
 251 interested in. In that case, simply request it with the -f option and
 252 youtube-dl will try to download it.
 253
 254 I get HTTP error 402 when trying to download a video. What's this?
 255
 256 Apparently YouTube requires you to pass a CAPTCHA test if you download
 257 too much. We're considering to provide a way to let you solve the
 258 CAPTCHA, but at the moment, your best course of action is pointing a
 259 webbrowser to the youtube URL, solving the CAPTCHA, and restart
 260 youtube-dl.
 261
 262 I have downloaded a video but how can I play it?
 263
 264 Once the video is fully downloaded, use any video player, such as vlc or
 265 mplayer.
 266
 267 The links provided by youtube-dl -g are not working anymore
 268
 269 The URLs youtube-dl outputs require the downloader to have the correct
 270 cookies. Use the --cookies option to write the required cookies into a
 271 file, and advise your downloader to read cookies from that file. Some
 272 sites also require a common user agent to be used, use --dump-user-agent
 273 to see the one in use by youtube-dl.
 274
 275 ERROR: no fmt_url_map or conn information found in video info
 276
 277 youtube has switched to a new video info format in July 2011 which is
 278 not supported by old versions of youtube-dl. You can update youtube-dl
 279 with sudo youtube-dl --update.
 280
 281 ERROR: unable to download video
 282
 283 youtube requires an additional signature since September 2012 which is
 284 not supported by old versions of youtube-dl. You can update youtube-dl
 285 with sudo youtube-dl --update.
 286
 287 SyntaxError: Non-ASCII character
 288
 289 The error
 290
 291     File "youtube-dl", line 2
 292     SyntaxError: Non-ASCII character '\x93' ...
 293
 294 means you're using an outdated version of Python. Please update to
 295 Python 2.6 or 2.7.
 296
 297 What is this binary file? Where has the code gone?
 298
 299 Since June 2012 (#342) youtube-dl is packed as an executable zipfile,
 300 simply unzip it (might need renaming to youtube-dl.zip first on some
 301 systems) or clone the git repository, as laid out above. If you modify
 302 the code, you can run it by executing the __main__.py file. To recompile
 303 the executable, run make youtube-dl.
 304
 305 The exe throws a Runtime error from Visual C++
 306
 307 To run the exe you need to install first the Microsoft Visual C++ 2008
 308 Redistributable Package.
 309
 310 COPYRIGHT
 311 =========
 312
 313 youtube-dl is released into the public domain by the copyright holders.
 314
 315 This README file was originally written by Daniel Bolton
 316 (https://github.com/dbbolton) and is likewise released into the public
 317 domain.
 318
 319 BUGS
 320 ====
 321
 322 Bugs and suggestions should be reported at:
 323 https://github.com/rg3/youtube-dl/issues
 324
 325 Please include:
 326
 327 -   Your exact command line, like
 328     youtube-dl -t "http://www.youtube.com/watch?v=uHlDtZ6Oc3s&feature=channel_video_title".
 329     A common mistake is not to escape the &. Putting URLs in quotes
 330     should solve this problem.
 331 -   If possible re-run the command with --verbose, and include the full
 332     output, it is really helpful to us.
 333 -   The output of youtube-dl --version
 334 -   The output of python --version
 335 -   The name and version of your Operating System ("Ubuntu 11.04 x64" or
 336     "Windows 7 x64" is usually enough).
 337
 338 For discussions, join us in the irc channel #youtube-dl on freenode.