From 8a51f564395b79e66b7e6c61176337af57baa28a Mon Sep 17 00:00:00 2001 From: pukkandan Date: Tue, 19 Jan 2021 00:47:48 +0530 Subject: [PATCH] [readme] Cleanup options (Closes #23) :skip ci --- README.md | 172 ++++++++++++++++++++------------------- youtube_dlc/YoutubeDL.py | 9 +- youtube_dlc/options.py | 104 +++++++++++------------ 3 files changed, 146 insertions(+), 139 deletions(-) diff --git a/README.md b/README.md index 24b9e7d09..f0fe6e70e 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ This is a fork of [youtube-dlc](https://github.com/blackjack4494/yt-dlc) which i * [Authentication Options](#authentication-options) * [Adobe Pass Options](#adobe-pass-options) * [Post-processing Options](#post-processing-options) - * [SponSkrub Options (SponsorBlock)](#sponskrub-options-sponsorblock) + * [SponSkrub (SponsorBlock) Options](#sponskrub-sponsorblock-options) * [Extractor Options](#extractor-options) * [CONFIGURATION](#configuration) * [Authentication with .netrc file](#authentication-with-netrc-file) @@ -47,7 +47,7 @@ This is a fork of [youtube-dlc](https://github.com/blackjack4494/yt-dlc) which i # NEW FEATURES The major new features from the latest release of [blackjack4494/yt-dlc](https://github.com/blackjack4494/yt-dlc) are: -* **[SponSkrub Integration](#sponSkrub-options-sponsorblock)**: You can use [SponSkrub](https://github.com/pukkandan/SponSkrub) to mark/remove sponsor sections in youtube videos by utilizing the [SponsorBlock](https://sponsor.ajay.app) API +* **[SponSkrub Integration](#sponskrub-sponsorblock-options)**: You can use [SponSkrub](https://github.com/pukkandan/SponSkrub) to mark/remove sponsor sections in youtube videos by utilizing the [SponsorBlock](https://sponsor.ajay.app) API * **[Format Sorting](#sorting-formats)**: The default format sorting options have been changed so that higher resolution and better codecs will be now preferred instead of simply using larger bitrate. Furthermore, you can now specify the sort order using `-S`. This allows for much easier format selection that what is possible by simply using `--format` ([examples](#format-selection-examples)) @@ -123,9 +123,9 @@ Then simply type this permissions (run with sudo if needed) -i, --ignore-errors Continue on download errors, for example to skip unavailable videos in a playlist - (default) (Same as --no-abort-on-error) - --abort-on-error Abort downloading of further videos if an - error occurs (Same as --no-ignore-errors) + (default) (Alias: --no-abort-on-error) + --abort-on-error Abort downloading of further videos if an + error occurs (Alias: --no-ignore-errors) --dump-user-agent Display the current browser identification --list-extractors List all supported extractors --extractor-descriptions Output descriptions of all supported @@ -140,25 +140,25 @@ Then simply type this 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. + this is not possible instead of searching --ignore-config, --no-config Disable loading any configuration files - except the one provided by --config- - location. When given inside a configuration + except the one provided by --config-location. + When given inside a configuration file, no further configuration files are loaded. Additionally, (for backward compatibility) if this option is found inside the system configuration file, the - user configuration is not loaded. + user configuration is not loaded --config-location PATH Location of the configuration file; either the path to the config or its containing - directory. + directory --flat-playlist Do not extract the videos of a playlist, - only list them. + only list them --flat-videos Do not resolve the video urls --no-flat-playlist Extract the videos of a playlist --mark-watched Mark videos watched (YouTube only) --no-mark-watched Do not mark videos watched - --no-color Do not emit color codes in output + --no-colors Do not emit color codes in output ## Network Options: --proxy URL Use the specified HTTP/HTTPS/SOCKS proxy. @@ -176,7 +176,7 @@ Then simply type this some geo-restricted sites. The default proxy specified by --proxy (or none, if the option is not present) is used for the - actual downloading. + actual downloading --geo-bypass Bypass geographic restriction via faking X-Forwarded-For HTTP header --no-geo-bypass Do not bypass geographic restriction via @@ -198,7 +198,7 @@ Then simply type this 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. + 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 @@ -222,38 +222,38 @@ Then simply type this --max-views COUNT Do not download any videos with more than COUNT views --match-filter FILTER Generic video filter. Specify any key (see - the "OUTPUT TEMPLATE" 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, key = 'LITERAL' - (like "uploader = 'Mike Smith'", also works - with !=) to match against a string literal - 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 + "OUTPUT TEMPLATE" 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, key = 'LITERAL' (like + "uploader = 'Mike Smith'", also works with + !=) to match against a string literal 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 NUMBER (like "comment_count > 12", also works with ' + 'key>NUMBER (like "comment_count > 12", also works with ' '>=, <, <=, !=, =) to compare against a number, ' 'key = \'LITERAL\' (like "uploader = \'Mike Smith\'", also works with !=) ' 'to match against a string literal ' @@ -336,7 +336,7 @@ def parseOpts(overrideArguments=None): '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 100 & dislike_count