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.

225 lines
9.8 KiB

  1. .TH youtube-dl 1 ""
  2. .SH NAME
  3. .PP
  4. youtube-dl
  5. .SH SYNOPSIS
  6. .PP
  7. \f[B]youtube-dl\f[] [OPTIONS] URL [URL...]
  8. .SH DESCRIPTION
  9. .PP
  10. \f[B]youtube-dl\f[] is a small command-line program to download videos
  11. from YouTube.com and a few more sites.
  12. It requires the Python interpreter, version 2.x (x being at least 6),
  13. and it is not platform specific.
  14. It should work in your Unix box, in Windows or in Mac OS X.
  15. It is released to the public domain, which means you can modify it,
  16. redistribute it or use it however you like.
  17. .SH OPTIONS
  18. .IP
  19. .nf
  20. \f[C]
  21. -h,\ --help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ print\ this\ help\ text\ and\ exit
  22. --version\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ print\ program\ version\ and\ exit
  23. -U,\ --update\ \ \ \ \ \ \ \ \ \ \ \ \ update\ this\ program\ to\ latest\ version
  24. -i,\ --ignore-errors\ \ \ \ \ \ continue\ on\ download\ errors
  25. -r,\ --rate-limit\ LIMIT\ \ \ download\ rate\ limit\ (e.g.\ 50k\ or\ 44.6m)
  26. -R,\ --retries\ RETRIES\ \ \ \ number\ of\ retries\ (default\ is\ 10)
  27. --dump-user-agent\ \ \ \ \ \ \ \ display\ the\ current\ browser\ identification
  28. --user-agent\ UA\ \ \ \ \ \ \ \ \ \ specify\ a\ custom\ user\ agent
  29. --list-extractors\ \ \ \ \ \ \ \ List\ all\ supported\ extractors\ and\ the\ URLs\ they
  30. \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ would\ handle
  31. \f[]
  32. .fi
  33. .SS Video Selection:
  34. .IP
  35. .nf
  36. \f[C]
  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. \f[]
  45. .fi
  46. .SS Filesystem Options:
  47. .IP
  48. .nf
  49. \f[C]
  50. -t,\ --title\ \ \ \ \ \ \ \ \ \ \ \ \ \ use\ title\ in\ file\ name
  51. -l,\ --literal\ \ \ \ \ \ \ \ \ \ \ \ use\ literal\ title\ in\ file\ name
  52. -A,\ --auto-number\ \ \ \ \ \ \ \ number\ downloaded\ files\ starting\ from\ 00000
  53. -o,\ --output\ TEMPLATE\ \ \ \ output\ filename\ template.\ Use\ %(stitle)s\ to\ get\ the
  54. \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ title,\ %(uploader)s\ for\ the\ uploader\ name,
  55. \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ %(autonumber)s\ to\ get\ an\ automatically\ incremented
  56. \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ number,\ %(ext)s\ for\ the\ filename\ extension,
  57. \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ %(upload_date)s\ for\ the\ upload\ date\ (YYYYMMDD),\ and
  58. \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ %%\ for\ a\ literal\ percent.\ Use\ -\ to\ output\ to
  59. \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ stdout.
  60. -a,\ --batch-file\ FILE\ \ \ \ file\ containing\ URLs\ to\ download\ (\[aq]-\[aq]\ for\ stdin)
  61. -w,\ --no-overwrites\ \ \ \ \ \ do\ not\ overwrite\ files
  62. -c,\ --continue\ \ \ \ \ \ \ \ \ \ \ resume\ partially\ downloaded\ files
  63. --no-continue\ \ \ \ \ \ \ \ \ \ \ \ do\ not\ resume\ partially\ downloaded\ files\ (restart
  64. \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ from\ beginning)
  65. --cookies\ FILE\ \ \ \ \ \ \ \ \ \ \ file\ to\ read\ cookies\ from\ and\ dump\ cookie\ jar\ in
  66. --no-part\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ do\ not\ use\ .part\ files
  67. --no-mtime\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ do\ not\ use\ the\ Last-modified\ header\ to\ set\ the\ file
  68. \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ modification\ time
  69. --write-description\ \ \ \ \ \ write\ video\ description\ to\ a\ .description\ file
  70. --write-info-json\ \ \ \ \ \ \ \ write\ video\ metadata\ to\ a\ .info.json\ file
  71. \f[]
  72. .fi
  73. .SS Verbosity / Simulation Options:
  74. .IP
  75. .nf
  76. \f[C]
  77. -q,\ --quiet\ \ \ \ \ \ \ \ \ \ \ \ \ \ activates\ quiet\ mode
  78. -s,\ --simulate\ \ \ \ \ \ \ \ \ \ \ do\ not\ download\ the\ video\ and\ do\ not\ write\ anything
  79. \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ to\ disk
  80. --skip-download\ \ \ \ \ \ \ \ \ \ do\ not\ download\ the\ video
  81. -g,\ --get-url\ \ \ \ \ \ \ \ \ \ \ \ simulate,\ quiet\ but\ print\ URL
  82. -e,\ --get-title\ \ \ \ \ \ \ \ \ \ simulate,\ quiet\ but\ print\ title
  83. --get-thumbnail\ \ \ \ \ \ \ \ \ \ simulate,\ quiet\ but\ print\ thumbnail\ URL
  84. --get-description\ \ \ \ \ \ \ \ simulate,\ quiet\ but\ print\ video\ description
  85. --get-filename\ \ \ \ \ \ \ \ \ \ \ simulate,\ quiet\ but\ print\ output\ filename
  86. --get-format\ \ \ \ \ \ \ \ \ \ \ \ \ simulate,\ quiet\ but\ print\ output\ format
  87. --no-progress\ \ \ \ \ \ \ \ \ \ \ \ do\ not\ print\ progress\ bar
  88. --console-title\ \ \ \ \ \ \ \ \ \ display\ progress\ in\ console\ titlebar
  89. -v,\ --verbose\ \ \ \ \ \ \ \ \ \ \ \ print\ various\ debugging\ information
  90. \f[]
  91. .fi
  92. .SS Video Format Options:
  93. .IP
  94. .nf
  95. \f[C]
  96. -f,\ --format\ FORMAT\ \ \ \ \ \ video\ format\ code
  97. --all-formats\ \ \ \ \ \ \ \ \ \ \ \ download\ all\ available\ video\ formats
  98. --prefer-free-formats\ \ \ \ prefer\ free\ video\ formats\ unless\ a\ specific\ one\ is
  99. \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ requested
  100. --max-quality\ FORMAT\ \ \ \ \ highest\ quality\ format\ to\ download
  101. -F,\ --list-formats\ \ \ \ \ \ \ list\ all\ available\ formats\ (currently\ youtube\ only)
  102. --write-srt\ \ \ \ \ \ \ \ \ \ \ \ \ \ write\ video\ closed\ captions\ to\ a\ .srt\ file
  103. \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ (currently\ youtube\ only)
  104. --srt-lang\ LANG\ \ \ \ \ \ \ \ \ \ language\ of\ the\ closed\ captions\ to\ download
  105. \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ (optional)\ use\ IETF\ language\ tags\ like\ \[aq]en\[aq]
  106. \f[]
  107. .fi
  108. .SS Authentication Options:
  109. .IP
  110. .nf
  111. \f[C]
  112. -u,\ --username\ USERNAME\ \ account\ username
  113. -p,\ --password\ PASSWORD\ \ account\ password
  114. -n,\ --netrc\ \ \ \ \ \ \ \ \ \ \ \ \ \ use\ .netrc\ authentication\ data
  115. \f[]
  116. .fi
  117. .SS Post-processing Options:
  118. .IP
  119. .nf
  120. \f[C]
  121. --extract-audio\ \ \ \ \ \ \ \ \ \ convert\ video\ files\ to\ audio-only\ files\ (requires
  122. \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ ffmpeg\ or\ avconv\ and\ ffprobe\ or\ avprobe)
  123. --audio-format\ FORMAT\ \ \ \ "best",\ "aac",\ "vorbis",\ "mp3",\ "m4a",\ or\ "wav";
  124. \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ best\ by\ default
  125. --audio-quality\ QUALITY\ \ ffmpeg/avconv\ audio\ quality\ specification,\ insert\ a
  126. \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ value\ between\ 0\ (better)\ and\ 9\ (worse)\ for\ VBR\ or\ a
  127. \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ specific\ bitrate\ like\ 128K\ (default\ 5)
  128. -k,\ --keep-video\ \ \ \ \ \ \ \ \ keeps\ the\ video\ file\ on\ disk\ after\ the\ post-
  129. \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ processing;\ the\ video\ is\ erased\ by\ default
  130. \f[]
  131. .fi
  132. .SH FAQ
  133. .SS Can you please put the -b option back?
  134. .PP
  135. Most people asking this question are not aware that youtube-dl now
  136. defaults to downloading the highest available quality as reported by
  137. YouTube, which will be 1080p or 720p in some cases, so you no longer
  138. need the -b option.
  139. For some specific videos, maybe YouTube does not report them to be
  140. available in a specific high quality format you\[aq]\[aq]re interested
  141. in.
  142. In that case, simply request it with the -f option and youtube-dl will
  143. try to download it.
  144. .SS I get HTTP error 402 when trying to download a video. What\[aq]s
  145. this?
  146. .PP
  147. Apparently YouTube requires you to pass a CAPTCHA test if you download
  148. too much.
  149. We\[aq]\[aq]re considering to provide a way to let you solve the
  150. CAPTCHA (https://github.com/rg3/youtube-dl/issues/154), but at the
  151. moment, your best course of action is pointing a webbrowser to the
  152. youtube URL, solving the CAPTCHA, and restart youtube-dl.
  153. .SS I have downloaded a video but how can I play it?
  154. .PP
  155. Once the video is fully downloaded, use any video player, such as
  156. vlc (http://www.videolan.org) or mplayer (http://www.mplayerhq.hu/).
  157. .SS The links provided by youtube-dl -g are not working anymore
  158. .PP
  159. The URLs youtube-dl outputs require the downloader to have the correct
  160. cookies.
  161. Use the \f[C]--cookies\f[] option to write the required cookies into a
  162. file, and advise your downloader to read cookies from that file.
  163. Some sites also require a common user agent to be used, use
  164. \f[C]--dump-user-agent\f[] to see the one in use by youtube-dl.
  165. .SS ERROR: no fmt_url_map or conn information found in video info
  166. .PP
  167. youtube has switched to a new video info format in July 2011 which is
  168. not supported by old versions of youtube-dl.
  169. You can update youtube-dl with \f[C]sudo\ youtube-dl\ --update\f[].
  170. .SS ERROR: unable to download video
  171. .PP
  172. youtube requires an additional signature since September 2012 which is
  173. not supported by old versions of youtube-dl.
  174. You can update youtube-dl with \f[C]sudo\ youtube-dl\ --update\f[].
  175. .SS SyntaxError:Non-ASCII character
  176. .PP
  177. The error
  178. .IP
  179. .nf
  180. \f[C]
  181. File\ "youtube-dl",\ line\ 2
  182. SyntaxError:\ Non-ASCII\ character\ \[aq]\\x93\[aq]\ ...
  183. \f[]
  184. .fi
  185. .PP
  186. means you\[aq]re using an outdated version of Python.
  187. Please update to Python 2.6 or 2.7.
  188. .PP
  189. To run youtube-dl under Python 2.5, you\[aq]ll have to manually check it
  190. out like this:
  191. .IP
  192. .nf
  193. \f[C]
  194. git\ clone\ git://github.com/rg3/youtube-dl.git
  195. cd\ youtube-dl
  196. python\ -m\ youtube-dl\ --help
  197. \f[]
  198. .fi
  199. .PP
  200. Please note that Python 2.5 is not supported anymore.
  201. .SH COPYRIGHT
  202. .PP
  203. youtube-dl is released into the public domain by the copyright holders.
  204. .PP
  205. This README file was originally written by Daniel Bolton
  206. (<https://github.com/dbbolton>) and is likewise released into the public
  207. domain.
  208. .SH BUGS
  209. .PP
  210. Bugs and suggestions should be reported at:
  211. <https://github.com/rg3/youtube-dl/issues>
  212. .PP
  213. Please include:
  214. .IP \[bu] 2
  215. Your exact command line, like
  216. \f[C]youtube-dl\ -t\ "http://www.youtube.com/watch?v=uHlDtZ6Oc3s&feature=channel_video_title"\f[].
  217. A common mistake is not to escape the \f[C]&\f[].
  218. Putting URLs in quotes should solve this problem.
  219. .IP \[bu] 2
  220. The output of \f[C]youtube-dl\ --version\f[]
  221. .IP \[bu] 2
  222. The output of \f[C]python\ --version\f[]
  223. .IP \[bu] 2
  224. The name and version of your Operating System ("Ubuntu 11.04 x64" or
  225. "Windows 7 x64" is usually enough).