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