README.md

   1 # youtube-dl
   2
   3 ## USAGE
   4 youtube-dl [OPTIONS] URL
   5
   6 ## DESCRIPTION
   7 **youtube-dl** is a small command-line program to download videos from
   8 YouTube.com and a few more sites. It requires the Python interpreter, version
   9 2.x (x being at least 5), and it is not platform specific. It should work in
  10 your Unix box, in Windows or in Mac OS X. It is released to the public domain,
  11 which means you can modify it, redistribute it or use it however you like.
  12
  13 ## OPTIONS
  14     -h, --help               print this help text and exit
  15     -v, --version            print program version and exit
  16     -U, --update             update this program to latest stable version
  17     -i, --ignore-errors      continue on download errors
  18     -r, --rate-limit LIMIT   download rate limit (e.g. 50k or 44.6m)
  19     -R, --retries RETRIES    number of retries (default is 10)
  20     --playlist-start NUMBER  playlist video to start at (default is 1)
  21     --playlist-end NUMBER    playlist video to end at (default is last)
  22     --dump-user-agent        display the current browser identification
  23
  24 ### Filesystem Options:
  25     -t, --title              use title in file name
  26     -l, --literal            use literal title in file name
  27     -A, --auto-number        number downloaded files starting from 00000
  28     -o, --output TEMPLATE    output filename template
  29     -a, --batch-file FILE    file containing URLs to download ('-' for stdin)
  30     -w, --no-overwrites      do not overwrite files
  31     -c, --continue           resume partially downloaded files
  32     --cookies FILE           file to dump cookie jar to
  33     --no-part                do not use .part files
  34     --no-mtime               do not use the Last-modified header to set the file
  35                              modification time
  36     --write-description      write video description to a .description file
  37     --write-info-json        write video metadata to a .info.json file
  38
  39 ### Verbosity / Simulation Options:
  40     -q, --quiet              activates quiet mode
  41     -s, --simulate           do not download video
  42     -g, --get-url            simulate, quiet but print URL
  43     -e, --get-title          simulate, quiet but print title
  44     --get-thumbnail          simulate, quiet but print thumbnail URL
  45     --get-description        simulate, quiet but print video description
  46     --get-filename           simulate, quiet but print output filename
  47     --no-progress            do not print progress bar
  48     --console-title          display progress in console titlebar
  49
  50 ### Video Format Options:
  51     -f, --format FORMAT      video format code
  52     --all-formats            download all available video formats
  53     --max-quality FORMAT     highest quality format to download
  54
  55 ### Authentication Options:
  56     -u, --username USERNAME  account username
  57     -p, --password PASSWORD  account password
  58     -n, --netrc              use .netrc authentication data
  59
  60 ### Post-processing Options:
  61     --extract-audio          convert video files to audio-only files (requires
  62                              ffmpeg and ffprobe)
  63     --audio-format FORMAT    "best", "aac" or "mp3"; best by default
  64
  65 ## COPYRIGHT
  66 **youtube-dl**: Copyright © 2006-2011 Ricardo Garcia Gonzalez. The program is
  67 released into the public domain by the copyright holder. This README file was
  68 originally written by Daniel Bolton (<https://github.com/dbbolton>) and is
  69 likewise released into the public domain.
  70
  71 ## BUGS
  72 Bugs should be reported at: <https://github.com/rg3/youtube-dl/issues>