_ 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.x (x being at least 6), and it is not platform specific. It should work in
  13 your Unix box, in Windows or in 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   download rate limit (e.g. 50k or 44.6m)
  22     -R, --retries RETRIES    number of retries (default is 10)
  23     --dump-user-agent        display the current browser identification
  24     --list-extractors        List all supported extractors and the URLs they
  25                              would handle
  26
  27 ## Video Selection:
  28     --playlist-start NUMBER  playlist video to start at (default is 1)
  29     --playlist-end NUMBER    playlist video to end at (default is last)
  30     --match-title REGEX      download only matching titles (regex or caseless
  31                              sub-string)
  32     --reject-title REGEX     skip download for matching titles (regex or
  33                              caseless sub-string)
  34     --max-downloads NUMBER   Abort after downloading NUMBER files
  35
  36 ## Filesystem Options:
  37     -t, --title              use title in file name
  38     -l, --literal            use literal title in file name
  39     -A, --auto-number        number downloaded files starting from 00000
  40     -o, --output TEMPLATE    output filename template. Use %(stitle)s to get the
  41                              title, %(uploader)s for the uploader name,
  42                              %(autonumber)s to get an automatically incremented
  43                              number, %(ext)s for the filename extension,
  44                              %(upload_date)s for the upload date (YYYYMMDD), and
  45                              %% for a literal percent. Use - to output to
  46                              stdout.
  47     -a, --batch-file FILE    file containing URLs to download ('-' for stdin)
  48     -w, --no-overwrites      do not overwrite files
  49     -c, --continue           resume partially downloaded files
  50     --no-continue            do not resume partially downloaded files (restart
  51                              from beginning)
  52     --cookies FILE           file to read cookies from and dump cookie jar in
  53     --no-part                do not use .part files
  54     --no-mtime               do not use the Last-modified header to set the file
  55                              modification time
  56     --write-description      write video description to a .description file
  57     --write-info-json        write video metadata to a .info.json file
  58
  59 ## Verbosity / Simulation Options:
  60     -q, --quiet              activates quiet mode
  61     -s, --simulate           do not download the video and do not write anything
  62                              to disk
  63     --skip-download          do not download the video
  64     -g, --get-url            simulate, quiet but print URL
  65     -e, --get-title          simulate, quiet but print title
  66     --get-thumbnail          simulate, quiet but print thumbnail URL
  67     --get-description        simulate, quiet but print video description
  68     --get-filename           simulate, quiet but print output filename
  69     --get-format             simulate, quiet but print output format
  70     --no-progress            do not print progress bar
  71     --console-title          display progress in console titlebar
  72     -v, --verbose            print various debugging information
  73
  74 ## Video Format Options:
  75     -f, --format FORMAT      video format code
  76     --all-formats            download all available video formats
  77     --prefer-free-formats    prefer free video formats unless a specific one is
  78                              requested
  79     --max-quality FORMAT     highest quality format to download
  80     -F, --list-formats       list all available formats (currently youtube only)
  81     --write-srt              write video closed captions to a .srt file
  82                              (currently youtube only)
  83     --srt-lang LANG          language of the closed captions to download
  84                              (optional) use IETF language tags like 'en'
  85
  86 ## Authentication Options:
  87     -u, --username USERNAME  account username
  88     -p, --password PASSWORD  account password
  89     -n, --netrc              use .netrc authentication data
  90
  91 ## Post-processing Options:
  92     --extract-audio          convert video files to audio-only files (requires
  93                              ffmpeg or avconv and ffprobe or avprobe)
  94     --audio-format FORMAT    "best", "aac", "vorbis", "mp3", "m4a", or "wav";
  95                              best by default
  96     --audio-quality QUALITY  ffmpeg/avconv audio bitrate specification, 128k by
  97                              default
  98     -k, --keep-video         keeps the video file on disk after the post-
  99                              processing; the video is erased by default
 100
 101 # FAQ
 102
 103 ### Can you please put the -b option back?
 104
 105 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.
 106
 107 ### I get HTTP error 402 when trying to download a video. What's this?
 108
 109 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.
 110
 111 ### I have downloaded a video but how can I play it?
 112
 113 Once the video is fully downloaded, use any video player, such as [vlc](http://www.videolan.org) or [mplayer](http://www.mplayerhq.hu/).
 114
 115 ### The links provided by youtube-dl -g are not working anymore
 116
 117 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.
 118
 119 ### ERROR: no fmt_url_map or conn information found in video info
 120
 121 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`.
 122
 123 # COPYRIGHT
 124
 125 youtube-dl is released into the public domain by the copyright holders.
 126
 127 This README file was originally written by Daniel Bolton (<https://github.com/dbbolton>) and is likewise released into the public domain.
 128
 129 # BUGS
 130
 131 Bugs and suggestions should be reported at: <https://github.com/rg3/youtube-dl/issues>
 132
 133 Please include:
 134
 135 * 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.
 136 * The output of `youtube-dl --version`
 137 * The output of `python --version`
 138 * The name and version of your Operating System ("Ubuntu 11.04 x64" or "Windows 7 x64" is usually enough).