README.md

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