X-Git-Url: https://git.rapsys.eu/youtubedl/blobdiff_plain/139d14b198add5b26a11ed5dca022feaa6581d98..3477c644417600d9ec8f8d2a44f82da0a4b15eb5:/README.txt diff --git a/README.txt b/README.txt index bc4f294..fc369d2 100644 --- a/README.txt +++ b/README.txt @@ -9,6 +9,7 @@ youtube-dl - download videos from youtube.com or other video platforms - VIDEO SELECTION - FAQ - DEVELOPER INSTRUCTIONS +- EMBEDDING YOUTUBE-DL - BUGS - COPYRIGHT @@ -38,10 +39,9 @@ You can also use pip: sudo pip install youtube-dl -Alternatively, refer to the developer instructions below for how to -check out and work with the git repository. For further options, -including PGP signatures, see -https://rg3.github.io/youtube-dl/download.html . +Alternatively, refer to the developer instructions for how to check out +and work with the git repository. For further options, including PGP +signatures, see https://rg3.github.io/youtube-dl/download.html . @@ -64,105 +64,214 @@ OPTIONS -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 + -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 and the URLs they would handle - --extractor-descriptions Output descriptions of all supported extractors - --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. + --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 Network Options: - --proxy URL Use the specified HTTP/HTTPS proxy. Pass in an empty string (--proxy "") for direct connection + --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) + --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) Video Selection: --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 seperated 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) + --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) + --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 & + --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 \youtube-dl.conf. +You can configure youtube-dl by placing any supported command line +option to a configuration file. On Linux, the system wide configuration +file is located at /etc/youtube-dl.conf and the user wide configuration +file at ~/.config/youtube-dl/config. On Windows, the user wide +configuration file locations are %APPDATA%\youtube-dl\config.txt or +C:\Users\\youtube-dl.conf. For example, with the following +configuration file youtube-dl will always extract the audio, not copy +the mtime and use a proxy: + + --extract-audio + --no-mtime + --proxy 127.0.0.1:3128 + +You can use --ignore-config if you want to disable the configuration +file for a particular youtube-dl run. + +Authentication with .netrc file + +You may also want to configure automatic credentials storage for +extractors that support authentication (by providing login and password +with --username and --password) in order not to pass credentials as +command line arguments on every youtube-dl execution and prevent +tracking plain text passwords in the shell command history. You can +achieve this using a .netrc file on per extractor basis. For that you +will need to create a.netrc file in your $HOME and restrict permissions +to read/write by you only: + + touch $HOME/.netrc + chmod a-rwx,u+rw $HOME/.netrc + +After that you can add credentials for extractor in the following +format, where _extractor_ is the name of extractor in lowercase: + + machine login password + +For example: + + machine youtube login myaccount@gmail.com password my_youtube_password + machine twitch login my_twitch_account_name password my_twitch_password + +To activate authentication with the .netrc file you should pass --netrc +to youtube-dl or place it in the configuration file. + +On Windows you may also need to setup the %HOME% environment variable +manually. @@ -293,7 +501,7 @@ 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 +is a percent symbol followed by a name in parentheses, followed by a lowercase S. Allowed names are: - id: The sequence will be replaced by the video identifier. @@ -309,10 +517,15 @@ lowercase S. Allowed names are: the file. - autonumber: The sequence will be replaced by a five-digit number that will be increased with each download, starting at zero. -- playlist: The name or the id of the playlist that contains the - video. -- playlist_index: The index of the video in the playlist, a five-digit - number. +- playlist: The sequence will be replaced by the name or the id of the + playlist that contains the video. +- playlist_index: The sequence will be replaced by the index of the + video in the playlist padded with leading zeros according to the + total length of the playlist. +- format_id: The sequence will be replaced by the format code + specified by --format. +- duration: The sequence will be replaced by the length of the video + in seconds. The current default template is %(title)s-%(id)s.%(ext)s. @@ -334,11 +547,11 @@ FORMAT SELECTION By default youtube-dl tries to download the best quality, but sometimes -you may want to download other format. The simplest case is requesting a -specific format, for example -f 22. You can get the list of available -formats using --list-formats, you can also use a file extension -(currently it supports aac, m4a, mp3, mp4, ogg, wav, webm) or the -special names best, bestvideo, bestaudio and worst. +you may want to download in a different format. The simplest case is +requesting a specific format, for example -f 22. You can get the list of +available formats using --list-formats, you can also use a file +extension (currently it supports aac, m4a, mp3, mp4, ogg, wav, webm) or +the special names best, bestvideo, bestaudio and worst. If you want to download multiple videos and they don't have the same formats available, you can specify the order of preference using @@ -355,14 +568,17 @@ Use commas to download multiple formats, such as -f 136/137/mp4/bestvideo,140/m4a/bestaudio. You can merge the video and audio of two formats into a single file using -f + (requires ffmpeg or avconv), for -example -f bestvideo+bestaudio. +example -f bestvideo+bestaudio. Format selectors can also be grouped +using parentheses, for example if you want to download the best mp4 and +webm formats with a height lower than 480 you can use +-f '(mp4,webm)[height<480]'. Since the end of April 2015 and version 2015.04.26 youtube-dl uses -f bestvideo+bestaudio/best as default format selection (see #5447, #5456). If ffmpeg or avconv are installed this results in downloading bestvideo and bestaudio separately and muxing them together into a single file giving the best overall quality available. Otherwise it -falls back to best and results in downloading best available quality +falls back to best and results in downloading the best available quality served as a single file. best is also needed for videos that don't come from YouTube because they don't provide the audio and video in two different files. If you want to only download some dash formats (for @@ -376,10 +592,10 @@ order to start content delivery immediately to your player and not to wait until bestvideo and bestaudio are downloaded and muxed. 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 file, you should explicitly specify your choice -with -f best. You may want to add it to the configuration file in order -not to type it every time you run youtube-dl. +youtube-dl 2015.04.26), i.e. you want to download the best available +quality media served as a single file, you should explicitly specify +your choice with -f best. You may want to add it to the configuration +file in order not to type it every time you run youtube-dl. @@ -387,7 +603,7 @@ VIDEO SELECTION Videos can be filtered by their upload date using the options --date, ---datebefore or --dateafter, they accept dates in two formats: +--datebefore or --dateafter. They accept dates in two formats: - Absolute dates: Dates in the format YYYYMMDD. - Relative dates: Dates in the format @@ -402,7 +618,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 ``` @@ -424,7 +640,7 @@ or _yum_, use the standard system update mechanism to update. Note that distribution packages are often outdated. 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 +there is nothing we youtube-dl developers can do if your distribution serves a really outdated version. You can (and should) complain to your distribution in their bugtracker or support forum. @@ -525,8 +741,8 @@ youtube-dl. Video URL contains an ampersand and I'm getting some strange output [1] 2839 or 'v' is not recognized as an internal or external command That's actually the output from your shell. Since ampersand is one of -the special shell characters it's interpreted by shell preventing you -from passing the whole URL to youtube-dl. To disable your shell from +the special shell characters it's 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 escape them with a backslash (which approach will work depends on your shell). @@ -556,7 +772,7 @@ HTTP Error 429: Too Many Requests or 402: Payment Required These two error codes indicate that the service is blocking your IP address because of overuse. Contact the service and ask them to unblock your IP address, or - if you have acquired a whitelisted IP address -already - use the --proxy or --network-address options to select another +already - use the --proxy or --source-address options to select another IP address. SyntaxError: Non-ASCII character @@ -611,6 +827,20 @@ the options with --: youtube-dl -- -wNyEUrxzFU youtube-dl "http://www.youtube.com/watch?v=-wNyEUrxzFU" +How do I pass cookies to youtube-dl? + +Use the --cookies option, for example +--cookies /path/to/cookies/file.txt. Note that the cookies file must be +in Mozilla/Netscape format and the first line of the cookies file must +be either # HTTP Cookie File or # Netscape HTTP Cookie File. Make sure +you have correct newline format in the cookies file and convert newlines +if necessary to correspond with your OS, namely CRLF (\r\n) for Windows, +LF (\n) for Linux and CR (\r) for Mac OS. HTTP Error 400: Bad Request +when using --cookies is a good sign of invalid newline format. + +Passing cookies to youtube-dl is a good way to workaround login when a +particular extractor does not implement it explicitly. + Can you add support for this anime video site, or site which shows current movies for free? As a matter of policy (as well as legality), youtube-dl does not include @@ -753,12 +983,13 @@ list (assuming your service is called yourextractor): webpage = self._download_webpage(url, video_id) # TODO more code goes here, for example ... - title = self._html_search_regex(r'

(.*?)

', webpage, 'title') + title = self._html_search_regex(r'

(.+?)

', webpage, 'title') return { 'id': video_id, 'title': title, 'description': self._og_search_description(webpage), + 'uploader': self._search_regex(r']+id="uploader"[^>]*>([^<]+)<', webpage, 'uploader', fatal=False), # TODO more properties (see youtube_dl/extractor/common.py) } ``` @@ -768,12 +999,12 @@ list (assuming your service is called yourextractor): This _should fail_ at first, but you can continually re-run it until you're done. If you decide to add more than one test, then rename _TEST to _TESTS and make it into a list of dictionaries. The tests - will be then be named TestDownload.test_YourExtractor, + will then be named TestDownload.test_YourExtractor, TestDownload.test_YourExtractor_1, TestDownload.test_YourExtractor_2, etc. -7. Have a look at youtube_dl/common/extractor/common.py for possible - helper methods and a detailed description of what your extractor - should return. Add tests and code for as many as you want. +7. Have a look at youtube_dl/extractor/common.py for possible helper + methods and a detailed description of what your extractor should and + may return. Add tests and code for as many as you want. 8. If you can, check the code with flake8. 9. When the tests pass, add the new files and commit them and push the result, like this: @@ -864,7 +1095,7 @@ discussions, join us in the irc channel #youtube-dl on freenode. PLEASE INCLUDE THE FULL OUTPUT OF YOUTUBE-DL WHEN RUN WITH -v. -The output (including the first lines) contain important debugging +The output (including the first lines) contains important debugging information. Issues without the full output are often not reproducible and therefore do not get solved in short order, if ever. @@ -898,12 +1129,12 @@ _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. -If your server has multiple IPs or you suspect censorship, -adding --call-home may be a good idea to get more diagnostics. If the -error is ERROR: Unable to extract ... and you cannot reproduce it from -multiple countries, add --dump-pages (warning: this will yield a rather -large output, redirect it to the file log.txt by adding >log.txt 2>&1 to -your command-line) or upload the .dump files you get when you add +If your server has multiple IPs or you suspect censorship, adding +--call-home may be a good idea to get more diagnostics. If the error is +ERROR: Unable to extract ... and you cannot reproduce it from multiple +countries, add --dump-pages (warning: this will yield a rather large +output, redirect it to the file log.txt by adding >log.txt 2>&1 to your +command-line) or upload the .dump files you get when you add --write-pages somewhere. SITE SUPPORT REQUESTS MUST CONTAIN AN EXAMPLE URL. An example URL is a