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