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.

279 lines
17 KiB

13 years ago
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 sure
  16. that you have sufficient permissions (run with
  17. sudo if needed)
  18. -i, --ignore-errors continue on download errors, for example to 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 occurs
  22. --dump-user-agent display the current browser identification
  23. --user-agent UA specify a custom user agent
  24. --referer REF specify a custom referer, use if the video access
  25. is restricted to one domain
  26. --list-extractors List all supported extractors and the URLs they
  27. would handle
  28. --extractor-descriptions Output descriptions of all supported extractors
  29. --proxy URL Use the specified HTTP/HTTPS proxy
  30. --no-check-certificate Suppress HTTPS certificate validation.
  31. --cache-dir DIR Location in the filesystem where youtube-dl can
  32. store downloaded information permanently. By
  33. default $XDG_CACHE_HOME/youtube-dl or ~/.cache
  34. /youtube-dl .
  35. --no-cache-dir Disable filesystem caching
  36. ## Video Selection:
  37. --playlist-start NUMBER playlist video to start at (default is 1)
  38. --playlist-end NUMBER playlist video to end at (default is last)
  39. --match-title REGEX download only matching titles (regex or caseless
  40. sub-string)
  41. --reject-title REGEX skip download for matching titles (regex or
  42. caseless sub-string)
  43. --max-downloads NUMBER Abort after downloading NUMBER files
  44. --min-filesize SIZE Do not download any videos smaller than SIZE
  45. (e.g. 50k or 44.6m)
  46. --max-filesize SIZE Do not download any videos larger than SIZE (e.g.
  47. 50k or 44.6m)
  48. --date DATE download only videos uploaded in this date
  49. --datebefore DATE download only videos uploaded before this date
  50. --dateafter DATE download only videos uploaded after this date
  51. --no-playlist download only the currently playing video
  52. --age-limit YEARS download only videos suitable for the given age
  53. --download-archive FILE Download only videos not present in the archive
  54. file. Record all downloaded videos in it.
  55. ## Download Options:
  56. -r, --rate-limit LIMIT maximum download rate in bytes per second (e.g.
  57. 50K or 4.2M)
  58. -R, --retries RETRIES number of retries (default is 10)
  59. --buffer-size SIZE size of download buffer (e.g. 1024 or 16K)
  60. (default is 1024)
  61. --no-resize-buffer do not automatically adjust the buffer size. By
  62. default, the buffer size is automatically resized
  63. from an initial value of SIZE.
  64. ## Filesystem Options:
  65. -t, --title use title in file name (default)
  66. --id use only video ID in file name
  67. -l, --literal [deprecated] alias of --title
  68. -A, --auto-number number downloaded files starting from 00000
  69. -o, --output TEMPLATE output filename template. Use %(title)s to get
  70. the title, %(uploader)s for the uploader name,
  71. %(uploader_id)s for the uploader nickname if
  72. different, %(autonumber)s to get an automatically
  73. incremented number, %(ext)s for the filename
  74. extension, %(format)s for the format description
  75. (like "22 - 1280x720" or "HD")%(upload_date)s for
  76. the upload date (YYYYMMDD), %(extractor)s for the
  77. provider (youtube, metacafe, etc), %(id)s for the
  78. video id , %(playlist)s for the playlist the
  79. video is in, %(playlist_index)s for the position
  80. in the playlist and %% for a literal percent. Use
  81. - to output to stdout. Can also be used to
  82. download to a different directory, for example
  83. with -o '/my/downloads/%(uploader)s/%(title)s-%(i
  84. d)s.%(ext)s' .
  85. --autonumber-size NUMBER Specifies the number of digits in %(autonumber)s
  86. when it is present in output filename template or
  87. --autonumber option is given
  88. --restrict-filenames Restrict filenames to only ASCII characters, and
  89. avoid "&" and spaces in filenames
  90. -a, --batch-file FILE file containing URLs to download ('-' for stdin)
  91. -w, --no-overwrites do not overwrite files
  92. -c, --continue resume partially downloaded files
  93. --no-continue do not resume partially downloaded files (restart
  94. from beginning)
  95. --cookies FILE file to read cookies from and dump cookie jar in
  96. --no-part do not use .part files
  97. --no-mtime do not use the Last-modified header to set the
  98. file modification time
  99. --write-description write video description to a .description file
  100. --write-info-json write video metadata to a .info.json file
  101. --write-annotations write video annotations to a .annotation file
  102. --write-thumbnail write thumbnail image to disk
  103. ## Verbosity / Simulation Options:
  104. -q, --quiet activates quiet mode
  105. -s, --simulate do not download the video and do not write
  106. anything to disk
  107. --skip-download do not download the video
  108. -g, --get-url simulate, quiet but print URL
  109. -e, --get-title simulate, quiet but print title
  110. --get-id simulate, quiet but print id
  111. --get-thumbnail simulate, quiet but print thumbnail URL
  112. --get-description simulate, quiet but print video description
  113. --get-filename simulate, quiet but print output filename
  114. --get-format simulate, quiet but print output format
  115. --newline output progress bar as new lines
  116. --no-progress do not print progress bar
  117. --console-title display progress in console titlebar
  118. -v, --verbose print various debugging information
  119. --dump-intermediate-pages print downloaded pages to debug problems(very
  120. verbose)
  121. ## Video Format Options:
  122. -f, --format FORMAT video format code, specifiy the order of
  123. preference using slashes: "-f 22/17/18". "-f mp4"
  124. and "-f flv" are also supported
  125. --all-formats download all available video formats
  126. --prefer-free-formats prefer free video formats unless a specific one
  127. is requested
  128. --max-quality FORMAT highest quality format to download
  129. -F, --list-formats list all available formats (currently youtube
  130. only)
  131. ## Subtitle Options:
  132. --write-sub write subtitle file
  133. --write-auto-sub write automatic subtitle file (youtube only)
  134. --all-subs downloads all the available subtitles of the
  135. video
  136. --list-subs lists all available subtitles for the video
  137. --sub-format FORMAT subtitle format (default=srt) ([sbv/vtt] youtube
  138. only)
  139. --sub-lang LANGS languages of the subtitles to download (optional)
  140. separated by commas, use IETF language tags like
  141. 'en,pt'
  142. ## Authentication Options:
  143. -u, --username USERNAME account username
  144. -p, --password PASSWORD account password
  145. -n, --netrc use .netrc authentication data
  146. --video-password PASSWORD video password (vimeo only)
  147. ## Post-processing Options:
  148. -x, --extract-audio convert video files to audio-only files (requires
  149. ffmpeg or avconv and ffprobe or avprobe)
  150. --audio-format FORMAT "best", "aac", "vorbis", "mp3", "m4a", "opus", or
  151. "wav"; best by default
  152. --audio-quality QUALITY ffmpeg/avconv audio quality specification, insert
  153. a value between 0 (better) and 9 (worse) for VBR
  154. or a specific bitrate like 128K (default 5)
  155. --recode-video FORMAT Encode the video to another format if necessary
  156. (currently supported: mp4|flv|ogg|webm)
  157. -k, --keep-video keeps the video file on disk after the post-
  158. processing; the video is erased by default
  159. --no-post-overwrites do not overwrite post-processed files; the post-
  160. processed files are overwritten by default
  161. --embed-subs embed subtitles in the video (only for mp4
  162. videos)
  163. --add-metadata add metadata to the files
  164. # CONFIGURATION
  165. 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.conf`.
  166. # OUTPUT TEMPLATE
  167. 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:
  168. - `id`: The sequence will be replaced by the video identifier.
  169. - `url`: The sequence will be replaced by the video URL.
  170. - `uploader`: The sequence will be replaced by the nickname of the person who uploaded the video.
  171. - `upload_date`: The sequence will be replaced by the upload date in YYYYMMDD format.
  172. - `title`: The sequence will be replaced by the video title.
  173. - `ext`: The sequence will be replaced by the appropriate extension (like flv or mp4).
  174. - `epoch`: The sequence will be replaced by the Unix epoch when creating the file.
  175. - `autonumber`: The sequence will be replaced by a five-digit number that will be increased with each download, starting at zero.
  176. - `playlist`: The name or the id of the playlist that contains the video.
  177. - `playlist_index`: The index of the video in the playlist, a five-digit number.
  178. The current default template is `%(title)s-%(id)s.%(ext)s`.
  179. 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:
  180. $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc
  181. youtube-dl test video ''_ä↭𝕐.mp4 # All kinds of weird characters
  182. $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
  183. youtube-dl_test_video_.mp4 # A simple file name
  184. # VIDEO SELECTION
  185. Videos can be filtered by their upload date using the options `--date`, `--datebefore` or `--dateafter`, they accept dates in two formats:
  186. - Absolute dates: Dates in the format `YYYYMMDD`.
  187. - Relative dates: Dates in the format `(now|today)[+-][0-9](day|week|month|year)(s)?`
  188. Examples:
  189. $ youtube-dl --dateafter now-6months #will only download the videos uploaded in the last 6 months
  190. $ youtube-dl --date 19700101 #will only download the videos uploaded in January 1, 1970
  191. $ youtube-dl --dateafter 20000101 --datebefore 20100101 #will only download the videos uploaded between 2000 and 2010
  192. # FAQ
  193. ### Can you please put the -b option back?
  194. 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.
  195. ### I get HTTP error 402 when trying to download a video. What's this?
  196. 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.
  197. ### I have downloaded a video but how can I play it?
  198. Once the video is fully downloaded, use any video player, such as [vlc](http://www.videolan.org) or [mplayer](http://www.mplayerhq.hu/).
  199. ### The links provided by youtube-dl -g are not working anymore
  200. 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.
  201. ### ERROR: no fmt_url_map or conn information found in video info
  202. 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`.
  203. ### ERROR: unable to download video ###
  204. 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`.
  205. ### SyntaxError: Non-ASCII character ###
  206. The error
  207. File "youtube-dl", line 2
  208. SyntaxError: Non-ASCII character '\x93' ...
  209. means you're using an outdated version of Python. Please update to Python 2.6 or 2.7.
  210. ### What is this binary file? Where has the code gone?
  211. 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`.
  212. ### The exe throws a *Runtime error from Visual C++*
  213. 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).
  214. # COPYRIGHT
  215. youtube-dl is released into the public domain by the copyright holders.
  216. This README file was originally written by Daniel Bolton (<https://github.com/dbbolton>) and is likewise released into the public domain.
  217. # BUGS
  218. Bugs and suggestions should be reported at: <https://github.com/rg3/youtube-dl/issues>
  219. Please include:
  220. * 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.
  221. * If possible re-run the command with `--verbose`, and include the full output, it is really helpful to us.
  222. * The output of `youtube-dl --version`
  223. * The output of `python --version`
  224. * The name and version of your Operating System ("Ubuntu 11.04 x64" or "Windows 7 x64" is usually enough).
  225. For discussions, join us in the irc channel #youtube-dl on freenode.