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