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