diff options
Diffstat (limited to 'network/youtube-dl/youtube-dl.1')
| -rw-r--r-- | network/youtube-dl/youtube-dl.1 | 1091 |
1 files changed, 831 insertions, 260 deletions
diff --git a/network/youtube-dl/youtube-dl.1 b/network/youtube-dl/youtube-dl.1 index a55d2ccb26..853a8dda3e 100644 --- a/network/youtube-dl/youtube-dl.1 +++ b/network/youtube-dl/youtube-dl.1 @@ -15,254 +15,823 @@ It should work on your Unix box, on Windows or on Mac OS X. It is released to the public domain, which means you can modify it, redistribute it or use it however you like. .SH OPTIONS -.IP -.nf -\f[C] -\-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Print\ this\ help\ text\ and\ exit -\-\-version\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Print\ program\ version\ and\ exit -\-U,\ \-\-update\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Update\ this\ program\ to\ latest\ version.\ Make\ sure\ that\ you\ have\ sufficient\ permissions\ (run\ with\ sudo\ if\ needed) -\-i,\ \-\-ignore\-errors\ \ \ \ \ \ \ \ \ \ \ \ \ \ Continue\ on\ download\ errors,\ for\ example\ to\ skip\ unavailable\ videos\ in\ a\ playlist -\-\-abort\-on\-error\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Abort\ downloading\ of\ further\ videos\ (in\ the\ playlist\ or\ the\ command\ line)\ if\ an\ error\ occurs -\-\-dump\-user\-agent\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Display\ the\ current\ browser\ identification -\-\-list\-extractors\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ List\ all\ supported\ extractors -\-\-extractor\-descriptions\ \ \ \ \ \ \ \ \ Output\ descriptions\ of\ all\ supported\ extractors -\-\-force\-generic\-extractor\ \ \ \ \ \ \ \ Force\ extraction\ to\ use\ the\ generic\ extractor -\-\-default\-search\ PREFIX\ \ \ \ \ \ \ \ \ \ Use\ this\ prefix\ for\ unqualified\ URLs.\ For\ example\ "gvsearch2:"\ downloads\ two\ videos\ from\ google\ videos\ for\ youtube\-dl\ "large\ apple". -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Use\ the\ value\ "auto"\ to\ let\ youtube\-dl\ guess\ ("auto_warning"\ to\ emit\ a\ warning\ when\ guessing).\ "error"\ just\ throws\ an\ error.\ The -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ default\ value\ "fixup_error"\ repairs\ broken\ URLs,\ but\ emits\ an\ error\ if\ this\ is\ not\ possible\ instead\ of\ searching. -\-\-ignore\-config\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Do\ not\ read\ configuration\ files.\ When\ given\ in\ the\ global\ configuration\ file\ /etc/youtube\-dl.conf:\ Do\ not\ read\ the\ user\ configuration -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ in\ ~/.config/youtube\-dl/config\ (%APPDATA%/youtube\-dl/config.txt\ on\ Windows) -\-\-flat\-playlist\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Do\ not\ extract\ the\ videos\ of\ a\ playlist,\ only\ list\ them. -\-\-no\-color\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Do\ not\ emit\ color\ codes\ in\ output -\f[] -.fi +.TP +.B \-h, \-\-help +Print this help text and exit +.RS +.RE +.TP +.B \-\-version +Print program version and exit +.RS +.RE +.TP +.B \-U, \-\-update +Update this program to latest version. +Make sure that you have sufficient permissions (run with sudo if needed) +.RS +.RE +.TP +.B \-i, \-\-ignore\-errors +Continue on download errors, for example to skip unavailable videos in a +playlist +.RS +.RE +.TP +.B \-\-abort\-on\-error +Abort downloading of further videos (in the playlist or the command +line) if an error occurs +.RS +.RE +.TP +.B \-\-dump\-user\-agent +Display the current browser identification +.RS +.RE +.TP +.B \-\-list\-extractors +List all supported extractors +.RS +.RE +.TP +.B \-\-extractor\-descriptions +Output descriptions of all supported extractors +.RS +.RE +.TP +.B \-\-force\-generic\-extractor +Force extraction to use the generic extractor +.RS +.RE +.TP +.B \-\-default\-search \f[I]PREFIX\f[] +Use this prefix for unqualified URLs. +For example "gvsearch2:" downloads two videos from google videos for +youtube\-dl "large apple". +Use the value "auto" to let youtube\-dl guess ("auto_warning" to emit a +warning when guessing). +"error" just throws an error. +The default value "fixup_error" repairs broken URLs, but emits an error +if this is not possible instead of searching. +.RS +.RE +.TP +.B \-\-ignore\-config +Do not read configuration files. +When given in the global configuration file /etc /youtube\-dl.conf: Do +not read the user configuration in ~/.config/youtube\- dl/config +(%APPDATA%/youtube\-dl/config.txt on Windows) +.RS +.RE +.TP +.B \-\-flat\-playlist +Do not extract the videos of a playlist, only list them. +.RS +.RE +.TP +.B \-\-no\-color +Do not emit color codes in output +.RS +.RE .SS Network Options: -.IP -.nf -\f[C] -\-\-proxy\ URL\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Use\ the\ specified\ HTTP/HTTPS\ proxy.\ Pass\ in\ an\ empty\ string\ (\-\-proxy\ "")\ for\ direct\ connection -\-\-socket\-timeout\ SECONDS\ \ \ \ \ \ \ \ \ Time\ to\ wait\ before\ giving\ up,\ in\ seconds -\-\-source\-address\ IP\ \ \ \ \ \ \ \ \ \ \ \ \ \ Client\-side\ IP\ address\ to\ bind\ to\ (experimental) -\-4,\ \-\-force\-ipv4\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Make\ all\ connections\ via\ IPv4\ (experimental) -\-6,\ \-\-force\-ipv6\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Make\ all\ connections\ via\ IPv6\ (experimental) -\-\-cn\-verification\-proxy\ URL\ \ \ \ \ \ Use\ this\ proxy\ to\ verify\ the\ IP\ address\ for\ some\ Chinese\ sites.\ The\ default\ proxy\ specified\ by\ \-\-proxy\ (or\ none,\ if\ the\ options\ is -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ not\ present)\ is\ used\ for\ the\ actual\ downloading.\ (experimental) -\f[] -.fi +.TP +.B \-\-proxy \f[I]URL\f[] +Use the specified HTTP/HTTPS proxy. +Pass in an empty string (\-\-proxy "") for direct connection +.RS +.RE +.TP +.B \-\-socket\-timeout \f[I]SECONDS\f[] +Time to wait before giving up, in seconds +.RS +.RE +.TP +.B \-\-source\-address \f[I]IP\f[] +Client\-side IP address to bind to (experimental) +.RS +.RE +.TP +.B \-4, \-\-force\-ipv4 +Make all connections via IPv4 (experimental) +.RS +.RE +.TP +.B \-6, \-\-force\-ipv6 +Make all connections via IPv6 (experimental) +.RS +.RE +.TP +.B \-\-cn\-verification\-proxy \f[I]URL\f[] +Use this proxy to verify the IP address for some Chinese sites. +The default proxy specified by \-\-proxy (or none, if the options is not +present) is used for the actual downloading. +(experimental) +.RS +.RE .SS Video Selection: -.IP -.nf -\f[C] -\-\-playlist\-start\ NUMBER\ \ \ \ \ \ \ \ \ \ Playlist\ video\ to\ start\ at\ (default\ is\ 1) -\-\-playlist\-end\ NUMBER\ \ \ \ \ \ \ \ \ \ \ \ Playlist\ video\ to\ end\ at\ (default\ is\ last) -\-\-playlist\-items\ ITEM_SPEC\ \ \ \ \ \ \ Playlist\ video\ items\ to\ download.\ Specify\ indices\ of\ the\ videos\ in\ the\ playlist\ separated\ by\ commas\ like:\ "\-\-playlist\-items\ 1,2,5,8" -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ if\ you\ want\ to\ download\ videos\ indexed\ 1,\ 2,\ 5,\ 8\ in\ the\ playlist.\ You\ can\ specify\ range:\ "\-\-playlist\-items\ 1\-3,7,10\-13",\ it\ will -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ download\ the\ videos\ at\ index\ 1,\ 2,\ 3,\ 7,\ 10,\ 11,\ 12\ and\ 13. -\-\-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) -\-\-max\-downloads\ NUMBER\ \ \ \ \ \ \ \ \ \ \ Abort\ after\ downloading\ NUMBER\ files -\-\-min\-filesize\ SIZE\ \ \ \ \ \ \ \ \ \ \ \ \ \ Do\ not\ download\ any\ videos\ smaller\ than\ SIZE\ (e.g.\ 50k\ or\ 44.6m) -\-\-max\-filesize\ SIZE\ \ \ \ \ \ \ \ \ \ \ \ \ \ Do\ not\ download\ any\ videos\ larger\ than\ SIZE\ (e.g.\ 50k\ or\ 44.6m) -\-\-date\ DATE\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Download\ only\ videos\ uploaded\ in\ this\ date -\-\-datebefore\ DATE\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Download\ only\ videos\ uploaded\ on\ or\ before\ this\ date\ (i.e.\ inclusive) -\-\-dateafter\ DATE\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Download\ only\ videos\ uploaded\ on\ or\ after\ this\ date\ (i.e.\ inclusive) -\-\-min\-views\ COUNT\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Do\ not\ download\ any\ videos\ with\ less\ than\ COUNT\ views -\-\-max\-views\ COUNT\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Do\ not\ download\ any\ videos\ with\ more\ than\ COUNT\ views -\-\-match\-filter\ FILTER\ \ \ \ \ \ \ \ \ \ \ \ Generic\ video\ filter\ (experimental).\ Specify\ any\ key\ (see\ help\ for\ \-o\ for\ a\ list\ of\ available\ keys)\ to\ match\ if\ the\ key\ is\ present, -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ !key\ to\ check\ if\ the\ key\ is\ not\ present,key\ >\ NUMBER\ (like\ "comment_count\ >\ 12",\ also\ works\ with\ >=,\ <,\ <=,\ !=,\ =)\ to\ compare\ against -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ a\ number,\ and\ &\ to\ require\ multiple\ matches.\ Values\ which\ are\ not\ known\ are\ excluded\ unless\ you\ put\ a\ question\ mark\ (?)\ after\ the -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ operator.For\ example,\ to\ only\ match\ videos\ that\ have\ been\ liked\ more\ than\ 100\ times\ and\ disliked\ less\ than\ 50\ times\ (or\ the\ dislike -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ functionality\ is\ not\ available\ at\ the\ given\ service),\ but\ who\ also\ have\ a\ description,\ use\ \ \-\-match\-filter\ "like_count\ >\ 100\ & -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ dislike_count\ <?\ 50\ &\ description"\ . -\-\-no\-playlist\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Download\ only\ the\ video,\ if\ the\ URL\ refers\ to\ a\ video\ and\ a\ playlist. -\-\-yes\-playlist\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Download\ the\ playlist,\ if\ the\ URL\ refers\ to\ a\ video\ and\ a\ playlist. -\-\-age\-limit\ YEARS\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Download\ only\ videos\ suitable\ for\ the\ given\ age -\-\-download\-archive\ FILE\ \ \ \ \ \ \ \ \ \ Download\ only\ videos\ not\ listed\ in\ the\ archive\ file.\ Record\ the\ IDs\ of\ all\ downloaded\ videos\ in\ it. -\-\-include\-ads\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Download\ advertisements\ as\ well\ (experimental) -\f[] -.fi +.TP +.B \-\-playlist\-start \f[I]NUMBER\f[] +Playlist video to start at (default is 1) +.RS +.RE +.TP +.B \-\-playlist\-end \f[I]NUMBER\f[] +Playlist video to end at (default is last) +.RS +.RE +.TP +.B \-\-playlist\-items \f[I]ITEM_SPEC\f[] +Playlist video items to download. +Specify indices of the videos in the playlist separated by commas like: +"\-\-playlist\-items 1,2,5,8" if you want to download videos indexed 1, +2, 5, 8 in the playlist. +You can specify range: "\-\-playlist\-items 1\-3,7,10\-13", it will +download the videos at index 1, 2, 3, 7, 10, 11, 12 and 13. +.RS +.RE +.TP +.B \-\-match\-title \f[I]REGEX\f[] +Download only matching titles (regex or caseless sub\-string) +.RS +.RE +.TP +.B \-\-reject\-title \f[I]REGEX\f[] +Skip download for matching titles (regex or caseless sub\-string) +.RS +.RE +.TP +.B \-\-max\-downloads \f[I]NUMBER\f[] +Abort after downloading NUMBER files +.RS +.RE +.TP +.B \-\-min\-filesize \f[I]SIZE\f[] +Do not download any videos smaller than SIZE (e.g. +50k or 44.6m) +.RS +.RE +.TP +.B \-\-max\-filesize \f[I]SIZE\f[] +Do not download any videos larger than SIZE (e.g. +50k or 44.6m) +.RS +.RE +.TP +.B \-\-date \f[I]DATE\f[] +Download only videos uploaded in this date +.RS +.RE +.TP +.B \-\-datebefore \f[I]DATE\f[] +Download only videos uploaded on or before this date (i.e. +inclusive) +.RS +.RE +.TP +.B \-\-dateafter \f[I]DATE\f[] +Download only videos uploaded on or after this date (i.e. +inclusive) +.RS +.RE +.TP +.B \-\-min\-views \f[I]COUNT\f[] +Do not download any videos with less than COUNT views +.RS +.RE +.TP +.B \-\-max\-views \f[I]COUNT\f[] +Do not download any videos with more than COUNT views +.RS +.RE +.TP +.B \-\-match\-filter \f[I]FILTER\f[] +Generic video filter (experimental). +Specify any key (see help for \-o for a list of available keys) to match +if the key is present, !key to check if the key is not present,key > +NUMBER (like "comment_count > 12", also works with >=, <, <=, !=, =) to +compare against a number, and & to require multiple matches. +Values which are not known are excluded unless you put a question mark +(?) after the operator.For example, to only match videos that have been +liked more than 100 times and disliked less than 50 times (or the +dislike functionality is not available at the given service), but who +also have a description, use \-\-match\-filter "like_count > 100 & +dislike_count <? +50 & description" . +.RS +.RE +.TP +.B \-\-no\-playlist +Download only the video, if the URL refers to a video and a playlist. +.RS +.RE +.TP +.B \-\-yes\-playlist +Download the playlist, if the URL refers to a video and a playlist. +.RS +.RE +.TP +.B \-\-age\-limit \f[I]YEARS\f[] +Download only videos suitable for the given age +.RS +.RE +.TP +.B \-\-download\-archive \f[I]FILE\f[] +Download only videos not listed in the archive file. +Record the IDs of all downloaded videos in it. +.RS +.RE +.TP +.B \-\-include\-ads +Download advertisements as well (experimental) +.RS +.RE .SS Download Options: -.IP -.nf -\f[C] -\-r,\ \-\-rate\-limit\ LIMIT\ \ \ \ \ \ \ \ \ \ \ Maximum\ download\ rate\ in\ bytes\ per\ second\ (e.g.\ 50K\ or\ 4.2M) -\-R,\ \-\-retries\ RETRIES\ \ \ \ \ \ \ \ \ \ \ \ Number\ of\ retries\ (default\ is\ 10),\ or\ "infinite". -\-\-buffer\-size\ SIZE\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Size\ of\ download\ buffer\ (e.g.\ 1024\ or\ 16K)\ (default\ is\ 1024) -\-\-no\-resize\-buffer\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Do\ not\ automatically\ adjust\ the\ buffer\ size.\ By\ default,\ the\ buffer\ size\ is\ automatically\ resized\ from\ an\ initial\ value\ of\ SIZE. -\-\-playlist\-reverse\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Download\ playlist\ videos\ in\ reverse\ order -\-\-xattr\-set\-filesize\ \ \ \ \ \ \ \ \ \ \ \ \ Set\ file\ xattribute\ ytdl.filesize\ with\ expected\ filesize\ (experimental) -\-\-hls\-prefer\-native\ \ \ \ \ \ \ \ \ \ \ \ \ \ Use\ the\ native\ HLS\ downloader\ instead\ of\ ffmpeg\ (experimental) -\-\-external\-downloader\ COMMAND\ \ \ \ Use\ the\ specified\ external\ downloader.\ Currently\ supports\ aria2c,axel,curl,httpie,wget -\-\-external\-downloader\-args\ ARGS\ \ Give\ these\ arguments\ to\ the\ external\ downloader -\f[] -.fi +.TP +.B \-r, \-\-rate\-limit \f[I]LIMIT\f[] +Maximum download rate in bytes per second (e.g. +50K or 4.2M) +.RS +.RE +.TP +.B \-R, \-\-retries \f[I]RETRIES\f[] +Number of retries (default is 10), or "infinite". +.RS +.RE +.TP +.B \-\-buffer\-size \f[I]SIZE\f[] +Size of download buffer (e.g. +1024 or 16K) (default is 1024) +.RS +.RE +.TP +.B \-\-no\-resize\-buffer +Do not automatically adjust the buffer size. +By default, the buffer size is automatically resized from an initial +value of SIZE. +.RS +.RE +.TP +.B \-\-playlist\-reverse +Download playlist videos in reverse order +.RS +.RE +.TP +.B \-\-xattr\-set\-filesize +Set file xattribute ytdl.filesize with expected filesize (experimental) +.RS +.RE +.TP +.B \-\-hls\-prefer\-native +Use the native HLS downloader instead of ffmpeg (experimental) +.RS +.RE +.TP +.B \-\-external\-downloader \f[I]COMMAND\f[] +Use the specified external downloader. +Currently supports aria2c,axel,curl,httpie,wget +.RS +.RE +.TP +.B \-\-external\-downloader\-args \f[I]ARGS\f[] +Give these arguments to the external downloader +.RS +.RE .SS Filesystem Options: -.IP -.nf -\f[C] -\-a,\ \-\-batch\-file\ FILE\ \ \ \ \ \ \ \ \ \ \ \ File\ containing\ URLs\ to\ download\ (\[aq]\-\[aq]\ for\ stdin) -\-\-id\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Use\ only\ video\ ID\ in\ file\ name -\-o,\ \-\-output\ TEMPLATE\ \ \ \ \ \ \ \ \ \ \ \ Output\ filename\ template.\ Use\ %(title)s\ to\ get\ the\ title,\ %(uploader)s\ for\ the\ uploader\ name,\ %(uploader_id)s\ for\ the\ uploader -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ nickname\ if\ different,\ %(autonumber)s\ to\ get\ an\ automatically\ incremented\ number,\ %(ext)s\ for\ the\ filename\ extension,\ %(format)s\ for -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ the\ format\ description\ (like\ "22\ \-\ 1280x720"\ or\ "HD"),\ %(format_id)s\ for\ the\ unique\ id\ of\ the\ format\ (like\ YouTube\[aq]s\ itags:\ "137"), -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ %(upload_date)s\ for\ the\ upload\ date\ (YYYYMMDD),\ %(extractor)s\ for\ the\ provider\ (youtube,\ metacafe,\ etc),\ %(id)s\ for\ the\ video\ id, -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ %(playlist_title)s,\ %(playlist_id)s,\ or\ %(playlist)s\ (=title\ if\ present,\ ID\ otherwise)\ for\ the\ playlist\ the\ video\ is\ in, -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ %(playlist_index)s\ for\ the\ position\ in\ the\ playlist.\ %(height)s\ and\ %(width)s\ for\ the\ width\ and\ height\ of\ the\ video\ format. -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ %(resolution)s\ for\ a\ textual\ description\ of\ the\ resolution\ of\ the\ video\ format.\ %%\ for\ a\ literal\ percent.\ Use\ \-\ to\ output\ to\ stdout. -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Can\ also\ be\ used\ to\ download\ to\ a\ different\ directory,\ for\ example\ with\ \-o\ \[aq]/my/downloads/%(uploader)s/%(title)s\-%(id)s.%(ext)s\[aq]\ . -\-\-autonumber\-size\ NUMBER\ \ \ \ \ \ \ \ \ Specify\ the\ number\ of\ digits\ in\ %(autonumber)s\ when\ it\ is\ present\ in\ output\ filename\ template\ or\ \-\-auto\-number\ option\ is\ given -\-\-restrict\-filenames\ \ \ \ \ \ \ \ \ \ \ \ \ Restrict\ filenames\ to\ only\ ASCII\ characters,\ and\ avoid\ "&"\ and\ spaces\ in\ filenames -\-A,\ \-\-auto\-number\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [deprecated;\ use\ \ \-o\ "%(autonumber)s\-%(title)s.%(ext)s"\ ]\ Number\ downloaded\ files\ starting\ from\ 00000 -\-t,\ \-\-title\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [deprecated]\ Use\ title\ in\ file\ name\ (default) -\-l,\ \-\-literal\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [deprecated]\ Alias\ of\ \-\-title -\-w,\ \-\-no\-overwrites\ \ \ \ \ \ \ \ \ \ \ \ \ \ Do\ not\ overwrite\ files -\-c,\ \-\-continue\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Force\ resume\ of\ partially\ downloaded\ files.\ By\ default,\ youtube\-dl\ will\ resume\ downloads\ if\ possible. -\-\-no\-continue\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Do\ not\ resume\ partially\ downloaded\ files\ (restart\ from\ beginning) -\-\-no\-part\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Do\ not\ use\ .part\ files\ \-\ write\ directly\ into\ output\ file -\-\-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 -\-\-write\-annotations\ \ \ \ \ \ \ \ \ \ \ \ \ \ Write\ video\ annotations\ to\ a\ .annotations.xml\ file -\-\-load\-info\ FILE\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ JSON\ file\ containing\ the\ video\ information\ (created\ with\ the\ "\-\-write\-info\-json"\ option) -\-\-cookies\ FILE\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ File\ to\ read\ cookies\ from\ and\ dump\ cookie\ jar\ in -\-\-cache\-dir\ DIR\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Location\ in\ the\ filesystem\ where\ youtube\-dl\ can\ store\ some\ downloaded\ information\ permanently.\ By\ default\ $XDG_CACHE_HOME/youtube\-dl -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ or\ ~/.cache/youtube\-dl\ .\ At\ the\ moment,\ only\ YouTube\ player\ files\ (for\ videos\ with\ obfuscated\ signatures)\ are\ cached,\ but\ that\ may -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ change. -\-\-no\-cache\-dir\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Disable\ filesystem\ caching -\-\-rm\-cache\-dir\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Delete\ all\ filesystem\ cache\ files -\f[] -.fi +.TP +.B \-a, \-\-batch\-file \f[I]FILE\f[] +File containing URLs to download (\[aq]\-\[aq] for stdin) +.RS +.RE +.TP +.B \-\-id +Use only video ID in file name +.RS +.RE +.TP +.B \-o, \-\-output \f[I]TEMPLATE\f[] +Output filename template. +Use %(title)s to get the title, %(uploader)s for the uploader name, +%(uploader_id)s for the uploader nickname if different, %(autonumber)s +to get an automatically incremented number, %(ext)s for the filename +extension, %(format)s for the format description (like "22 \- 1280x720" +or "HD"), %(format_id)s for the unique id of the format (like +YouTube\[aq]s itags: "137"), %(upload_date)s for the upload date +(YYYYMMDD), %(extractor)s for the provider (youtube, metacafe, etc), +%(id)s for the video id, %(playlist_title)s, %(playlist_id)s, or +%(playlist)s (=title if present, ID otherwise) for the playlist the +video is in, %(playlist_index)s for the position in the playlist. +%(height)s and %(width)s for the width and height of the video format. +%(resolution)s for a textual description of the resolution of the video +format. +%% for a literal percent. +Use \- to output to stdout. +Can also be used to download to a different directory, for example with +\-o \[aq]/my/downloads/%(uploader)s /%(title)s\-%(id)s.%(ext)s\[aq] . +.RS +.RE +.TP +.B \-\-autonumber\-size \f[I]NUMBER\f[] +Specify the number of digits in %(autonumber)s when it is present in +output filename template or \-\-auto\-number option is given +.RS +.RE +.TP +.B \-\-restrict\-filenames +Restrict filenames to only ASCII characters, and avoid "&" and spaces in +filenames +.RS +.RE +.TP +.B \-A, \-\-auto\-number +[deprecated; use \-o "%(autonumber)s\-%(title)s.%(ext)s" ] Number +downloaded files starting from 00000 +.RS +.RE +.TP +.B \-t, \-\-title +[deprecated] Use title in file name (default) +.RS +.RE +.TP +.B \-l, \-\-literal +[deprecated] Alias of \-\-title +.RS +.RE +.TP +.B \-w, \-\-no\-overwrites +Do not overwrite files +.RS +.RE +.TP +.B \-c, \-\-continue +Force resume of partially downloaded files. +By default, youtube\-dl will resume downloads if possible. +.RS +.RE +.TP +.B \-\-no\-continue +Do not resume partially downloaded files (restart from beginning) +.RS +.RE +.TP +.B \-\-no\-part +Do not use .part files \- write directly into output file +.RS +.RE +.TP +.B \-\-no\-mtime +Do not use the Last\-modified header to set the file modification time +.RS +.RE +.TP +.B \-\-write\-description +Write video description to a .description file +.RS +.RE +.TP +.B \-\-write\-info\-json +Write video metadata to a .info.json file +.RS +.RE +.TP +.B \-\-write\-annotations +Write video annotations to a .annotations.xml file +.RS +.RE +.TP +.B \-\-load\-info \f[I]FILE\f[] +JSON file containing the video information (created with the +"\-\-write\-info\-json" option) +.RS +.RE +.TP +.B \-\-cookies \f[I]FILE\f[] +File to read cookies from and dump cookie jar in +.RS +.RE +.TP +.B \-\-cache\-dir \f[I]DIR\f[] +Location in the filesystem where youtube\-dl can store some downloaded +information permanently. +By default $XDG_CACHE_HOME /youtube\-dl or ~/.cache/youtube\-dl . +At the moment, only YouTube player files (for videos with obfuscated +signatures) are cached, but that may change. +.RS +.RE +.TP +.B \-\-no\-cache\-dir +Disable filesystem caching +.RS +.RE +.TP +.B \-\-rm\-cache\-dir +Delete all filesystem cache files +.RS +.RE .SS Thumbnail images: -.IP -.nf -\f[C] -\-\-write\-thumbnail\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Write\ thumbnail\ image\ to\ disk -\-\-write\-all\-thumbnails\ \ \ \ \ \ \ \ \ \ \ Write\ all\ thumbnail\ image\ formats\ to\ disk -\-\-list\-thumbnails\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Simulate\ and\ list\ all\ available\ thumbnail\ formats -\f[] -.fi +.TP +.B \-\-write\-thumbnail +Write thumbnail image to disk +.RS +.RE +.TP +.B \-\-write\-all\-thumbnails +Write all thumbnail image formats to disk +.RS +.RE +.TP +.B \-\-list\-thumbnails +Simulate and list all available thumbnail formats +.RS +.RE .SS Verbosity / Simulation Options: -.IP -.nf -\f[C] -\-q,\ \-\-quiet\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Activate\ quiet\ mode -\-\-no\-warnings\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Ignore\ warnings -\-s,\ \-\-simulate\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Do\ not\ download\ the\ video\ and\ do\ not\ write\ anything\ to\ disk -\-\-skip\-download\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Do\ not\ download\ the\ video -\-g,\ \-\-get\-url\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Simulate,\ quiet\ but\ print\ URL -\-e,\ \-\-get\-title\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Simulate,\ quiet\ but\ print\ title -\-\-get\-id\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Simulate,\ quiet\ but\ print\ id -\-\-get\-thumbnail\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Simulate,\ quiet\ but\ print\ thumbnail\ URL -\-\-get\-description\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Simulate,\ quiet\ but\ print\ video\ description -\-\-get\-duration\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Simulate,\ quiet\ but\ print\ video\ length -\-\-get\-filename\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Simulate,\ quiet\ but\ print\ output\ filename -\-\-get\-format\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Simulate,\ quiet\ but\ print\ output\ format -\-j,\ \-\-dump\-json\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Simulate,\ quiet\ but\ print\ JSON\ information.\ See\ \-\-output\ for\ a\ description\ of\ available\ keys. -\-J,\ \-\-dump\-single\-json\ \ \ \ \ \ \ \ \ \ \ Simulate,\ quiet\ but\ print\ JSON\ information\ for\ each\ command\-line\ argument.\ If\ the\ URL\ refers\ to\ a\ playlist,\ dump\ the\ whole\ playlist -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ information\ in\ a\ single\ line. -\-\-print\-json\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Be\ quiet\ and\ print\ the\ video\ information\ as\ JSON\ (video\ is\ still\ being\ downloaded). -\-\-newline\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Output\ progress\ bar\ as\ new\ lines -\-\-no\-progress\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Do\ not\ print\ progress\ bar -\-\-console\-title\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Display\ progress\ in\ console\ titlebar -\-v,\ \-\-verbose\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Print\ various\ debugging\ information -\-\-dump\-pages\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Print\ downloaded\ pages\ encoded\ using\ base64\ to\ debug\ problems\ (very\ verbose) -\-\-write\-pages\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Write\ downloaded\ intermediary\ pages\ to\ files\ in\ the\ current\ directory\ to\ debug\ problems -\-\-print\-traffic\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Display\ sent\ and\ read\ HTTP\ traffic -\-C,\ \-\-call\-home\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Contact\ the\ youtube\-dl\ server\ for\ debugging -\-\-no\-call\-home\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Do\ NOT\ contact\ the\ youtube\-dl\ server\ for\ debugging -\f[] -.fi +.TP +.B \-q, \-\-quiet +Activate quiet mode +.RS +.RE +.TP +.B \-\-no\-warnings +Ignore warnings +.RS +.RE +.TP +.B \-s, \-\-simulate +Do not download the video and do not write anything to disk +.RS +.RE +.TP +.B \-\-skip\-download +Do not download the video +.RS +.RE +.TP +.B \-g, \-\-get\-url +Simulate, quiet but print URL +.RS +.RE +.TP +.B \-e, \-\-get\-title +Simulate, quiet but print title +.RS +.RE +.TP +.B \-\-get\-id +Simulate, quiet but print id +.RS +.RE +.TP +.B \-\-get\-thumbnail +Simulate, quiet but print thumbnail URL +.RS +.RE +.TP +.B \-\-get\-description +Simulate, quiet but print video description +.RS +.RE +.TP +.B \-\-get\-duration +Simulate, quiet but print video length +.RS +.RE +.TP +.B \-\-get\-filename +Simulate, quiet but print output filename +.RS +.RE +.TP +.B \-\-get\-format +Simulate, quiet but print output format +.RS +.RE +.TP +.B \-j, \-\-dump\-json +Simulate, quiet but print JSON information. +See \-\-output for a description of available keys. +.RS +.RE +.TP +.B \-J, \-\-dump\-single\-json +Simulate, quiet but print JSON information for each command\-line +argument. +If the URL refers to a playlist, dump the whole playlist information in +a single line. +.RS +.RE +.TP +.B \-\-print\-json +Be quiet and print the video information as JSON (video is still being +downloaded). +.RS +.RE +.TP +.B \-\-newline +Output progress bar as new lines +.RS +.RE +.TP +.B \-\-no\-progress +Do not print progress bar +.RS +.RE +.TP +.B \-\-console\-title +Display progress in console titlebar +.RS +.RE +.TP +.B \-v, \-\-verbose +Print various debugging information +.RS +.RE +.TP +.B \-\-dump\-pages +Print downloaded pages encoded using base64 to debug problems (very +verbose) +.RS +.RE +.TP +.B \-\-write\-pages +Write downloaded intermediary pages to files in the current directory to +debug problems +.RS +.RE +.TP +.B \-\-print\-traffic +Display sent and read HTTP traffic +.RS +.RE +.TP +.B \-C, \-\-call\-home +Contact the youtube\-dl server for debugging +.RS +.RE +.TP +.B \-\-no\-call\-home +Do NOT contact the youtube\-dl server for debugging +.RS +.RE .SS Workarounds: -.IP -.nf -\f[C] -\-\-encoding\ ENCODING\ \ \ \ \ \ \ \ \ \ \ \ \ \ Force\ the\ specified\ encoding\ (experimental) -\-\-no\-check\-certificate\ \ \ \ \ \ \ \ \ \ \ Suppress\ HTTPS\ certificate\ validation -\-\-prefer\-insecure\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Use\ an\ unencrypted\ connection\ to\ retrieve\ information\ about\ the\ video.\ (Currently\ supported\ only\ for\ YouTube) -\-\-user\-agent\ UA\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Specify\ a\ custom\ user\ agent -\-\-referer\ URL\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Specify\ a\ custom\ referer,\ use\ if\ the\ video\ access\ is\ restricted\ to\ one\ domain -\-\-add\-header\ FIELD:VALUE\ \ \ \ \ \ \ \ \ Specify\ a\ custom\ HTTP\ header\ and\ its\ value,\ separated\ by\ a\ colon\ \[aq]:\[aq].\ You\ can\ use\ this\ option\ multiple\ times -\-\-bidi\-workaround\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Work\ around\ terminals\ that\ lack\ bidirectional\ text\ support.\ Requires\ bidiv\ or\ fribidi\ executable\ in\ PATH -\-\-sleep\-interval\ SECONDS\ \ \ \ \ \ \ \ \ Number\ of\ seconds\ to\ sleep\ before\ each\ download. -\f[] -.fi +.TP +.B \-\-encoding \f[I]ENCODING\f[] +Force the specified encoding (experimental) +.RS +.RE +.TP +.B \-\-no\-check\-certificate +Suppress HTTPS certificate validation +.RS +.RE +.TP +.B \-\-prefer\-insecure +Use an unencrypted connection to retrieve information about the video. +(Currently supported only for YouTube) +.RS +.RE +.TP +.B \-\-user\-agent \f[I]UA\f[] +Specify a custom user agent +.RS +.RE +.TP +.B \-\-referer \f[I]URL\f[] +Specify a custom referer, use if the video access is restricted to one +domain +.RS +.RE +.TP +.B \-\-add\-header \f[I]FIELD:VALUE\f[] +Specify a custom HTTP header and its value, separated by a colon +\[aq]:\[aq]. +You can use this option multiple times +.RS +.RE +.TP +.B \-\-bidi\-workaround +Work around terminals that lack bidirectional text support. +Requires bidiv or fribidi executable in PATH +.RS +.RE +.TP +.B \-\-sleep\-interval \f[I]SECONDS\f[] +Number of seconds to sleep before each download. +.RS +.RE .SS Video Format Options: -.IP -.nf -\f[C] -\-f,\ \-\-format\ FORMAT\ \ \ \ \ \ \ \ \ \ \ \ \ \ Video\ format\ code,\ see\ the\ "FORMAT\ SELECTION"\ for\ all\ the\ info -\-\-all\-formats\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Download\ all\ available\ video\ formats -\-\-prefer\-free\-formats\ \ \ \ \ \ \ \ \ \ \ \ Prefer\ free\ video\ formats\ unless\ a\ specific\ one\ is\ requested -\-F,\ \-\-list\-formats\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ List\ all\ available\ formats -\-\-youtube\-skip\-dash\-manifest\ \ \ \ \ Do\ not\ download\ the\ DASH\ manifests\ and\ related\ data\ on\ YouTube\ videos -\-\-merge\-output\-format\ FORMAT\ \ \ \ \ If\ a\ merge\ is\ required\ (e.g.\ bestvideo+bestaudio),\ output\ to\ given\ container\ format.\ One\ of\ mkv,\ mp4,\ ogg,\ webm,\ flv.\ Ignored\ if\ no -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ merge\ is\ required -\f[] -.fi +.TP +.B \-f, \-\-format \f[I]FORMAT\f[] +Video format code, see the "FORMAT SELECTION" for all the info +.RS +.RE +.TP +.B \-\-all\-formats +Download all available video formats +.RS +.RE +.TP +.B \-\-prefer\-free\-formats +Prefer free video formats unless a specific one is requested +.RS +.RE +.TP +.B \-F, \-\-list\-formats +List all available formats +.RS +.RE +.TP +.B \-\-youtube\-skip\-dash\-manifest +Do not download the DASH manifests and related data on YouTube videos +.RS +.RE +.TP +.B \-\-merge\-output\-format \f[I]FORMAT\f[] +If a merge is required (e.g. +bestvideo+bestaudio), output to given container format. +One of mkv, mp4, ogg, webm, flv. +Ignored if no merge is required +.RS +.RE .SS Subtitle Options: -.IP -.nf -\f[C] -\-\-write\-sub\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Write\ subtitle\ file -\-\-write\-auto\-sub\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Write\ automatic\ subtitle\ file\ (YouTube\ only) -\-\-all\-subs\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Download\ all\ the\ available\ subtitles\ of\ the\ video -\-\-list\-subs\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ List\ all\ available\ subtitles\ for\ the\ video -\-\-sub\-format\ FORMAT\ \ \ \ \ \ \ \ \ \ \ \ \ \ Subtitle\ format,\ accepts\ formats\ preference,\ for\ example:\ "srt"\ or\ "ass/srt/best" -\-\-sub\-lang\ LANGS\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Languages\ of\ the\ subtitles\ to\ download\ (optional)\ separated\ by\ commas,\ use\ IETF\ language\ tags\ like\ \[aq]en,pt\[aq] -\f[] -.fi +.TP +.B \-\-write\-sub +Write subtitle file +.RS +.RE +.TP +.B \-\-write\-auto\-sub +Write automatic subtitle file (YouTube only) +.RS +.RE +.TP +.B \-\-all\-subs +Download all the available subtitles of the video +.RS +.RE +.TP +.B \-\-list\-subs +List all available subtitles for the video +.RS +.RE +.TP +.B \-\-sub\-format \f[I]FORMAT\f[] +Subtitle format, accepts formats preference, for example: "srt" or +"ass/srt/best" +.RS +.RE +.TP +.B \-\-sub\-lang \f[I]LANGS\f[] +Languages of the subtitles to download (optional) separated by commas, +use IETF language tags like \[aq]en,pt\[aq] +.RS +.RE .SS Authentication Options: -.IP -.nf -\f[C] -\-u,\ \-\-username\ USERNAME\ \ \ \ \ \ \ \ \ \ Login\ with\ this\ account\ ID -\-p,\ \-\-password\ PASSWORD\ \ \ \ \ \ \ \ \ \ Account\ password.\ If\ this\ option\ is\ left\ out,\ youtube\-dl\ will\ ask\ interactively. -\-2,\ \-\-twofactor\ TWOFACTOR\ \ \ \ \ \ \ \ Two\-factor\ auth\ code -\-n,\ \-\-netrc\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Use\ .netrc\ authentication\ data -\-\-video\-password\ PASSWORD\ \ \ \ \ \ \ \ Video\ password\ (vimeo,\ smotri,\ youku) -\f[] -.fi +.TP +.B \-u, \-\-username \f[I]USERNAME\f[] +Login with this account ID +.RS +.RE +.TP +.B \-p, \-\-password \f[I]PASSWORD\f[] +Account password. +If this option is left out, youtube\-dl will ask interactively. +.RS +.RE +.TP +.B \-2, \-\-twofactor \f[I]TWOFACTOR\f[] +Two\-factor auth code +.RS +.RE +.TP +.B \-n, \-\-netrc +Use .netrc authentication data +.RS +.RE +.TP +.B \-\-video\-password \f[I]PASSWORD\f[] +Video password (vimeo, smotri, youku) +.RS +.RE .SS Post\-processing Options: -.IP -.nf -\f[C] -\-x,\ \-\-extract\-audio\ \ \ \ \ \ \ \ \ \ \ \ \ \ Convert\ video\ files\ to\ audio\-only\ files\ (requires\ ffmpeg\ or\ avconv\ and\ ffprobe\ or\ avprobe) -\-\-audio\-format\ FORMAT\ \ \ \ \ \ \ \ \ \ \ \ Specify\ audio\ format:\ "best",\ "aac",\ "vorbis",\ "mp3",\ "m4a",\ "opus",\ or\ "wav";\ "best"\ by\ default -\-\-audio\-quality\ QUALITY\ \ \ \ \ \ \ \ \ \ Specify\ ffmpeg/avconv\ audio\ quality,\ insert\ a\ value\ between\ 0\ (better)\ and\ 9\ (worse)\ for\ VBR\ or\ a\ specific\ bitrate\ like\ 128K\ (default -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ 5) -\-\-recode\-video\ FORMAT\ \ \ \ \ \ \ \ \ \ \ \ Encode\ the\ video\ to\ another\ format\ if\ necessary\ (currently\ supported:\ mp4|flv|ogg|webm|mkv|avi) -\-\-postprocessor\-args\ ARGS\ \ \ \ \ \ \ \ Give\ these\ arguments\ to\ the\ postprocessor -\-k,\ \-\-keep\-video\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Keep\ the\ video\ file\ on\ disk\ after\ the\ post\-processing;\ the\ video\ is\ erased\ by\ default -\-\-no\-post\-overwrites\ \ \ \ \ \ \ \ \ \ \ \ \ Do\ not\ overwrite\ post\-processed\ files;\ the\ post\-processed\ files\ are\ overwritten\ by\ default -\-\-embed\-subs\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Embed\ subtitles\ in\ the\ video\ (only\ for\ mkv\ and\ mp4\ videos) -\-\-embed\-thumbnail\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Embed\ thumbnail\ in\ the\ audio\ as\ cover\ art -\-\-add\-metadata\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Write\ metadata\ to\ the\ video\ file -\-\-metadata\-from\-title\ FORMAT\ \ \ \ \ Parse\ additional\ metadata\ like\ song\ title\ /\ artist\ from\ the\ video\ title.\ The\ format\ syntax\ is\ the\ same\ as\ \-\-output,\ the\ parsed -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ parameters\ replace\ existing\ values.\ Additional\ templates:\ %(album)s,\ %(artist)s.\ Example:\ \-\-metadata\-from\-title\ "%(artist)s\ \- -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ %(title)s"\ matches\ a\ title\ like\ "Coldplay\ \-\ Paradise" -\-\-xattrs\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Write\ metadata\ to\ the\ video\ file\[aq]s\ xattrs\ (using\ dublin\ core\ and\ xdg\ standards) -\-\-fixup\ POLICY\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Automatically\ correct\ known\ faults\ of\ the\ file.\ One\ of\ never\ (do\ nothing),\ warn\ (only\ emit\ a\ warning),\ detect_or_warn\ (the\ default; -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ fix\ file\ if\ we\ can,\ warn\ otherwise) -\-\-prefer\-avconv\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Prefer\ avconv\ over\ ffmpeg\ for\ running\ the\ postprocessors\ (default) -\-\-prefer\-ffmpeg\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Prefer\ ffmpeg\ over\ avconv\ for\ running\ the\ postprocessors -\-\-ffmpeg\-location\ PATH\ \ \ \ \ \ \ \ \ \ \ Location\ of\ the\ ffmpeg/avconv\ binary;\ either\ the\ path\ to\ the\ binary\ or\ its\ containing\ directory. -\-\-exec\ CMD\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Execute\ a\ command\ on\ the\ file\ after\ downloading,\ similar\ to\ find\[aq]s\ \-exec\ syntax.\ Example:\ \-\-exec\ \[aq]adb\ push\ {}\ /sdcard/Music/\ &&\ rm -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ {}\[aq] -\-\-convert\-subtitles\ FORMAT\ \ \ \ \ \ \ Convert\ the\ subtitles\ to\ other\ format\ (currently\ supported:\ srt|ass|vtt) -\f[] -.fi +.TP +.B \-x, \-\-extract\-audio +Convert video files to audio\-only files (requires ffmpeg or avconv and +ffprobe or avprobe) +.RS +.RE +.TP +.B \-\-audio\-format \f[I]FORMAT\f[] +Specify audio format: "best", "aac", "vorbis", "mp3", "m4a", "opus", or +"wav"; "best" by default +.RS +.RE +.TP +.B \-\-audio\-quality \f[I]QUALITY\f[] +Specify ffmpeg/avconv audio quality, insert a value between 0 (better) +and 9 (worse) for VBR or a specific bitrate like 128K (default 5) +.RS +.RE +.TP +.B \-\-recode\-video \f[I]FORMAT\f[] +Encode the video to another format if necessary (currently supported: +mp4|flv|ogg|webm|mkv|avi) +.RS +.RE +.TP +.B \-\-postprocessor\-args \f[I]ARGS\f[] +Give these arguments to the postprocessor +.RS +.RE +.TP +.B \-k, \-\-keep\-video +Keep the video file on disk after the post\- processing; the video is +erased by default +.RS +.RE +.TP +.B \-\-no\-post\-overwrites +Do not overwrite post\-processed files; the post\-processed files are +overwritten by default +.RS +.RE +.TP +.B \-\-embed\-subs +Embed subtitles in the video (only for mkv and mp4 videos) +.RS +.RE +.TP +.B \-\-embed\-thumbnail +Embed thumbnail in the audio as cover art +.RS +.RE +.TP +.B \-\-add\-metadata +Write metadata to the video file +.RS +.RE +.TP +.B \-\-metadata\-from\-title \f[I]FORMAT\f[] +Parse additional metadata like song title / artist from the video title. +The format syntax is the same as \-\-output, the parsed parameters +replace existing values. +Additional templates: %(album)s, %(artist)s. +Example: \-\-metadata\-from\-title "%(artist)s \- %(title)s" matches a +title like "Coldplay \- Paradise" +.RS +.RE +.TP +.B \-\-xattrs +Write metadata to the video file\[aq]s xattrs (using dublin core and xdg +standards) +.RS +.RE +.TP +.B \-\-fixup \f[I]POLICY\f[] +Automatically correct known faults of the file. +One of never (do nothing), warn (only emit a warning), detect_or_warn +(the default; fix file if we can, warn otherwise) +.RS +.RE +.TP +.B \-\-prefer\-avconv +Prefer avconv over ffmpeg for running the postprocessors (default) +.RS +.RE +.TP +.B \-\-prefer\-ffmpeg +Prefer ffmpeg over avconv for running the postprocessors +.RS +.RE +.TP +.B \-\-ffmpeg\-location \f[I]PATH\f[] +Location of the ffmpeg/avconv binary; either the path to the binary or +its containing directory. +.RS +.RE +.TP +.B \-\-exec \f[I]CMD\f[] +Execute a command on the file after downloading, similar to find\[aq]s +\-exec syntax. +Example: \-\-exec \[aq]adb push {} /sdcard/Music/ && rm {}\[aq] +.RS +.RE +.TP +.B \-\-convert\-subtitles \f[I]FORMAT\f[] +Convert the subtitles to other format (currently supported: srt|ass|vtt) +.RS +.RE .SH CONFIGURATION .PP You can configure youtube\-dl by placing any supported command line option to a configuration file. -On Linux, system wide configuration file is located at -\f[C]/etc/youtube\-dl.conf\f[] and user wide configuration file at +On Linux, the system wide configuration file is located at +\f[C]/etc/youtube\-dl.conf\f[] and the user wide configuration file at \f[C]~/.config/youtube\-dl/config\f[]. On Windows, the user wide configuration file locations are \f[C]%APPDATA%\\youtube\-dl\\config.txt\f[] or \f[C]C:\\Users\\<user\ name>\\youtube\-dl.conf\f[]. -For example, with the following configration file youtube\-dl will -always extract the audio, not copy the mtime and use proxy: +For example, with the following configuration file youtube\-dl will +always extract the audio, not copy the mtime and use a proxy: .IP .nf \f[C] @@ -272,7 +841,7 @@ always extract the audio, not copy the mtime and use proxy: \f[] .fi .PP -You can use \f[C]\-\-ignore\-config\f[] if you want to disable +You can use \f[C]\-\-ignore\-config\f[] if you want to disable the configuration file for a particular youtube\-dl run. .SS Authentication with \f[C]\&.netrc\f[] file .PP @@ -280,11 +849,11 @@ You may also want to configure automatic credentials storage for extractors that support authentication (by providing login and password with \f[C]\-\-username\f[] and \f[C]\-\-password\f[]) in order not to pass credentials as command line arguments on every youtube\-dl -execution and prevent tracking plain text passwords in shell command +execution and prevent tracking plain text passwords in the shell command history. -You can achieve this using \f[C]\&.netrc\f[] +You can achieve this using a \f[C]\&.netrc\f[] file (http://stackoverflow.com/tags/.netrc/info) on per extractor basis. -For that you will need to create \f[C]\&.netrc\f[] file in your +For that you will need to create a\f[C]\&.netrc\f[] file in your \f[C]$HOME\f[] and restrict permissions to read/write by you only: .IP .nf @@ -312,11 +881,11 @@ machine\ twitch\ login\ my_twitch_account_name\ password\ my_twitch_password \f[] .fi .PP -To activate authentication with \f[C]\&.netrc\f[] file you should pass -\f[C]\-\-netrc\f[] to youtube\-dl or place it in configuration +To activate authentication with the \f[C]\&.netrc\f[] file you should +pass \f[C]\-\-netrc\f[] to youtube\-dl or place it in the configuration file (#configuration). .PP -On Windows you may also need to setup \f[C]%HOME%\f[] environment +On Windows you may also need to setup the \f[C]%HOME%\f[] environment variable manually. .SH OUTPUT TEMPLATE .PP @@ -328,7 +897,7 @@ single file, like in However, it may contain special sequences that will be replaced when downloading each video. The special sequences have the format \f[C]%(NAME)s\f[]. -To clarify, that is a percent symbol followed by a name in parenthesis, +To clarify, that is a percent symbol followed by a name in parentheses, followed by a lowercase S. Allowed names are: .IP \[bu] 2 @@ -385,7 +954,7 @@ youtube\-dl_test_video_.mp4\ \ \ \ \ \ \ \ \ \ #\ A\ simple\ file\ name .SH FORMAT SELECTION .PP By default youtube\-dl tries to download the best quality, but sometimes -you may want to download other format. +you may want to download in a different format. The simplest case is requesting a specific format, for example \f[C]\-f\ 22\f[]. You can get the list of available formats using @@ -424,8 +993,8 @@ Since the end of April 2015 and version 2015.04.26 youtube\-dl uses If ffmpeg or avconv are installed this results in downloading \f[C]bestvideo\f[] and \f[C]bestaudio\f[] separately and muxing them together into a single file giving the best overall quality available. -Otherwise it falls back to \f[C]best\f[] and results in downloading best -available quality served as a single file. +Otherwise it falls back to \f[C]best\f[] and results in downloading the +best available quality served as a single file. \f[C]best\f[] is also needed for videos that don\[aq]t come from YouTube because they don\[aq]t provide the audio and video in two different files. @@ -442,15 +1011,15 @@ delivery immediately to your player and not to wait until .PP If you want to preserve the old format selection behavior (prior to youtube\-dl 2015.04.26), i.e. -you want to download best available quality media served as a single +you want to download the best available quality media served as a single file, you should explicitly specify your choice with \f[C]\-f\ best\f[]. You may want to add it to the configuration file (#configuration) in order not to type it every time you run youtube\-dl. .SH VIDEO SELECTION .PP Videos can be filtered by their upload date using the options -\f[C]\-\-date\f[], \f[C]\-\-datebefore\f[] or \f[C]\-\-dateafter\f[], -they accept dates in two formats: +\f[C]\-\-date\f[], \f[C]\-\-datebefore\f[] or \f[C]\-\-dateafter\f[]. +They accept dates in two formats: .IP \[bu] 2 Absolute dates: Dates in the format \f[C]YYYYMMDD\f[]. .IP \[bu] 2 @@ -467,7 +1036,7 @@ $\ youtube\-dl\ \-\-dateafter\ now\-6months #\ Download\ only\ the\ videos\ uploaded\ on\ January\ 1,\ 1970 $\ youtube\-dl\ \-\-date\ 19700101 -$\ #\ will\ only\ download\ the\ videos\ uploaded\ in\ the\ 200x\ decade +$\ #\ Download\ only\ the\ videos\ uploaded\ in\ the\ 200x\ decade $\ youtube\-dl\ \-\-dateafter\ 20000101\ \-\-datebefore\ 20091231 \f[] .fi @@ -490,7 +1059,7 @@ As a rule of thumb, youtube\-dl releases at least once a month, and often weekly or even daily. Simply go to http://yt\-dl.org/ to find out the current version. Unfortunately, there is nothing we youtube\-dl developers can do if your -distributions serves a really outdated version. +distribution serves a really outdated version. You can (and should) complain to your distribution in their bugtracker or support forum. .PP @@ -544,7 +1113,7 @@ Therefore, it is unnecessary and sometimes harmful to copy long option strings from webpages. In particular, the only option out of \f[C]\-citw\f[] that is regularly useful is \f[C]\-i\f[]. -.SS Can you please put the \-b option back? +.SS Can you please put the \f[C]\-b\f[] option back? .PP Most people asking this question are not aware that youtube\-dl now defaults to downloading the highest available quality as reported by @@ -567,8 +1136,8 @@ youtube URL, solving the CAPTCHA, and restart youtube\-dl. .PP Once the video is fully downloaded, use any video player, such as vlc (http://www.videolan.org) or mplayer (http://www.mplayerhq.hu/). -.SS I extracted a video URL with \-g, but it does not play on another -machine / in my webbrowser. +.SS I extracted a video URL with \f[C]\-g\f[], but it does not play on +another machine / in my webbrowser. .PP It depends a lot on the service. In many cases, requests for the video (to download/play it) must come @@ -586,7 +1155,8 @@ exception rather than the rule. .PP Please bear in mind that some URL protocols are \f[B]not\f[] supported by browsers out of the box, including RTMP. -If you are using \-g, your own downloader must support these as well. +If you are using \f[C]\-g\f[], your own downloader must support these as +well. .PP If you want to play the video on a machine that is not running youtube\-dl, you can relay the video content from the machine that runs @@ -610,7 +1180,7 @@ output \f[C][1]\ 2839\f[] or .PP That\[aq]s actually the output from your shell. Since ampersand is one of the special shell characters it\[aq]s -interpreted by shell preventing you from passing the whole URL to +interpreted by the shell preventing you from passing the whole URL to youtube\-dl. To disable your shell from interpreting the ampersands (or any other special characters) you have to either put the whole URL in quotes or @@ -708,18 +1278,19 @@ youtube\-dl\ "http://www.youtube.com/watch?v=\-wNyEUrxzFU" .PP Use the \f[C]\-\-cookies\f[] option, for example \f[C]\-\-cookies\ /path/to/cookies/file.txt\f[]. -Note that cookies file must be in Mozilla/Netscape format and the first -line of cookies file must be either \f[C]#\ HTTP\ Cookie\ File\f[] or +Note that the cookies file must be in Mozilla/Netscape format and the +first line of the cookies file must be either +\f[C]#\ HTTP\ Cookie\ File\f[] or \f[C]#\ Netscape\ HTTP\ Cookie\ File\f[]. Make sure you have correct newline -format (https://en.wikipedia.org/wiki/Newline) in cookies file and -convert newlines if necessary to correspond your OS, namely +format (https://en.wikipedia.org/wiki/Newline) in the cookies file and +convert newlines if necessary to correspond with your OS, namely \f[C]CRLF\f[] (\f[C]\\r\\n\f[]) for Windows, \f[C]LF\f[] (\f[C]\\n\f[]) for Linux and \f[C]CR\f[] (\f[C]\\r\f[]) for Mac OS. \f[C]HTTP\ Error\ 400:\ Bad\ Request\f[] when using \f[C]\-\-cookies\f[] is a good sign of invalid newline format. .PP -Passing cookies to youtube\-dl is a good way to workaround login when +Passing cookies to youtube\-dl is a good way to workaround login when a particular extractor does not implement it explicitly. .SS Can you add support for this anime video site, or site which shows current movies for free? @@ -909,8 +1480,7 @@ This \f[I]should fail\f[] at first, but you can continually re\-run it until you\[aq]re done. If you decide to add more than one test, then rename \f[C]_TEST\f[] to \f[C]_TESTS\f[] and make it into a list of dictionaries. -The tests will be then be named -\f[C]TestDownload.test_YourExtractor\f[], +The tests will then be named \f[C]TestDownload.test_YourExtractor\f[], \f[C]TestDownload.test_YourExtractor_1\f[], \f[C]TestDownload.test_YourExtractor_2\f[], etc. .IP " 7." 4 @@ -1058,12 +1628,13 @@ only possible way for me to move forward on them is to ask for clarification over and over. .PP For bug reports, this means that your report should contain the -\f[I]complete\f[] output of youtube\-dl when called with the \-v flag. +\f[I]complete\f[] output of youtube\-dl when called with the +\f[C]\-v\f[] 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. .PP If your server has multiple IPs or you suspect censorship, adding -\-\-call\-home may be a good idea to get more diagnostics. +\f[C]\-\-call\-home\f[] may be a good idea to get more diagnostics. If the error is \f[C]ERROR:\ Unable\ to\ extract\ ...\f[] and you cannot reproduce it from multiple countries, add \f[C]\-\-dump\-pages\f[] (warning: this will yield a rather large output, redirect it to the file @@ -1080,7 +1651,7 @@ service (e.g. http://www.youtube.com/ ) is \f[I]not\f[] an example URL. .SS Are you using the latest version? .PP -Before reporting any issue, type youtube\-dl \-U. +Before reporting any issue, type \f[C]youtube\-dl\ \-U\f[]. This should report that you\[aq]re up\-to\-date. About 20% of the reports we receive are already fixed, but people are using outdated versions. |