]>
Commit | Line | Data |
---|---|---|
cfcec693 | 1 | % youtube-dl(1) |
6bcd846b | 2 | |
cfcec693 FV |
3 | # NAME |
4 | youtube-dl | |
6bcd846b | 5 | |
cfcec693 FV |
6 | # SYNOPSIS |
7 | **youtube-dl** [OPTIONS] URL [URL...] | |
8 | ||
9 | # DESCRIPTION | |
6bcd846b DB |
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 | |
921a1455 | 12 | 2.x (x being at least 6), and it is not platform specific. It should work in |
6bcd846b DB |
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 | ||
cfcec693 | 16 | # OPTIONS |
4618f3da | 17 | -h, --help print this help text and exit |
c4105fa0 | 18 | --version print program version and exit |
8f88eb1f | 19 | -U, --update update this program to latest version |
4618f3da PH |
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) | |
cc872b68 PH |
23 | --buffer-size SIZE size of download buffer (e.g. 1024 or 16k) (default |
24 | is 1024) | |
25 | --no-resize-buffer do not automatically adjust the buffer size. By | |
26 | default, the buffer size is automatically resized | |
27 | from an initial value of SIZE. | |
08c1d0d3 | 28 | --dump-user-agent display the current browser identification |
20326b8b | 29 | --user-agent UA specify a custom user agent |
6a1ca41e PH |
30 | --list-extractors List all supported extractors and the URLs they |
31 | would handle | |
08c1d0d3 | 32 | |
cfcec693 | 33 | ## Video Selection: |
4618f3da PH |
34 | --playlist-start NUMBER playlist video to start at (default is 1) |
35 | --playlist-end NUMBER playlist video to end at (default is last) | |
08c1d0d3 PH |
36 | --match-title REGEX download only matching titles (regex or caseless |
37 | sub-string) | |
38 | --reject-title REGEX skip download for matching titles (regex or | |
39 | caseless sub-string) | |
b88a5250 | 40 | --max-downloads NUMBER Abort after downloading NUMBER files |
6bcd846b | 41 | |
cfcec693 | 42 | ## Filesystem Options: |
4618f3da | 43 | -t, --title use title in file name |
74e453bd | 44 | --id use video ID in file name |
baec1538 | 45 | -l, --literal [deprecated] alias of --title |
4618f3da | 46 | -A, --auto-number number downloaded files starting from 00000 |
b6fab35b | 47 | -o, --output TEMPLATE output filename template. Use %(title)s to get the |
9baa2ef5 PH |
48 | title, %(uploader)s for the uploader name, |
49 | %(autonumber)s to get an automatically incremented | |
31a2ec2d | 50 | number, %(ext)s for the filename extension, |
551fa9df | 51 | %(upload_date)s for the upload date (YYYYMMDD), |
b7b4796b | 52 | %(extractor)s for the provider (youtube, metacafe, |
551fa9df FV |
53 | etc), %(id)s for the video id and %% for a literal |
54 | percent. Use - to output to stdout. | |
56781d3d PH |
55 | --restrict-filenames Restrict filenames to only ASCII characters, and |
56 | avoid "&" and spaces in filenames | |
4618f3da PH |
57 | -a, --batch-file FILE file containing URLs to download ('-' for stdin) |
58 | -w, --no-overwrites do not overwrite files | |
59 | -c, --continue resume partially downloaded files | |
eca1b76f PH |
60 | --no-continue do not resume partially downloaded files (restart |
61 | from beginning) | |
3ce59dae | 62 | --cookies FILE file to read cookies from and dump cookie jar in |
4618f3da PH |
63 | --no-part do not use .part files |
64 | --no-mtime do not use the Last-modified header to set the file | |
65 | modification time | |
66 | --write-description write video description to a .description file | |
67 | --write-info-json write video metadata to a .info.json file | |
6bcd846b | 68 | |
cfcec693 | 69 | ## Verbosity / Simulation Options: |
4618f3da | 70 | -q, --quiet activates quiet mode |
6a1ca41e PH |
71 | -s, --simulate do not download the video and do not write anything |
72 | to disk | |
73 | --skip-download do not download the video | |
4618f3da PH |
74 | -g, --get-url simulate, quiet but print URL |
75 | -e, --get-title simulate, quiet but print title | |
76 | --get-thumbnail simulate, quiet but print thumbnail URL | |
77 | --get-description simulate, quiet but print video description | |
78 | --get-filename simulate, quiet but print output filename | |
6a1ca41e | 79 | --get-format simulate, quiet but print output format |
4618f3da PH |
80 | --no-progress do not print progress bar |
81 | --console-title display progress in console titlebar | |
c4105fa0 | 82 | -v, --verbose print various debugging information |
6bcd846b | 83 | |
cfcec693 | 84 | ## Video Format Options: |
4618f3da PH |
85 | -f, --format FORMAT video format code |
86 | --all-formats download all available video formats | |
561504ff PH |
87 | --prefer-free-formats prefer free video formats unless a specific one is |
88 | requested | |
4618f3da | 89 | --max-quality FORMAT highest quality format to download |
2761012f | 90 | -F, --list-formats list all available formats (currently youtube only) |
a0432a1e FV |
91 | --write-srt write video closed captions to a .srt file |
92 | (currently youtube only) | |
93 | --srt-lang LANG language of the closed captions to download | |
94 | (optional) use IETF language tags like 'en' | |
6bcd846b | 95 | |
cfcec693 | 96 | ## Authentication Options: |
4618f3da PH |
97 | -u, --username USERNAME account username |
98 | -p, --password PASSWORD account password | |
99 | -n, --netrc use .netrc authentication data | |
6bcd846b | 100 | |
cfcec693 | 101 | ## Post-processing Options: |
b7a34316 | 102 | -x, --extract-audio convert video files to audio-only files (requires |
505ed308 | 103 | ffmpeg or avconv and ffprobe or avprobe) |
d6639d05 PH |
104 | --audio-format FORMAT "best", "aac", "vorbis", "mp3", "m4a", or "wav"; |
105 | best by default | |
b24676ce | 106 | --audio-quality QUALITY ffmpeg/avconv audio quality specification, insert a |
3a68d7b4 FV |
107 | value between 0 (better) and 9 (worse) for VBR or a |
108 | specific bitrate like 128K (default 5) | |
6a1ca41e PH |
109 | -k, --keep-video keeps the video file on disk after the post- |
110 | processing; the video is erased by default | |
6bcd846b | 111 | |
df4bad32 PH |
112 | # CONFIGURATION |
113 | ||
114 | You can configure youtube-dl by placing default arguments (such as `--extract-audio --no-mtime` to always extract the audio and not copy the mtime) into `/etc/youtube-dl.conf` and/or `~/.local/config/youtube-dl.conf`. | |
115 | ||
02531431 PH |
116 | # OUTPUT TEMPLATE |
117 | ||
118 | The `-o` option allows users to indicate a template for the output file names. The basic usage is not to set any template arguments when downloading a single file, like in `youtube-dl -o funny_video.flv "http://some/video"`. However, it may contain special sequences that will be replaced when downloading each video. The special sequences have the format `%(NAME)s`. To clarify, that is a percent symbol followed by a name in parenthesis, followed by a lowercase S. Allowed names are: | |
119 | ||
120 | - `id`: The sequence will be replaced by the video identifier. | |
121 | - `url`: The sequence will be replaced by the video URL. | |
122 | - `uploader`: The sequence will be replaced by the nickname of the person who uploaded the video. | |
123 | - `upload_date`: The sequence will be replaced by the upload date in YYYYMMDD format. | |
124 | - `title`: The sequence will be replaced by the video title. | |
877f4c45 PH |
125 | - `ext`: The sequence will be replaced by the appropriate extension (like flv or mp4). |
126 | - `epoch`: The sequence will be replaced by the Unix epoch when creating the file. | |
127 | - `autonumber`: The sequence will be replaced by a five-digit number that will be increased with each download, starting at zero. | |
02531431 PH |
128 | |
129 | The current default template is `%(id)s.%(ext)s`, but that will be switchted to `%(title)s-%(id)s.%(ext)s` (which can be requested with `-t` at the moment). | |
130 | ||
131 | In some cases, you don't want special characters such as 中, spaces, or &, such as when transferring the downloaded filename to a Windows system or the filename through an 8bit-unsafe channel. In these cases, add the `--restrict-filenames` flag to get a shorter title: | |
132 | ||
133 | $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc | |
134 | youtube-dl test video ''_ä↭𝕐.mp4 # All kinds of weird characters | |
135 | $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames | |
136 | youtube-dl_test_video_.mp4 # A simple file name | |
137 | ||
cfcec693 | 138 | # FAQ |
447b1d71 PH |
139 | |
140 | ### Can you please put the -b option back? | |
141 | ||
142 | 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. | |
143 | ||
f2a3a352 | 144 | ### I get HTTP error 402 when trying to download a video. What's this? |
447b1d71 | 145 | |
8236e851 | 146 | 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. |
447b1d71 PH |
147 | |
148 | ### I have downloaded a video but how can I play it? | |
149 | ||
150 | Once the video is fully downloaded, use any video player, such as [vlc](http://www.videolan.org) or [mplayer](http://www.mplayerhq.hu/). | |
151 | ||
152 | ### The links provided by youtube-dl -g are not working anymore | |
153 | ||
a0432a1e | 154 | 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. |
447b1d71 | 155 | |
454d6691 PH |
156 | ### ERROR: no fmt_url_map or conn information found in video info |
157 | ||
5a2ba45e | 158 | 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`. |
454d6691 | 159 | |
6c5b442a PH |
160 | ### ERROR: unable to download video ### |
161 | ||
162 | youtube requires an additional signature since September 2012 which is not supported by old versions of youtube-dl. You can update youtube-dl with `sudo youtube-dl --update`. | |
163 | ||
5cdfaeb3 | 164 | ### SyntaxError: Non-ASCII character ### |
6c5b442a PH |
165 | |
166 | The error | |
167 | ||
168 | File "youtube-dl", line 2 | |
169 | SyntaxError: Non-ASCII character '\x93' ... | |
170 | ||
171 | means you're using an outdated version of Python. Please update to Python 2.6 or 2.7. | |
172 | ||
173 | To run youtube-dl under Python 2.5, you'll have to manually check it out like this: | |
174 | ||
175 | git clone git://github.com/rg3/youtube-dl.git | |
176 | cd youtube-dl | |
5cdfaeb3 | 177 | python -m youtube_dl --help |
6c5b442a PH |
178 | |
179 | Please note that Python 2.5 is not supported anymore. | |
180 | ||
5cdfaeb3 FV |
181 | ### What is this binary file? Where has the code gone? |
182 | ||
71f36332 | 183 | Since June 2012 (#342) youtube-dl is packed as an executable zipfile, simply unzip it (might need renaming to `youtube-dl.zip` first on some systems) or clone the git repository, as laid out above. If you modify the code, you can run it by executing the `__main__.py` file. To recompile the executable, run `make youtube-dl`. |
5cdfaeb3 | 184 | |
ce367443 FV |
185 | ### The exe throws a *Runtime error from Visual C++* |
186 | ||
187 | To run the exe you need to install first the [Microsoft Visual C++ 2008 Redistributable Package](http://www.microsoft.com/en-us/download/details.aspx?id=29). | |
188 | ||
cfcec693 | 189 | # COPYRIGHT |
803abae2 PH |
190 | |
191 | youtube-dl is released into the public domain by the copyright holders. | |
192 | ||
193 | This README file was originally written by Daniel Bolton (<https://github.com/dbbolton>) and is likewise released into the public domain. | |
6bcd846b | 194 | |
cfcec693 | 195 | # BUGS |
e133e121 | 196 | |
8236e851 | 197 | Bugs and suggestions should be reported at: <https://github.com/rg3/youtube-dl/issues> |
e133e121 PH |
198 | |
199 | Please include: | |
200 | ||
201 | * 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. | |
202 | * The output of `youtube-dl --version` | |
203 | * The output of `python --version` | |
204 | * The name and version of your Operating System ("Ubuntu 11.04 x64" or "Windows 7 x64" is usually enough). |