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.

207 lines
12 KiB

13 years ago
13 years ago
13 years ago
13 years ago
13 years ago
13 years ago
13 years ago
13 years ago
13 years ago
13 years ago
13 years ago
13 years ago
13 years ago
  1. % YOUTUBE-DL(1)
  2. # NAME
  3. youtube-dl
  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
  16. -i, --ignore-errors continue on download errors
  17. -r, --rate-limit LIMIT download rate limit (e.g. 50k or 44.6m)
  18. -R, --retries RETRIES number of retries (default is 10)
  19. --buffer-size SIZE size of download buffer (e.g. 1024 or 16k) (default
  20. is 1024)
  21. --no-resize-buffer do not automatically adjust the buffer size. By
  22. default, the buffer size is automatically resized
  23. from an initial value of SIZE.
  24. --dump-user-agent display the current browser identification
  25. --user-agent UA specify a custom user agent
  26. --list-extractors List all supported extractors and the URLs they
  27. would handle
  28. ## Video Selection:
  29. --playlist-start NUMBER playlist video to start at (default is 1)
  30. --playlist-end NUMBER playlist video to end at (default is last)
  31. --match-title REGEX download only matching titles (regex or caseless
  32. sub-string)
  33. --reject-title REGEX skip download for matching titles (regex or
  34. caseless sub-string)
  35. --max-downloads NUMBER Abort after downloading NUMBER files
  36. ## Filesystem Options:
  37. -t, --title use title in file name
  38. --id use video ID in file name
  39. -l, --literal [deprecated] alias of --title
  40. -A, --auto-number number downloaded files starting from 00000
  41. -o, --output TEMPLATE output filename template. Use %(title)s to get the
  42. title, %(uploader)s for the uploader name,
  43. %(uploader_id)s for the uploader nickname if
  44. different, %(autonumber)s to get an automatically
  45. incremented number, %(ext)s for the filename
  46. extension, %(upload_date)s for the upload date
  47. (YYYYMMDD), %(extractor)s for the provider
  48. (youtube, metacafe, etc), %(id)s for the video id
  49. and %% for a literal percent. Use - to output to
  50. stdout. Can also be used to download to a different
  51. directory, for example with -o '/my/downloads/%(upl
  52. oader)s/%(title)s-%(id)s.%(ext)s' .
  53. --restrict-filenames Restrict filenames to only ASCII characters, and
  54. avoid "&" and spaces in filenames
  55. -a, --batch-file FILE file containing URLs to download ('-' for stdin)
  56. -w, --no-overwrites do not overwrite files
  57. -c, --continue resume partially downloaded files
  58. --no-continue do not resume partially downloaded files (restart
  59. from beginning)
  60. --cookies FILE file to read cookies from and dump cookie jar in
  61. --no-part do not use .part files
  62. --no-mtime do not use the Last-modified header to set the file
  63. modification time
  64. --write-description write video description to a .description file
  65. --write-info-json write video metadata to a .info.json file
  66. ## Verbosity / Simulation Options:
  67. -q, --quiet activates quiet mode
  68. -s, --simulate do not download the video and do not write anything
  69. to disk
  70. --skip-download do not download the video
  71. -g, --get-url simulate, quiet but print URL
  72. -e, --get-title simulate, quiet but print title
  73. --get-thumbnail simulate, quiet but print thumbnail URL
  74. --get-description simulate, quiet but print video description
  75. --get-filename simulate, quiet but print output filename
  76. --get-format simulate, quiet but print output format
  77. --no-progress do not print progress bar
  78. --console-title display progress in console titlebar
  79. -v, --verbose print various debugging information
  80. ## Video Format Options:
  81. -f, --format FORMAT video format code
  82. --all-formats download all available video formats
  83. --prefer-free-formats prefer free video formats unless a specific one is
  84. requested
  85. --max-quality FORMAT highest quality format to download
  86. -F, --list-formats list all available formats (currently youtube only)
  87. --write-srt write video closed captions to a .srt file
  88. (currently youtube only)
  89. --srt-lang LANG language of the closed captions to download
  90. (optional) use IETF language tags like 'en'
  91. ## Authentication Options:
  92. -u, --username USERNAME account username
  93. -p, --password PASSWORD account password
  94. -n, --netrc use .netrc authentication data
  95. ## Post-processing Options:
  96. -x, --extract-audio convert video files to audio-only files (requires
  97. ffmpeg or avconv and ffprobe or avprobe)
  98. --audio-format FORMAT "best", "aac", "vorbis", "mp3", "m4a", "opus", or
  99. "wav"; best by default
  100. --audio-quality QUALITY ffmpeg/avconv audio quality specification, insert a
  101. value between 0 (better) and 9 (worse) for VBR or a
  102. specific bitrate like 128K (default 5)
  103. --recode-video FORMAT Encode the video to another format if necessary
  104. (currently supported: mp4|flv|ogg|webm)
  105. -k, --keep-video keeps the video file on disk after the post-
  106. processing; the video is erased by default
  107. --no-post-overwrites do not overwrite post-processed files; the post-
  108. processed files are overwritten by default
  109. # CONFIGURATION
  110. 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`.
  111. # OUTPUT TEMPLATE
  112. 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:
  113. - `id`: The sequence will be replaced by the video identifier.
  114. - `url`: The sequence will be replaced by the video URL.
  115. - `uploader`: The sequence will be replaced by the nickname of the person who uploaded the video.
  116. - `upload_date`: The sequence will be replaced by the upload date in YYYYMMDD format.
  117. - `title`: The sequence will be replaced by the video title.
  118. - `ext`: The sequence will be replaced by the appropriate extension (like flv or mp4).
  119. - `epoch`: The sequence will be replaced by the Unix epoch when creating the file.
  120. - `autonumber`: The sequence will be replaced by a five-digit number that will be increased with each download, starting at zero.
  121. 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).
  122. 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:
  123. $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc
  124. youtube-dl test video ''_ä↭𝕐.mp4 # All kinds of weird characters
  125. $ youtube-dl --get-filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
  126. youtube-dl_test_video_.mp4 # A simple file name
  127. # FAQ
  128. ### Can you please put the -b option back?
  129. 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.
  130. ### I get HTTP error 402 when trying to download a video. What's this?
  131. 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.
  132. ### I have downloaded a video but how can I play it?
  133. Once the video is fully downloaded, use any video player, such as [vlc](http://www.videolan.org) or [mplayer](http://www.mplayerhq.hu/).
  134. ### The links provided by youtube-dl -g are not working anymore
  135. 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.
  136. ### ERROR: no fmt_url_map or conn information found in video info
  137. 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`.
  138. ### ERROR: unable to download video ###
  139. 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`.
  140. ### SyntaxError: Non-ASCII character ###
  141. The error
  142. File "youtube-dl", line 2
  143. SyntaxError: Non-ASCII character '\x93' ...
  144. means you're using an outdated version of Python. Please update to Python 2.6 or 2.7.
  145. ### What is this binary file? Where has the code gone?
  146. 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`.
  147. ### The exe throws a *Runtime error from Visual C++*
  148. 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).
  149. # COPYRIGHT
  150. youtube-dl is released into the public domain by the copyright holders.
  151. This README file was originally written by Daniel Bolton (<https://github.com/dbbolton>) and is likewise released into the public domain.
  152. # BUGS
  153. Bugs and suggestions should be reported at: <https://github.com/rg3/youtube-dl/issues>
  154. Please include:
  155. * 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.
  156. * If possible re-run the command with `--verbose`, and include the full output, it is really helpful to us.
  157. * The output of `youtube-dl --version`
  158. * The output of `python --version`
  159. * The name and version of your Operating System ("Ubuntu 11.04 x64" or "Windows 7 x64" is usually enough).
  160. For discussions, join us in the irc channel #youtube-dl on freenode.