Update README with new options
[youtube-dl.git] / README.md
1 # youtube-dl
2
3 ## USAGE
4 youtube-dl [options] url [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 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     --dump-user-agent        display the current browser identification
21     --list-extractors        List all supported extractors and the URLs they
22                              would handle
23
24 ### Video Selection:
25     --playlist-start NUMBER  playlist video to start at (default is 1)
26     --playlist-end NUMBER    playlist video to end at (default is last)
27     --match-title REGEX      download only matching titles (regex or caseless
28                              sub-string)
29     --reject-title REGEX     skip download for matching titles (regex or
30                              caseless sub-string)
31
32 ### Filesystem Options:
33     -t, --title              use title in file name
34     -l, --literal            use literal title in file name
35     -A, --auto-number        number downloaded files starting from 00000
36     -o, --output TEMPLATE    output filename template
37     -a, --batch-file FILE    file containing URLs to download ('-' for stdin)
38     -w, --no-overwrites      do not overwrite files
39     -c, --continue           resume partially downloaded files
40     --no-continue            do not resume partially downloaded files (restart
41                              from beginning)
42     --cookies FILE           file to read cookies from and dump cookie jar in
43     --no-part                do not use .part files
44     --no-mtime               do not use the Last-modified header to set the file
45                              modification time
46     --write-description      write video description to a .description file
47     --write-info-json        write video metadata to a .info.json file
48
49 ### Verbosity / Simulation Options:
50     -q, --quiet              activates quiet mode
51     -s, --simulate           do not download the video and do not write anything
52                              to disk
53     --skip-download          do not download the video
54     -g, --get-url            simulate, quiet but print URL
55     -e, --get-title          simulate, quiet but print title
56     --get-thumbnail          simulate, quiet but print thumbnail URL
57     --get-description        simulate, quiet but print video description
58     --get-filename           simulate, quiet but print output filename
59     --get-format             simulate, quiet but print output format
60     --no-progress            do not print progress bar
61     --console-title          display progress in console titlebar
62
63 ### Video Format Options:
64     -f, --format FORMAT      video format code
65     --all-formats            download all available video formats
66     --max-quality FORMAT     highest quality format to download
67
68 ### Authentication Options:
69     -u, --username USERNAME  account username
70     -p, --password PASSWORD  account password
71     -n, --netrc              use .netrc authentication data
72
73 ### Post-processing Options:
74     --extract-audio          convert video files to audio-only files (requires
75                              ffmpeg and ffprobe)
76     --audio-format FORMAT    "best", "aac", "vorbis" or "mp3"; best by default
77     --audio-quality QUALITY  ffmpeg audio bitrate specification, 128k by default
78     -k, --keep-video         keeps the video file on disk after the post-
79                              processing; the video is erased by default
80
81 ## FAQ
82
83 ### Can you please put the -b option back?
84
85 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.
86
87 ### I get HTTP error 402 when trying to download a video. What's this?
88
89 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.
90
91 ### I have downloaded a video but how can I play it?
92
93 Once the video is fully downloaded, use any video player, such as [vlc](http://www.videolan.org) or [mplayer](http://www.mplayerhq.hu/).
94
95 ### The links provided by youtube-dl -g are not working anymore
96
97 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.
98
99 ### ERROR: no fmt_url_map or conn information found in video info
100
101 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`.
102
103 ## COPYRIGHT
104
105 youtube-dl is released into the public domain by the copyright holders.
106
107 This README file was originally written by Daniel Bolton (<https://github.com/dbbolton>) and is likewise released into the public domain.
108
109 ## BUGS
110
111 Bugs and suggestions should be reported at: <https://github.com/rg3/youtube-dl/issues>
112
113 Please include:
114
115 * 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.
116 * The output of `youtube-dl --version`
117 * The output of `python --version`
118 * The name and version of your Operating System ("Ubuntu 11.04 x64" or "Windows 7 x64" is usually enough).