You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

435 lines
30 KiB

13 years ago
13 years ago
13 years ago
  1. % YOUTUBE-DL(1)
  2. # NAME
  3. youtube-dl - download videos from youtube.com or other video platforms
  4. # SYNOPSIS
  5. **youtube-dl** [OPTIONS] URL [URL...]
  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.6, 2.7, or 3.3+, and it is not platform specific. It should work on
  10. your Unix box, on Windows or on 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. # OPTIONS
  13. -h, --help print this help text and exit
  14. --version print program version and exit
  15. -U, --update update this program to latest version. Make
  16. sure that you have sufficient permissions
  17. (run with sudo if needed)
  18. -i, --ignore-errors continue on download errors, for example to
  19. skip unavailable videos in a playlist
  20. --abort-on-error Abort downloading of further videos (in the
  21. playlist or the command line) if an error
  22. occurs
  23. --dump-user-agent display the current browser identification
  24. --user-agent UA specify a custom user agent
  25. --referer REF specify a custom referer, use if the video
  26. access is restricted to one domain
  27. --add-header FIELD:VALUE specify a custom HTTP header and its value,
  28. separated by a colon ':'. You can use this
  29. option multiple times
  30. --list-extractors List all supported extractors and the URLs
  31. they would handle
  32. --extractor-descriptions Output descriptions of all supported
  33. extractors
  34. --proxy URL Use the specified HTTP/HTTPS proxy. Pass in
  35. an empty string (--proxy "") for direct
  36. connection
  37. --no-check-certificate Suppress HTTPS certificate validation.
  38. --prefer-insecure Use an unencrypted connection to retrieve
  39. information about the video. (Currently
  40. supported only for YouTube)
  41. --cache-dir DIR Location in the filesystem where youtube-dl
  42. can store some downloaded information
  43. permanently. By default $XDG_CACHE_HOME
  44. /youtube-dl or ~/.cache/youtube-dl . At the
  45. moment, only YouTube player files (for
  46. videos with obfuscated signatures) are
  47. cached, but that may change.
  48. --no-cache-dir Disable filesystem caching
  49. --socket-timeout None Time to wait before giving up, in seconds
  50. --bidi-workaround Work around terminals that lack
  51. bidirectional text support. Requires bidiv
  52. or fribidi executable in PATH
  53. --default-search PREFIX Use this prefix for unqualified URLs. For
  54. example "gvsearch2:" downloads two videos
  55. from google videos for youtube-dl "large
  56. apple". By default (with value "auto")
  57. youtube-dl guesses.
  58. --ignore-config Do not read configuration files. When given
  59. in the global configuration file /etc
  60. /youtube-dl.conf: do not read the user
  61. configuration in ~/.config/youtube-dl.conf
  62. (%APPDATA%/youtube-dl/config.txt on
  63. Windows)
  64. ## Video Selection:
  65. --playlist-start NUMBER playlist video to start at (default is 1)
  66. --playlist-end NUMBER playlist video to end at (default is last)
  67. --match-title REGEX download only matching titles (regex or
  68. caseless sub-string)
  69. --reject-title REGEX skip download for matching titles (regex or
  70. caseless sub-string)
  71. --max-downloads NUMBER Abort after downloading NUMBER files
  72. --min-filesize SIZE Do not download any videos smaller than
  73. SIZE (e.g. 50k or 44.6m)
  74. --max-filesize SIZE Do not download any videos larger than SIZE
  75. (e.g. 50k or 44.6m)
  76. --date DATE download only videos uploaded in this date
  77. --datebefore DATE download only videos uploaded on or before
  78. this date (i.e. inclusive)
  79. --dateafter DATE download only videos uploaded on or after
  80. this date (i.e. inclusive)
  81. --min-views COUNT Do not download any videos with less than
  82. COUNT views
  83. --max-views COUNT Do not download any videos with more than
  84. COUNT views
  85. --no-playlist download only the currently playing video
  86. --age-limit YEARS download only videos suitable for the given
  87. age
  88. --download-archive FILE Download only videos not listed in the
  89. archive file. Record the IDs of all
  90. downloaded videos in it.
  91. --include-ads Download advertisements as well
  92. (experimental)
  93. --youtube-include-dash-manifest Try to download the DASH manifest on
  94. YouTube videos (experimental)
  95. ## Download Options:
  96. -r, --rate-limit LIMIT maximum download rate in bytes per second
  97. (e.g. 50K or 4.2M)
  98. -R, --retries RETRIES number of retries (default is 10)
  99. --buffer-size SIZE size of download buffer (e.g. 1024 or 16K)
  100. (default is 1024)
  101. --no-resize-buffer do not automatically adjust the buffer
  102. size. By default, the buffer size is
  103. automatically resized from an initial value
  104. of SIZE.
  105. ## Filesystem Options:
  106. -t, --title use title in file name (default)
  107. --id use only video ID in file name
  108. -l, --literal [deprecated] alias of --title
  109. -A, --auto-number number downloaded files starting from 00000
  110. -o, --output TEMPLATE output filename template. Use %(title)s to
  111. get the title, %(uploader)s for the
  112. uploader name, %(uploader_id)s for the
  113. uploader nickname if different,
  114. %(autonumber)s to get an automatically
  115. incremented number, %(ext)s for the
  116. filename extension, %(format)s for the
  117. format description (like "22 - 1280x720" or
  118. "HD"), %(format_id)s for the unique id of
  119. the format (like Youtube's itags: "137"),
  120. %(upload_date)s for the upload date
  121. (YYYYMMDD), %(extractor)s for the provider
  122. (youtube, metacafe, etc), %(id)s for the
  123. video id, %(playlist)s for the playlist the
  124. video is in, %(playlist_index)s for the
  125. position in the playlist and %% for a
  126. literal percent. %(height)s and %(width)s
  127. for the width and height of the video
  128. format. %(resolution)s for a textual
  129. description of the resolution of the video
  130. format. Use - to output to stdout. Can also
  131. be used to download to a different
  132. directory, for example with -o '/my/downloa
  133. ds/%(uploader)s/%(title)s-%(id)s.%(ext)s' .
  134. --autonumber-size NUMBER Specifies the number of digits in
  135. %(autonumber)s when it is present in output
  136. filename template or --auto-number option
  137. is given
  138. --restrict-filenames Restrict filenames to only ASCII
  139. characters, and avoid "&" and spaces in
  140. filenames
  141. -a, --batch-file FILE file containing URLs to download ('-' for
  142. stdin)
  143. --load-info FILE json file containing the video information
  144. (created with the "--write-json" option)
  145. -w, --no-overwrites do not overwrite files
  146. -c, --continue force resume of partially downloaded files.
  147. By default, youtube-dl will resume
  148. downloads if possible.
  149. --no-continue do not resume partially downloaded files
  150. (restart from beginning)
  151. --cookies FILE file to read cookies from and dump cookie
  152. jar in
  153. --no-part do not use .part files
  154. --no-mtime do not use the Last-modified header to set
  155. the file modification time
  156. --write-description write video description to a .description
  157. file
  158. --write-info-json write video metadata to a .info.json file
  159. --write-annotations write video annotations to a .annotation
  160. file
  161. --write-thumbnail write thumbnail image to disk
  162. ## Verbosity / Simulation Options:
  163. -q, --quiet activates quiet mode
  164. --no-warnings Ignore warnings
  165. -s, --simulate do not download the video and do not write
  166. anything to disk
  167. --skip-download do not download the video
  168. -g, --get-url simulate, quiet but print URL
  169. -e, --get-title simulate, quiet but print title
  170. --get-id simulate, quiet but print id
  171. --get-thumbnail simulate, quiet but print thumbnail URL
  172. --get-description simulate, quiet but print video description
  173. --get-duration simulate, quiet but print video length
  174. --get-filename simulate, quiet but print output filename
  175. --get-format simulate, quiet but print output format
  176. -j, --dump-json simulate, quiet but print JSON information
  177. --newline output progress bar as new lines
  178. --no-progress do not print progress bar
  179. --console-title display progress in console titlebar
  180. -v, --verbose print various debugging information
  181. --dump-intermediate-pages print downloaded pages to debug problems
  182. (very verbose)
  183. --write-pages Write downloaded intermediary pages to
  184. files in the current directory to debug
  185. problems
  186. --print-traffic Display sent and read HTTP traffic
  187. ## Video Format Options:
  188. -f, --format FORMAT video format code, specify the order of
  189. preference using slashes: "-f 22/17/18".
  190. "-f mp4" and "-f flv" are also supported.
  191. You can also use the special names "best",
  192. "bestvideo", "bestaudio", "worst",
  193. "worstvideo" and "worstaudio". By default,
  194. youtube-dl will pick the best quality.
  195. --all-formats download all available video formats
  196. --prefer-free-formats prefer free video formats unless a specific
  197. one is requested
  198. --max-quality FORMAT highest quality format to download
  199. -F, --list-formats list all available formats
  200. ## Subtitle Options:
  201. --write-sub write subtitle file
  202. --write-auto-sub write automatic subtitle file (youtube
  203. only)
  204. --all-subs downloads all the available subtitles of
  205. the video
  206. --list-subs lists all available subtitles for the video
  207. --sub-format FORMAT subtitle format (default=srt) ([sbv/vtt]
  208. youtube only)
  209. --sub-lang LANGS languages of the subtitles to download
  210. (optional) separated by commas, use IETF
  211. language tags like 'en,pt'
  212. ## Authentication Options:
  213. -u, --username USERNAME account username
  214. -p, --password PASSWORD account password
  215. -n, --netrc use .netrc authentication data
  216. --video-password PASSWORD video password (vimeo, smotri)
  217. ## Post-processing Options:
  218. -x, --extract-audio convert video files to audio-only files
  219. (requires ffmpeg or avconv and ffprobe or
  220. avprobe)
  221. --audio-format FORMAT "best", "aac", "vorbis", "mp3", "m4a",
  222. "opus", or "wav"; best by default
  223. --audio-quality QUALITY ffmpeg/avconv audio quality specification,
  224. insert a value between 0 (better) and 9
  225. (worse) for VBR or a specific bitrate like
  226. 128K (default 5)
  227. --recode-video FORMAT Encode the video to another format if
  228. necessary (currently supported:
  229. mp4|flv|ogg|webm)
  230. -k, --keep-video keeps the video file on disk after the
  231. post-processing; the video is erased by
  232. default
  233. --no-post-overwrites do not overwrite post-processed files; the
  234. post-processed files are overwritten by
  235. default
  236. --embed-subs embed subtitles in the video (only for mp4
  237. videos)
  238. --add-metadata write metadata to the video file
  239. --xattrs write metadata to the video file's xattrs
  240. (using dublin core and xdg standards)
  241. --prefer-avconv Prefer avconv over ffmpeg for running the
  242. postprocessors (default)
  243. --prefer-ffmpeg Prefer ffmpeg over avconv for running the
  244. postprocessors
  245. # CONFIGURATION
  246. 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 `~/.config/youtube-dl/config`. On Windows, the configuration file locations are `%APPDATA%\youtube-dl\config.txt` and `C:\Users\<Yourname>\youtube-dl.conf`.
  247. # OUTPUT TEMPLATE
  248. 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:
  249. - `id`: The sequence will be replaced by the video identifier.
  250. - `url`: The sequence will be replaced by the video URL.
  251. - `uploader`: The sequence will be replaced by the nickname of the person who uploaded the video.
  252. - `upload_date`: The sequence will be replaced by the upload date in YYYYMMDD format.
  253. - `title`: The sequence will be replaced by the video title.
  254. - `ext`: The sequence will be replaced by the appropriate extension (like flv or mp4).
  255. - `epoch`: The sequence will be replaced by the Unix epoch when creating the file.
  256. - `autonumber`: The sequence will be replaced by a five-digit number that will be increased with each download, starting at zero.
  257. - `playlist`: The name or the id of the playlist that contains the video.
  258. - `playlist_index`: The index of the video in the playlist, a five-digit number.
  259. The current default template is `%(title)s-%(id)s.%(ext)s`.
  260. 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:
  261. $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc
  262. youtube-dl test video ''_ä↭𝕐.mp4 # All kinds of weird characters
  263. $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
  264. youtube-dl_test_video_.mp4 # A simple file name
  265. # VIDEO SELECTION
  266. Videos can be filtered by their upload date using the options `--date`, `--datebefore` or `--dateafter`, they accept dates in two formats:
  267. - Absolute dates: Dates in the format `YYYYMMDD`.
  268. - Relative dates: Dates in the format `(now|today)[+-][0-9](day|week|month|year)(s)?`
  269. Examples:
  270. # Download only the videos uploaded in the last 6 months
  271. $ youtube-dl --dateafter now-6months
  272. # Download only the videos uploaded on January 1, 1970
  273. $ youtube-dl --date 19700101
  274. $ # will only download the videos uploaded in the 200x decade
  275. $ youtube-dl --dateafter 20000101 --datebefore 20091231
  276. # FAQ
  277. ### Can you please put the -b option back?
  278. 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.
  279. ### I get HTTP error 402 when trying to download a video. What's this?
  280. 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.
  281. ### I have downloaded a video but how can I play it?
  282. Once the video is fully downloaded, use any video player, such as [vlc](http://www.videolan.org) or [mplayer](http://www.mplayerhq.hu/).
  283. ### The links provided by youtube-dl -g are not working anymore
  284. 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.
  285. ### ERROR: no fmt_url_map or conn information found in video info
  286. 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`.
  287. ### ERROR: unable to download video ###
  288. 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`.
  289. ### SyntaxError: Non-ASCII character ###
  290. The error
  291. File "youtube-dl", line 2
  292. SyntaxError: Non-ASCII character '\x93' ...
  293. means you're using an outdated version of Python. Please update to Python 2.6 or 2.7.
  294. ### What is this binary file? Where has the code gone?
  295. 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`.
  296. ### The exe throws a *Runtime error from Visual C++*
  297. 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).
  298. # DEVELOPER INSTRUCTIONS
  299. Most users do not need to build youtube-dl and can [download the builds](http://rg3.github.io/youtube-dl/download.html) or get them from their distribution.
  300. To run youtube-dl as a developer, you don't need to build anything either. Simply execute
  301. python -m youtube_dl
  302. To run the test, simply invoke your favorite test runner, or execute a test file directly; any of the following work:
  303. python -m unittest discover
  304. python test/test_download.py
  305. nosetests
  306. If you want to create a build of youtube-dl yourself, you'll need
  307. * python
  308. * make
  309. * pandoc
  310. * zip
  311. * nosetests
  312. ### Adding support for a new site
  313. If you want to add support for a new site, copy *any* [recently modified](https://github.com/rg3/youtube-dl/commits/master/youtube_dl/extractor) file in `youtube_dl/extractor`, add an import in [`youtube_dl/extractor/__init__.py`](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/__init__.py). Have a look at [`youtube_dl/common/extractor/common.py`](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py) for possible helper methods and a [detailed description of what your extractor should return](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py#L38). Don't forget to run the tests with `python test/test_download.py TestDownload.test_YourExtractor`! For a detailed tutorial, refer to [this blog post](http://filippo.io/add-support-for-a-new-video-site-to-youtube-dl/).
  314. # BUGS
  315. Bugs and suggestions should be reported at: <https://github.com/rg3/youtube-dl/issues> . Unless you were prompted so or there is another pertinent reason (e.g. GitHub fails to accept the bug report), please do not send bug reports via personal email.
  316. Please include the full output of the command when run with `--verbose`. The output (including the first lines) contain important debugging information. Issues without the full output are often not reproducible and therefore do not get solved in short order, if ever.
  317. For discussions, join us in the irc channel #youtube-dl on freenode.
  318. When you submit a request, please re-read it once to avoid a couple of mistakes (you can and should use this as a checklist):
  319. ### Is the description of the issue itself sufficient?
  320. We often get issue reports that we cannot really decipher. While in most cases we eventually get the required information after asking back multiple times, this poses an unnecessary drain on our resources. Many contributors, including myself, are also not native speakers, so we may misread some parts.
  321. So please elaborate on what feature you are requesting, or what bug you want to be fixed. Make sure that it's obvious
  322. - What the problem is
  323. - How it could be fixed
  324. - How your proposed solution would look like
  325. If your report is shorter than two lines, it is almost certainly missing some of these, which makes it hard for us to respond to it. We're often too polite to close the issue outright, but the missing info makes misinterpretation likely. As a commiter myself, I often get frustrated by these issues, since the only possible way for me to move forward on them is to ask for clarification over and over.
  326. For bug reports, this means that your report should contain the *complete* output of youtube-dl when called with the -v flag. The error message you get for (most) bugs even says so, but you would not believe how many of our bug reports do not contain this information.
  327. Site support requests must contain an example URL. An example URL is a URL you might want to download, like http://www.youtube.com/watch?v=BaW_jenozKc . There should be an obvious video present. Except under very special circumstances, the main page of a video service (e.g. http://www.youtube.com/ ) is *not* an example URL.
  328. ### Are you using the latest version?
  329. Before reporting any issue, type youtube-dl -U. This should report that you're up-to-date. About 20% of the reports we receive are already fixed, but people are using outdated versions. This goes for feature requests as well.
  330. ### Is the issue already documented?
  331. Make sure that someone has not already opened the issue you're trying to open. Search at the top of the window or at https://github.com/rg3/youtube-dl/search?type=Issues . If there is an issue, feel free to write something along the lines of "This affects me as well, with version 2015.01.01. Here is some more information on the issue: ...". While some issues may be old, a new post into them often spurs rapid activity.
  332. ### Why are existing options not enough?
  333. Before requesting a new feature, please have a quick peek at [the list of supported options](https://github.com/rg3/youtube-dl/blob/master/README.md#synopsis). Many feature requests are for features that actually exist already! Please, absolutely do show off your work in the issue report and detail how the existing similar options do *not* solve your problem.
  334. ### Is there enough context in your bug report?
  335. People want to solve problems, and often think they do us a favor by breaking down their larger problems (e.g. wanting to skip already downloaded files) to a specific request (e.g. requesting us to look whether the file exists before downloading the info page). However, what often happens is that they break down the problem into two steps: One simple, and one impossible (or extremely complicated one).
  336. We are then presented with a very complicated request when the original problem could be solved far easier, e.g. by recording the downloaded video IDs in a separate file. To avoid this, you must include the greater context where it is non-obvious. In particular, every feature request that does not consist of adding support for a new site should contain a use case scenario that explains in what situation the missing feature would be useful.
  337. ### Does the issue involve one problem, and one problem only?
  338. Some of our users seem to think there is a limit of issues they can or should open. There is no limit of issues they can or should open. While it may seem appealing to be able to dump all your issues into one ticket, that means that someone who solves one of your issues cannot mark the issue as closed. Typically, reporting a bunch of issues leads to the ticket lingering since nobody wants to attack that behemoth, until someone mercifully splits the issue into multiple ones.
  339. In particular, every site support request issue should only pertain to services at one site (generally under a common domain, but always using the same backend technology). Do not request support for vimeo user videos, Whitehouse podcasts, and Google Plus pages in the same issue. Also, make sure that you don't post bug reports alongside feature requests. As a rule of thumb, a feature request does not include outputs of youtube-dl that are not immediately related to the feature at hand. Do not post reports of a network error alongside the request for a new video service.
  340. ### Is anyone going to need the feature?
  341. Only post features that you (or an incapicated friend you can personally talk to) require. Do not post features because they seem like a good idea. If they are really useful, they will be requested by someone who requires them.
  342. ### Is your question about youtube-dl?
  343. It may sound strange, but some bug reports we receive are completely unrelated to youtube-dl and relate to a different or even the reporter's own application. Please make sure that you are actually using youtube-dl. If you are using a UI for youtube-dl, report the bug to the maintainer of the actual application providing the UI. On the other hand, if your UI for youtube-dl fails in some way you believe is related to youtube-dl, by all means, go ahead and report the bug.
  344. # COPYRIGHT
  345. youtube-dl is released into the public domain by the copyright holders.
  346. This README file was originally written by Daniel Bolton (<https://github.com/dbbolton>) and is likewise released into the public domain.