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

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