youtube-dl/README.md

166 lines
8.7 KiB
Markdown
Raw Normal View History

% youtube-dl(1)
2011-08-05 23:14:13 +00:00
# NAME
youtube-dl
2011-08-05 23:14:13 +00:00
# SYNOPSIS
**youtube-dl** [OPTIONS] URL [URL...]
# DESCRIPTION
2011-08-05 23:14:13 +00:00
**youtube-dl** is a small command-line program to download videos from
YouTube.com and a few more sites. It requires the Python interpreter, version
2.x (x being at least 6), and it is not platform specific. It should work in
2011-08-05 23:14:13 +00:00
your Unix box, in Windows or in Mac OS X. It is released to the public domain,
which means you can modify it, redistribute it or use it however you like.
# OPTIONS
2011-08-24 22:09:28 +00:00
-h, --help print this help text and exit
2012-02-26 23:42:26 +00:00
--version print program version and exit
2011-09-04 09:47:58 +00:00
-U, --update update this program to latest version
2011-08-24 22:09:28 +00:00
-i, --ignore-errors continue on download errors
-r, --rate-limit LIMIT download rate limit (e.g. 50k or 44.6m)
-R, --retries RETRIES number of retries (default is 10)
2011-09-14 20:55:09 +00:00
--dump-user-agent display the current browser identification
--user-agent UA specify a custom user agent
2011-09-15 10:45:56 +00:00
--list-extractors List all supported extractors and the URLs they
would handle
2011-09-14 20:55:09 +00:00
## Video Selection:
2011-08-24 22:09:28 +00:00
--playlist-start NUMBER playlist video to start at (default is 1)
--playlist-end NUMBER playlist video to end at (default is last)
2011-09-14 20:55:09 +00:00
--match-title REGEX download only matching titles (regex or caseless
sub-string)
--reject-title REGEX skip download for matching titles (regex or
caseless sub-string)
2011-11-27 23:55:44 +00:00
--max-downloads NUMBER Abort after downloading NUMBER files
2011-08-05 23:14:13 +00:00
## Filesystem Options:
2011-08-24 22:09:28 +00:00
-t, --title use title in file name
-l, --literal use literal title in file name
-A, --auto-number number downloaded files starting from 00000
2011-09-26 18:29:15 +00:00
-o, --output TEMPLATE output filename template. Use %(stitle)s to get the
title, %(uploader)s for the uploader name,
%(autonumber)s to get an automatically incremented
number, %(ext)s for the filename extension,
%(upload_date)s for the upload date (YYYYMMDD), and
2011-11-29 19:22:27 +00:00
%% for a literal percent. Use - to output to
stdout.
2011-08-24 22:09:28 +00:00
-a, --batch-file FILE file containing URLs to download ('-' for stdin)
-w, --no-overwrites do not overwrite files
-c, --continue resume partially downloaded files
2011-09-15 17:23:17 +00:00
--no-continue do not resume partially downloaded files (restart
from beginning)
2011-09-21 16:48:51 +00:00
--cookies FILE file to read cookies from and dump cookie jar in
2011-08-24 22:09:28 +00:00
--no-part do not use .part files
--no-mtime do not use the Last-modified header to set the file
modification time
--write-description write video description to a .description file
--write-info-json write video metadata to a .info.json file
2011-08-05 23:14:13 +00:00
## Verbosity / Simulation Options:
2011-08-24 22:09:28 +00:00
-q, --quiet activates quiet mode
2011-09-15 10:45:56 +00:00
-s, --simulate do not download the video and do not write anything
to disk
--skip-download do not download the video
2011-08-24 22:09:28 +00:00
-g, --get-url simulate, quiet but print URL
-e, --get-title simulate, quiet but print title
--get-thumbnail simulate, quiet but print thumbnail URL
--get-description simulate, quiet but print video description
--get-filename simulate, quiet but print output filename
2011-09-15 10:45:56 +00:00
--get-format simulate, quiet but print output format
2011-08-24 22:09:28 +00:00
--no-progress do not print progress bar
--console-title display progress in console titlebar
2012-02-26 23:42:26 +00:00
-v, --verbose print various debugging information
2011-08-05 23:14:13 +00:00
## Video Format Options:
2011-08-24 22:09:28 +00:00
-f, --format FORMAT video format code
--all-formats download all available video formats
2011-12-08 20:39:13 +00:00
--prefer-free-formats prefer free video formats unless a specific one is
requested
2011-08-24 22:09:28 +00:00
--max-quality FORMAT highest quality format to download
2011-09-30 07:07:36 +00:00
-F, --list-formats list all available formats (currently youtube only)
--write-srt write video closed captions to a .srt file
(currently youtube only)
--srt-lang LANG language of the closed captions to download
(optional) use IETF language tags like 'en'
2011-08-05 23:14:13 +00:00
## Authentication Options:
2011-08-24 22:09:28 +00:00
-u, --username USERNAME account username
-p, --password PASSWORD account password
-n, --netrc use .netrc authentication data
2011-08-05 23:14:13 +00:00
## Post-processing Options:
2011-08-24 22:09:28 +00:00
--extract-audio convert video files to audio-only files (requires
2012-05-31 20:42:25 +00:00
ffmpeg or avconv and ffprobe or avprobe)
2011-12-17 00:35:05 +00:00
--audio-format FORMAT "best", "aac", "vorbis", "mp3", "m4a", or "wav";
best by default
--audio-quality QUALITY ffmpeg/avconv audio quality specification, insert a
value between 0 (better) and 9 (worse) for VBR or a
specific bitrate like 128K (default 5)
2011-09-15 10:45:56 +00:00
-k, --keep-video keeps the video file on disk after the post-
processing; the video is erased by default
2011-08-05 23:14:13 +00:00
# FAQ
2011-09-04 09:41:54 +00:00
### Can you please put the -b option back?
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.
2011-09-14 19:18:22 +00:00
### I get HTTP error 402 when trying to download a video. What's this?
2011-09-04 09:41:54 +00:00
2011-09-13 21:58:31 +00:00
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.
2011-09-04 09:41:54 +00:00
### I have downloaded a video but how can I play it?
Once the video is fully downloaded, use any video player, such as [vlc](http://www.videolan.org) or [mplayer](http://www.mplayerhq.hu/).
### The links provided by youtube-dl -g are not working anymore
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.
2011-09-04 09:41:54 +00:00
### ERROR: no fmt_url_map or conn information found in video info
2011-09-13 19:51:06 +00:00
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`.
### ERROR: unable to download video ###
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`.
### SyntaxError: Non-ASCII character ###
The error
File "youtube-dl", line 2
SyntaxError: Non-ASCII character '\x93' ...
means you're using an outdated version of Python. Please update to Python 2.6 or 2.7.
To run youtube-dl under Python 2.5, you'll have to manually check it out like this:
git clone git://github.com/rg3/youtube-dl.git
cd youtube-dl
python -m youtube_dl --help
Please note that Python 2.5 is not supported anymore.
### What is this binary file? Where has the code gone?
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 repo to see the code. If you modify the code, you can run it by executing the `__main__.py` file. To recompile the executable, run `make compile`.
# COPYRIGHT
youtube-dl is released into the public domain by the copyright holders.
This README file was originally written by Daniel Bolton (<https://github.com/dbbolton>) and is likewise released into the public domain.
2011-08-05 23:14:13 +00:00
# BUGS
2011-09-09 06:47:00 +00:00
2011-09-13 21:58:31 +00:00
Bugs and suggestions should be reported at: <https://github.com/rg3/youtube-dl/issues>
2011-09-09 06:47:00 +00:00
Please include:
* 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.
* The output of `youtube-dl --version`
* The output of `python --version`
* The name and version of your Operating System ("Ubuntu 11.04 x64" or "Windows 7 x64" is usually enough).