README.md

   1 % YOUTUBE-DL(1)
   2
   3 # NAME
   4 youtube-dl
   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     -r, --rate-limit LIMIT     maximum download rate (e.g. 50k or 44.6m)
  22     -R, --retries RETRIES      number of retries (default is 10)
  23     --buffer-size SIZE         size of download buffer (e.g. 1024 or 16k)
  24                                (default is 1024)
  25     --no-resize-buffer         do not automatically adjust the buffer size. By
  26                                default, the buffer size is automatically resized
  27                                from an initial value of SIZE.
  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     --proxy URL                Use the specified HTTP/HTTPS proxy
  35     --no-check-certificate     Suppress HTTPS certificate validation.
  36
  37 ## Video Selection:
  38     --playlist-start NUMBER    playlist video to start at (default is 1)
  39     --playlist-end NUMBER      playlist video to end at (default is last)
  40     --match-title REGEX        download only matching titles (regex or caseless
  41                                sub-string)
  42     --reject-title REGEX       skip download for matching titles (regex or
  43                                caseless sub-string)
  44     --max-downloads NUMBER     Abort after downloading NUMBER files
  45     --min-filesize SIZE        Do not download any videos smaller than SIZE
  46                                (e.g. 50k or 44.6m)
  47     --max-filesize SIZE        Do not download any videos larger than SIZE (e.g.
  48                                50k or 44.6m)
  49     --date DATE                download only videos uploaded in this date
  50     --datebefore DATE          download only videos uploaded before this date
  51     --dateafter DATE           download only videos uploaded after this date
  52
  53 ## Filesystem Options:
  54     -t, --title                use title in file name (default)
  55     --id                       use only video ID in file name
  56     -l, --literal              [deprecated] alias of --title
  57     -A, --auto-number          number downloaded files starting from 00000
  58     -o, --output TEMPLATE      output filename template. Use %(title)s to get
  59                                the title, %(uploader)s for the uploader name,
  60                                %(uploader_id)s for the uploader nickname if
  61                                different, %(autonumber)s to get an automatically
  62                                incremented number, %(ext)s for the filename
  63                                extension, %(upload_date)s for the upload date
  64                                (YYYYMMDD), %(extractor)s for the provider
  65                                (youtube, metacafe, etc), %(id)s for the video id
  66                                , %(playlist)s for the playlist the video is in,
  67                                %(playlist_index)s for the position in the
  68                                playlist and %% for a literal percent. Use - to
  69                                output to stdout. Can also be used to download to
  70                                a different directory, for example with -o '/my/d
  71                                ownloads/%(uploader)s/%(title)s-%(id)s.%(ext)s' .
  72     --autonumber-size NUMBER   Specifies the number of digits in %(autonumber)s
  73                                when it is present in output filename template or
  74                                --autonumber option is given
  75     --restrict-filenames       Restrict filenames to only ASCII characters, and
  76                                avoid "&" and spaces in filenames
  77     -a, --batch-file FILE      file containing URLs to download ('-' for stdin)
  78     -w, --no-overwrites        do not overwrite files
  79     -c, --continue             resume partially downloaded files
  80     --no-continue              do not resume partially downloaded files (restart
  81                                from beginning)
  82     --cookies FILE             file to read cookies from and dump cookie jar in
  83     --no-part                  do not use .part files
  84     --no-mtime                 do not use the Last-modified header to set the
  85                                file modification time
  86     --write-description        write video description to a .description file
  87     --write-info-json          write video metadata to a .info.json file
  88     --write-thumbnail          write thumbnail image to disk
  89
  90 ## Verbosity / Simulation Options:
  91     -q, --quiet                activates quiet mode
  92     -s, --simulate             do not download the video and do not write
  93                                anything to disk
  94     --skip-download            do not download the video
  95     -g, --get-url              simulate, quiet but print URL
  96     -e, --get-title            simulate, quiet but print title
  97     --get-id                   simulate, quiet but print id
  98     --get-thumbnail            simulate, quiet but print thumbnail URL
  99     --get-description          simulate, quiet but print video description
 100     --get-filename             simulate, quiet but print output filename
 101     --get-format               simulate, quiet but print output format
 102     --newline                  output progress bar as new lines
 103     --no-progress              do not print progress bar
 104     --console-title            display progress in console titlebar
 105     -v, --verbose              print various debugging information
 106     --dump-intermediate-pages  print downloaded pages to debug problems(very
 107                                verbose)
 108
 109 ## Video Format Options:
 110     -f, --format FORMAT        video format code, specifiy the order of
 111                                preference using slashes: "-f 22/17/18"
 112     --all-formats              download all available video formats
 113     --prefer-free-formats      prefer free video formats unless a specific one
 114                                is requested
 115     --max-quality FORMAT       highest quality format to download
 116     -F, --list-formats         list all available formats (currently youtube
 117                                only)
 118     --write-sub                write subtitle file (currently youtube only)
 119     --only-sub                 [deprecated] alias of --skip-download
 120     --all-subs                 downloads all the available subtitles of the
 121                                video (currently youtube only)
 122     --list-subs                lists all available subtitles for the video
 123                                (currently youtube only)
 124     --sub-format LANG          subtitle format [srt/sbv] (default=srt)
 125                                (currently youtube only)
 126     --sub-lang LANG            language of the subtitles to download (optional)
 127                                use IETF language tags like 'en'
 128
 129 ## Authentication Options:
 130     -u, --username USERNAME    account username
 131     -p, --password PASSWORD    account password
 132     -n, --netrc                use .netrc authentication data
 133
 134 ## Post-processing Options:
 135     -x, --extract-audio        convert video files to audio-only files (requires
 136                                ffmpeg or avconv and ffprobe or avprobe)
 137     --audio-format FORMAT      "best", "aac", "vorbis", "mp3", "m4a", "opus", or
 138                                "wav"; best by default
 139     --audio-quality QUALITY    ffmpeg/avconv audio quality specification, insert
 140                                a value between 0 (better) and 9 (worse) for VBR
 141                                or a specific bitrate like 128K (default 5)
 142     --recode-video FORMAT      Encode the video to another format if necessary
 143                                (currently supported: mp4|flv|ogg|webm)
 144     -k, --keep-video           keeps the video file on disk after the post-
 145                                processing; the video is erased by default
 146     --no-post-overwrites       do not overwrite post-processed files; the post-
 147                                processed files are overwritten by default
 148
 149 # CONFIGURATION
 150
 151 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`.
 152
 153 # OUTPUT TEMPLATE
 154
 155 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:
 156
 157  - `id`: The sequence will be replaced by the video identifier.
 158  - `url`: The sequence will be replaced by the video URL.
 159  - `uploader`: The sequence will be replaced by the nickname of the person who uploaded the video.
 160  - `upload_date`: The sequence will be replaced by the upload date in YYYYMMDD format.
 161  - `title`: The sequence will be replaced by the video title.
 162  - `ext`: The sequence will be replaced by the appropriate extension (like flv or mp4).
 163  - `epoch`: The sequence will be replaced by the Unix epoch when creating the file.
 164  - `autonumber`: The sequence will be replaced by a five-digit number that will be increased with each download, starting at zero.
 165  - `playlist`: The name or the id of the playlist that contains the video.
 166  - `playlist_index`: The index of the video in the playlist, a five-digit number.
 167
 168 The current default template is `%(id)s.%(ext)s`, but that will be switchted to `%(title)s-%(id)s.%(ext)s` (which can be requested with `-t` at the moment).
 169
 170 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:
 171
 172     $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc
 173     youtube-dl test video ''_ä↭𝕐.mp4    # All kinds of weird characters
 174     $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
 175     youtube-dl_test_video_.mp4          # A simple file name
 176
 177 # VIDEO SELECTION
 178
 179 Videos can be filtered by their upload date using the options `--date`, `--datebefore` or `--dateafter`, they accept dates in two formats:
 180
 181  - Absolute dates: Dates in the format `YYYYMMDD`.
 182  - Relative dates: Dates in the format `(now|today)[+-][0-9](day|week|month|year)(s)?`
 183
 184 Examples:
 185
 186         $ youtube-dl --dateafter now-6months #will only download the videos uploaded in the last 6 months
 187         $ youtube-dl --date 19700101 #will only download the videos uploaded in January 1, 1970
 188         $ youtube-dl --dateafter 20000101 --datebefore 20100101 #will only download the videos uploaded between 2000 and 2010
 189
 190 # FAQ
 191
 192 ### Can you please put the -b option back?
 193
 194 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.
 195
 196 ### I get HTTP error 402 when trying to download a video. What's this?
 197
 198 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.
 199
 200 ### I have downloaded a video but how can I play it?
 201
 202 Once the video is fully downloaded, use any video player, such as [vlc](http://www.videolan.org) or [mplayer](http://www.mplayerhq.hu/).
 203
 204 ### The links provided by youtube-dl -g are not working anymore
 205
 206 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.
 207
 208 ### ERROR: no fmt_url_map or conn information found in video info
 209
 210 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`.
 211
 212 ### ERROR: unable to download video ###
 213
 214 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`.
 215
 216 ### SyntaxError: Non-ASCII character ###
 217
 218 The error
 219
 220     File "youtube-dl", line 2
 221     SyntaxError: Non-ASCII character '\x93' ...
 222
 223 means you're using an outdated version of Python. Please update to Python 2.6 or 2.7.
 224
 225 ### What is this binary file? Where has the code gone?
 226
 227 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`.
 228
 229 ### The exe throws a *Runtime error from Visual C++*
 230
 231 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).
 232
 233 # COPYRIGHT
 234
 235 youtube-dl is released into the public domain by the copyright holders.
 236
 237 This README file was originally written by Daniel Bolton (<https://github.com/dbbolton>) and is likewise released into the public domain.
 238
 239 # BUGS
 240
 241 Bugs and suggestions should be reported at: <https://github.com/rg3/youtube-dl/issues>
 242
 243 Please include:
 244
 245 * 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.
 246 * If possible re-run the command with `--verbose`, and include the full output, it is really helpful to us.
 247 * The output of `youtube-dl --version`
 248 * The output of `python --version`
 249 * The name and version of your Operating System ("Ubuntu 11.04 x64" or "Windows 7 x64" is usually enough).
 250
 251 For discussions, join us in the irc channel #youtube-dl on freenode.