Cool_Tools/yt-dlp
1
0
Fork 0
mirror of https://github.com/yt-dlp/yt-dlp.git synced 2024-11-28 09:31:01 +01:00
Code Issues Packages Projects Releases Wiki Activity

[readme] Cleanup options

Browse Source 
(Closes #23) :skip ci
This commit is contained in:
pukkandan 2021-01-19 00:47:48 +05:30
parent 67002a5ad8
commit 8a51f56439
3 changed files with 146 additions and 139 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

164
README.md
View File

@ -30,7 +30,7 @@ # YT-DLP
* [Authentication Options](#authentication-options) * [Authentication Options](#authentication-options)
* [Adobe Pass Options](#adobe-pass-options) * [Adobe Pass Options](#adobe-pass-options)
* [Post-processing Options](#post-processing-options) * [Post-processing Options](#post-processing-options)
* [SponSkrub Options (SponsorBlock)](#sponskrub-options-sponsorblock) * [SponSkrub (SponsorBlock) Options](#sponskrub-sponsorblock-options)
* [Extractor Options](#extractor-options) * [Extractor Options](#extractor-options)
* [CONFIGURATION](#configuration) * [CONFIGURATION](#configuration)
* [Authentication with .netrc file](#authentication-with-netrc-file) * [Authentication with .netrc file](#authentication-with-netrc-file)
@ -47,7 +47,7 @@ # YT-DLP
# NEW FEATURES # NEW FEATURES
The major new features from the latest release of [blackjack4494/yt-dlc](https://github.com/blackjack4494/yt-dlc) are: 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)) * **[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 @@ ## General Options:
permissions (run with sudo if needed) permissions (run with sudo if needed)
-i, --ignore-errors Continue on download errors, for example to -i, --ignore-errors Continue on download errors, for example to
skip unavailable videos in a playlist skip unavailable videos in a playlist
(default) (Same as --no-abort-on-error) (default) (Alias: --no-abort-on-error)
--abort-on-error Abort downloading of further videos if an --abort-on-error Abort downloading of further videos if an
error occurs (Same as --no-ignore-errors) error occurs (Alias: --no-ignore-errors)
--dump-user-agent Display the current browser identification --dump-user-agent Display the current browser identification
--list-extractors List all supported extractors --list-extractors List all supported extractors
--extractor-descriptions Output descriptions of all supported --extractor-descriptions Output descriptions of all supported
@ -140,25 +140,25 @@ ## General Options:
warning when guessing). "error" just throws warning when guessing). "error" just throws
an error. The default value "fixup_error" an error. The default value "fixup_error"
repairs broken URLs, but emits an error if 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 --ignore-config, --no-config Disable loading any configuration files
except the one provided by --config- except the one provided by --config-location.
location. When given inside a configuration When given inside a configuration
file, no further configuration files are file, no further configuration files are
loaded. Additionally, (for backward loaded. Additionally, (for backward
compatibility) if this option is found compatibility) if this option is found
inside the system configuration file, the 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 --config-location PATH Location of the configuration file; either
the path to the config or its containing the path to the config or its containing
directory. directory
--flat-playlist Do not extract the videos of a playlist, --flat-playlist Do not extract the videos of a playlist,
only list them. only list them
--flat-videos Do not resolve the video urls --flat-videos Do not resolve the video urls
--no-flat-playlist Extract the videos of a playlist --no-flat-playlist Extract the videos of a playlist
--mark-watched Mark videos watched (YouTube only) --mark-watched Mark videos watched (YouTube only)
--no-mark-watched Do not mark videos watched --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: ## Network Options:
--proxy URL Use the specified HTTP/HTTPS/SOCKS proxy. --proxy URL Use the specified HTTP/HTTPS/SOCKS proxy.
@ -176,7 +176,7 @@ ## Geo Restriction:
some geo-restricted sites. The default some geo-restricted sites. The default
proxy specified by --proxy (or none, if the proxy specified by --proxy (or none, if the
option is not present) is used for the option is not present) is used for the
actual downloading. actual downloading
--geo-bypass Bypass geographic restriction via faking --geo-bypass Bypass geographic restriction via faking
X-Forwarded-For HTTP header X-Forwarded-For HTTP header
--no-geo-bypass Do not bypass geographic restriction via --no-geo-bypass Do not bypass geographic restriction via
@ -198,7 +198,7 @@ ## Video Selection:
indexed 1, 2, 5, 8 in the playlist. You can indexed 1, 2, 5, 8 in the playlist. You can
specify range: "--playlist-items specify range: "--playlist-items
1-3,7,10-13", it will download the videos 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 --match-title REGEX Download only matching titles (regex or
caseless sub-string) caseless sub-string)
--reject-title REGEX Skip download for matching titles (regex or --reject-title REGEX Skip download for matching titles (regex or
@ -222,38 +222,38 @@ ## Video Selection:
--max-views COUNT Do not download any videos with more than --max-views COUNT Do not download any videos with more than
COUNT views COUNT views
--match-filter FILTER Generic video filter. Specify any key (see --match-filter FILTER Generic video filter. Specify any key (see
the "OUTPUT TEMPLATE" for a list of "OUTPUT TEMPLATE" for a list of available
available keys) to match if the key is keys) to match if the key is present, !key
present, !key to check if the key is not to check if the key is not present,
present, key > NUMBER (like "comment_count key>NUMBER (like "comment_count > 12", also
> 12", also works with >=, <, <=, !=, =) to works with >=, <, <=, !=, =) to compare
compare against a number, key = 'LITERAL' against a number, key = 'LITERAL' (like
(like "uploader = 'Mike Smith'", also works "uploader = 'Mike Smith'", also works with
with !=) to match against a string literal !=) to match against a string literal and &
and & to require multiple matches. Values to require multiple matches. Values which
which are not known are excluded unless you are not known are excluded unless you put a
put a question mark (?) after the operator. question mark (?) after the operator. For
For example, to only match videos that have example, to only match videos that have
been liked more than 100 times and disliked been liked more than 100 times and disliked
less than 50 times (or the dislike less than 50 times (or the dislike
functionality is not available at the given functionality is not available at the given
service), but who also have a description, service), but who also have a description,
use --match-filter "like_count > 100 & use --match-filter "like_count > 100 &
dislike_count <? 50 & description" . dislike_count <? 50 & description"
--no-match-filter Do not use generic video filter (default) --no-match-filter Do not use generic video filter (default)
--no-playlist Download only the video, if the URL refers --no-playlist Download only the video, if the URL refers
to a video and a playlist. to a video and a playlist
--yes-playlist Download the playlist, if the URL refers to --yes-playlist Download the playlist, if the URL refers to
a video and a playlist. a video and a playlist
--age-limit YEARS Download only videos suitable for the given --age-limit YEARS Download only videos suitable for the given
age age
--download-archive FILE Download only videos not listed in the --download-archive FILE Download only videos not listed in the
archive file. Record the IDs of all archive file. Record the IDs of all
downloaded videos in it. downloaded videos in it
--break-on-existing Stop the download process when encountering --break-on-existing Stop the download process when encountering
a file that's in the archive. a file that is in the archive
--break-on-reject Stop the download process when encountering --break-on-reject Stop the download process when encountering
a file that has been filtered out. a file that has been filtered out
--no-download-archive Do not use archive file (default) --no-download-archive Do not use archive file (default)
--include-ads Download advertisements as well --include-ads Download advertisements as well
(experimental) (experimental)
@ -263,15 +263,15 @@ ## Download Options:
-r, --limit-rate RATE Maximum download rate in bytes per second -r, --limit-rate RATE Maximum download rate in bytes per second
(e.g. 50K or 4.2M) (e.g. 50K or 4.2M)
-R, --retries RETRIES Number of retries (default is 10), or -R, --retries RETRIES Number of retries (default is 10), or
"infinite". "infinite"
--fragment-retries RETRIES Number of retries for a fragment (default --fragment-retries RETRIES Number of retries for a fragment (default
is 10), or "infinite" (DASH, hlsnative and is 10), or "infinite" (DASH, hlsnative and
ISM) ISM)
--skip-unavailable-fragments Skip unavailable fragments for DASH, --skip-unavailable-fragments Skip unavailable fragments for DASH,
hlsnative and ISM (default) hlsnative and ISM (default)
(Same as --no-abort-on-unavailable-fragment) (Alias: --no-abort-on-unavailable-fragment)
--abort-on-unavailable-fragment Abort downloading if a fragment is unavailable --abort-on-unavailable-fragment Abort downloading if a fragment is unavailable
(Same as --no-skip-unavailable-fragments) (Alias: --no-skip-unavailable-fragments)
--keep-fragments Keep downloaded fragments on disk after --keep-fragments Keep downloaded fragments on disk after
downloading is finished downloading is finished
--no-keep-fragments Delete downloaded fragments after --no-keep-fragments Delete downloaded fragments after
@ -311,8 +311,8 @@ ## Filesystem Options:
-a, --batch-file FILE File containing URLs to download ('-' for -a, --batch-file FILE File containing URLs to download ('-' for
stdin), one URL per line. Lines starting stdin), one URL per line. Lines starting
with '#', ';' or ']' are considered as with '#', ';' or ']' are considered as
comments and ignored. comments and ignored
-o, --output TEMPLATE Output filename template, see the "OUTPUT -o, --output TEMPLATE Output filename template, see "OUTPUT
TEMPLATE" for details TEMPLATE" for details
--autonumber-start NUMBER Specify the start value for %(autonumber)s --autonumber-start NUMBER Specify the start value for %(autonumber)s
(default is 1) (default is 1)
@ -358,7 +358,7 @@ ## Filesystem Options:
~/.cache/youtube-dl . At the moment, only ~/.cache/youtube-dl . At the moment, only
YouTube player files (for videos with YouTube player files (for videos with
obfuscated signatures) are cached, but that obfuscated signatures) are cached, but that
may change. may change
--no-cache-dir Disable filesystem caching --no-cache-dir Disable filesystem caching
--rm-cache-dir Delete all filesystem cache files --rm-cache-dir Delete all filesystem cache files
--trim-file-name LENGTH Limit the filename length (extension --trim-file-name LENGTH Limit the filename length (extension
@ -373,13 +373,13 @@ ## Thumbnail Images:
formats formats
## Internet Shortcut Options: ## Internet Shortcut Options:
--write-link Write an internet shortcut file, depending on --write-link Write an internet shortcut file, depending
the current platform (.url/.webloc/.desktop). on the current platform (.url, .webloc or
The URL may be cached by the OS. .desktop). The URL may be cached by the OS
--write-url-link Write a Windows .url internet shortcut file. --write-url-link Write a .url Windows internet shortcut. The
(The OS caches the URL based on the file path) OS caches the URL based on the file path
--write-webloc-link Write a .webloc macOS internet shortcut file --write-webloc-link Write a .webloc macOS internet shortcut
--write-desktop-link Write a .desktop Linux internet shortcut file --write-desktop-link Write a .desktop Linux internet shortcut
## Verbosity / Simulation Options: ## Verbosity / Simulation Options:
-q, --quiet Activate quiet mode -q, --quiet Activate quiet mode
@ -396,18 +396,18 @@ ## Verbosity / Simulation Options:
--get-filename Simulate, quiet but print output filename --get-filename Simulate, quiet but print output filename
--get-format Simulate, quiet but print output format --get-format Simulate, quiet but print output format
-j, --dump-json Simulate, quiet but print JSON information. -j, --dump-json Simulate, quiet but print JSON information.
See the "OUTPUT TEMPLATE" for a description See "OUTPUT TEMPLATE" for a description of
of available keys. available keys
-J, --dump-single-json Simulate, quiet but print JSON information -J, --dump-single-json Simulate, quiet but print JSON information
for each command-line argument. If the URL for each command-line argument. If the URL
refers to a playlist, dump the whole refers to a playlist, dump the whole
playlist information in a single line. playlist information in a single line
--print-json Be quiet and print the video information as --print-json Be quiet and print the video information as
JSON (video is still being downloaded). JSON (video is still being downloaded)
--force-write-archive Force download archive entries to be written --force-write-archive Force download archive entries to be
as far as no errors occur, even if -s or written as far as no errors occur,even if
another simulation switch is used. -s or another simulation switch is used
(Same as --force-download-archive) (Alias: --force-download-archive)
--newline Output progress bar as new lines --newline Output progress bar as new lines
--no-progress Do not print progress bar --no-progress Do not print progress bar
--console-title Display progress in console titlebar --console-title Display progress in console titlebar
@ -443,11 +443,11 @@ ## Workarounds:
of a range for randomized sleep before each of a range for randomized sleep before each
download (minimum possible number of download (minimum possible number of
seconds to sleep) when used along with seconds to sleep) when used along with
--max-sleep-interval. --max-sleep-interval
--max-sleep-interval SECONDS Upper bound of a range for randomized sleep --max-sleep-interval SECONDS Upper bound of a range for randomized sleep
before each download (maximum possible before each download (maximum possible
number of seconds to sleep). Must only be number of seconds to sleep). Must only be
used along with --min-sleep-interval. used along with --min-sleep-interval
--sleep-subtitles SECONDS Enforce sleep interval on subtitles as well --sleep-subtitles SECONDS Enforce sleep interval on subtitles as well
## Video Format Options: ## Video Format Options:
@ -474,22 +474,22 @@ ## Video Format Options:
formats of same quality formats of same quality
-F, --list-formats List all available formats of requested -F, --list-formats List all available formats of requested
videos videos
--list-formats-as-table Present the output of -F in a more tabular --list-formats-as-table Present the output of -F in tabular form
form (default) (default)
(Same as --no-list-formats-as-table)
--list-formats-old Present the output of -F in the old form --list-formats-old Present the output of -F in the old form
--youtube-include-dash-manifest Download the DASH manifests and related data (Alias: --no-list-formats-as-table)
on YouTube videos (default) --youtube-include-dash-manifest Download the DASH manifests and related
(Same as --no-youtube-skip-dash-manifest) data on YouTube videos (default) (Alias:
--no-youtube-skip-dash-manifest)
--youtube-skip-dash-manifest Do not download the DASH manifests and --youtube-skip-dash-manifest Do not download the DASH manifests and
related data on YouTube videos related data on YouTube videos (Alias:
(Same as --no-youtube-include-dash-manifest) --no-youtube-include-dash-manifest)
--youtube-include-hls-manifest Download the HLS manifests and related data --youtube-include-hls-manifest Download the HLS manifests and related data
on YouTube videos (default) on YouTube videos (default) (Alias:
(Same as --no-youtube-skip-hls-manifest) --no-youtube-skip-hls-manifest)
--youtube-skip-hls-manifest Do not download the HLS manifests and --youtube-skip-hls-manifest Do not download the HLS manifests and
related data on YouTube videos related data on YouTube videos (Alias:
(Same as --no-youtube-include-hls-manifest) --no-youtube-include-hls-manifest)
--merge-output-format FORMAT If a merge is required (e.g. --merge-output-format FORMAT If a merge is required (e.g.
bestvideo+bestaudio), output to given bestvideo+bestaudio), output to given
container format. One of mkv, mp4, ogg, container format. One of mkv, mp4, ogg,
@ -515,7 +515,7 @@ ## Subtitle Options:
## Authentication Options: ## Authentication Options:
-u, --username USERNAME Login with this account ID -u, --username USERNAME Login with this account ID
-p, --password PASSWORD Account password. If this option is left -p, --password PASSWORD Account password. If this option is left
out, youtube-dlc will ask interactively. out, youtube-dlc will ask interactively
-2, --twofactor TWOFACTOR Two-factor authentication code -2, --twofactor TWOFACTOR Two-factor authentication code
-n, --netrc Use .netrc authentication data -n, --netrc Use .netrc authentication data
--video-password PASSWORD Video password (vimeo, youku) --video-password PASSWORD Video password (vimeo, youku)
@ -527,7 +527,7 @@ ## Adobe Pass Options:
--ap-username USERNAME Multiple-system operator account login --ap-username USERNAME Multiple-system operator account login
--ap-password PASSWORD Multiple-system operator account password. --ap-password PASSWORD Multiple-system operator account password.
If this option is left out, youtube-dlc If this option is left out, youtube-dlc
will ask interactively. will ask interactively
--ap-list-mso List all supported multiple-system --ap-list-mso List all supported multiple-system
operators operators
@ -594,13 +594,14 @@ ## Post-Processing Options:
default; fix file if we can, warn default; fix file if we can, warn
otherwise) otherwise)
--prefer-avconv Prefer avconv over ffmpeg for running the --prefer-avconv Prefer avconv over ffmpeg for running the
postprocessors (Same as --no-prefer-ffmpeg) postprocessors (Alias: --no-prefer-ffmpeg)
--prefer-ffmpeg Prefer ffmpeg over avconv for running the --prefer-ffmpeg Prefer ffmpeg over avconv for running the
postprocessors (default) postprocessors (default)
(Same as --no-prefer-avconv) (Alias: --no-prefer-avconv)
--ffmpeg-location PATH Location of the ffmpeg/avconv binary; --ffmpeg-location PATH Location of the ffmpeg/avconv binary;
either the path to the binary or its either the path to the binary or its
containing directory. containing directory
(Alias: --avconv-location)
--exec CMD Execute a command on the file after --exec CMD Execute a command on the file after
downloading and post-processing, similar to downloading and post-processing, similar to
find's -exec syntax. Example: --exec 'adb find's -exec syntax. Example: --exec 'adb
@ -608,11 +609,14 @@ ## Post-Processing Options:
--convert-subs FORMAT Convert the subtitles to other format --convert-subs FORMAT Convert the subtitles to other format
(currently supported: srt|ass|vtt|lrc) (currently supported: srt|ass|vtt|lrc)
## [SponSkrub](https://github.com/pukkandan/SponSkrub) Options ([SponsorBlock](https://sponsor.ajay.app)): ## SponSkrub (SponsorBlock) Options:
--sponskrub Use sponskrub to mark sponsored sections [SponSkrub](https://github.com/pukkandan/SponSkrub) is a utility to
with the data available in SponsorBlock mark/remove sponsor segments from downloaded YouTube videos using
API. This is enabled by default if the [SponsorBlock API](https://sponsor.ajay.app)
sponskrub binary exists (Youtube only)
--sponskrub Use sponskrub to mark sponsored sections.
This is enabled by default if the sponskrub
binary exists (Youtube only)
--no-sponskrub Do not use sponskrub --no-sponskrub Do not use sponskrub
--sponskrub-cut Cut out the sponsor sections instead of --sponskrub-cut Cut out the sponsor sections instead of
simply marking them simply marking them
@ -624,13 +628,13 @@ ## [SponSkrub](https://github.com/pukkandan/SponSkrub) Options ([SponsorBlock](h
video was already downloaded (default) video was already downloaded (default)
--sponskrub-location PATH Location of the sponskrub binary; either --sponskrub-location PATH Location of the sponskrub binary; either
the path to the binary or its containing the path to the binary or its containing
directory. directory
## Extractor Options: ## Extractor Options:
--ignore-dynamic-mpd Do not process dynamic DASH manifests
(Same as --no-allow-dynamic-mpd)
--allow-dynamic-mpd Process dynamic DASH manifests (default) --allow-dynamic-mpd Process dynamic DASH manifests (default)
(Same as --no-ignore-dynamic-mpd) (Alias: --no-ignore-dynamic-mpd)
--ignore-dynamic-mpd Do not process dynamic DASH manifests
(Alias: --no-allow-dynamic-mpd)
# CONFIGURATION # CONFIGURATION

9
youtube_dlc/YoutubeDL.py
View File

@ -232,10 +232,11 @@ class YoutubeDL(object):
download_archive: File name of a file where all downloads are recorded. download_archive: File name of a file where all downloads are recorded.
Videos already present in the file are not downloaded Videos already present in the file are not downloaded
again. again.
break_on_existing: Stop the download process after attempting to download a file that's break_on_existing: Stop the download process after attempting to download a
in the archive. file that is in the archive.
break_on_reject: Stop the download process when encountering a video that has been filtered out. break_on_reject: Stop the download process when encountering a video that
cookiefile: File name where cookies should be read from and dumped to. has been filtered out.
cookiefile: File name where cookies should be read from and dumped to
nocheckcertificate:Do not verify SSL certificates nocheckcertificate:Do not verify SSL certificates
prefer_insecure: Use HTTP instead of HTTPS to retrieve information. prefer_insecure: Use HTTP instead of HTTPS to retrieve information.
At the moment, this is only supported by YouTube. At the moment, this is only supported by YouTube.

98
youtube_dlc/options.py
View File

@ -137,11 +137,11 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
general.add_option( general.add_option(
'-i', '--ignore-errors', '--no-abort-on-error', '-i', '--ignore-errors', '--no-abort-on-error',
action='store_true', dest='ignoreerrors', default=True, action='store_true', dest='ignoreerrors', default=True,
help='Continue on download errors, for example to skip unavailable videos in a playlist (default)') help='Continue on download errors, for example to skip unavailable videos in a playlist (default) (Alias: --no-abort-on-error)')
general.add_option( general.add_option(
'--abort-on-error', '--no-ignore-errors', '--abort-on-error', '--no-ignore-errors',
action='store_false', dest='ignoreerrors', action='store_false', dest='ignoreerrors',
help='Abort downloading of further videos if an error occurs') help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)')
general.add_option( general.add_option(
'--dump-user-agent', '--dump-user-agent',
action='store_true', dest='dump_user_agent', default=False, action='store_true', dest='dump_user_agent', default=False,
@ -161,7 +161,7 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
general.add_option( general.add_option(
'--default-search', '--default-search',
dest='default_search', metavar='PREFIX', dest='default_search', metavar='PREFIX',
help='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.') help='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')
general.add_option( general.add_option(
'--ignore-config', '--no-config', '--ignore-config', '--no-config',
action='store_true', action='store_true',
@ -169,15 +169,15 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
'Disable loading any configuration files except the one provided by --config-location. ' 'Disable loading any configuration files except the one provided by --config-location. '
'When given inside a configuration file, no further configuration files are loaded. ' 'When given inside a configuration file, no further configuration files are loaded. '
'Additionally, (for backward compatibility) if this option is found inside the ' 'Additionally, (for backward compatibility) if this option is found inside the '
'system configuration file, the user configuration is not loaded.')) 'system configuration file, the user configuration is not loaded'))
general.add_option( general.add_option(
'--config-location', '--config-location',
dest='config_location', metavar='PATH', dest='config_location', metavar='PATH',
help='Location of the configuration file; either the path to the config or its containing directory.') help='Location of the configuration file; either the path to the config or its containing directory')
general.add_option( general.add_option(
'--flat-playlist', '--flat-playlist',
action='store_const', dest='extract_flat', const='in_playlist', default=False, action='store_const', dest='extract_flat', const='in_playlist', default=False,
help='Do not extract the videos of a playlist, only list them.') help='Do not extract the videos of a playlist, only list them')
general.add_option( general.add_option(
'--flat-videos', '--flat-videos',
action='store_true', dest='extract_flat', action='store_true', dest='extract_flat',
@ -195,7 +195,7 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
action='store_false', dest='mark_watched', default=False, action='store_false', dest='mark_watched', default=False,
help='Do not mark videos watched') help='Do not mark videos watched')
general.add_option( general.add_option(
'--no-color', '--no-colors', '--no-colors',
action='store_true', dest='no_color', action='store_true', dest='no_color',
default=False, default=False,
help='Do not emit color codes in output') help='Do not emit color codes in output')
@ -235,7 +235,7 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
dest='geo_verification_proxy', default=None, metavar='URL', dest='geo_verification_proxy', default=None, metavar='URL',
help=( help=(
'Use this proxy to verify the IP address for some geo-restricted sites. ' 'Use this proxy to verify the IP address for some geo-restricted sites. '
'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading.')) 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
geo.add_option( geo.add_option(
'--cn-verification-proxy', '--cn-verification-proxy',
dest='cn_verification_proxy', default=None, metavar='URL', dest='cn_verification_proxy', default=None, metavar='URL',
@ -269,7 +269,7 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
selection.add_option( selection.add_option(
'--playlist-items', '--playlist-items',
dest='playlist_items', metavar='ITEM_SPEC', default=None, dest='playlist_items', metavar='ITEM_SPEC', default=None,
help='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.') help='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')
selection.add_option( selection.add_option(
'--match-title', '--match-title',
dest='matchtitle', metavar='REGEX', dest='matchtitle', metavar='REGEX',
@ -322,7 +322,7 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
metavar='FILTER', dest='match_filter', default=None, metavar='FILTER', dest='match_filter', default=None,
help=( help=(
'Generic video filter. ' 'Generic video filter. '
'Specify any key (see the "OUTPUT TEMPLATE" for a list of available keys) to ' 'Specify any key (see "OUTPUT TEMPLATE" for a list of available keys) to '
'match if the key is present, ' 'match if the key is present, '
'!key to check if the key is not present, ' '!key to check if the key is not present, '
'key>NUMBER (like "comment_count > 12", also works with ' 'key>NUMBER (like "comment_count > 12", also works with '
@ -336,7 +336,7 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
'100 times and disliked less than 50 times (or the dislike ' '100 times and disliked less than 50 times (or the dislike '
'functionality is not available at the given service), but who ' 'functionality is not available at the given service), but who '
'also have a description, use --match-filter ' 'also have a description, use --match-filter '
'"like_count > 100 & dislike_count <? 50 & description" .')) '"like_count > 100 & dislike_count <? 50 & description"'))
selection.add_option( selection.add_option(
'--no-match-filter', '--no-match-filter',
metavar='FILTER', dest='match_filter', action='store_const', const=None, metavar='FILTER', dest='match_filter', action='store_const', const=None,
@ -344,11 +344,11 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
selection.add_option( selection.add_option(
'--no-playlist', '--no-playlist',
action='store_true', dest='noplaylist', default=False, action='store_true', dest='noplaylist', default=False,
help='Download only the video, if the URL refers to a video and a playlist.') help='Download only the video, if the URL refers to a video and a playlist')
selection.add_option( selection.add_option(
'--yes-playlist', '--yes-playlist',
action='store_false', dest='noplaylist', default=False, action='store_false', dest='noplaylist', default=False,
help='Download the playlist, if the URL refers to a video and a playlist.') help='Download the playlist, if the URL refers to a video and a playlist')
selection.add_option( selection.add_option(
'--age-limit', '--age-limit',
metavar='YEARS', dest='age_limit', default=None, type=int, metavar='YEARS', dest='age_limit', default=None, type=int,
@ -356,15 +356,15 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
selection.add_option( selection.add_option(
'--download-archive', metavar='FILE', '--download-archive', metavar='FILE',
dest='download_archive', dest='download_archive',
help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it.') help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
selection.add_option( selection.add_option(
'--break-on-existing', '--break-on-existing',
action='store_true', dest='break_on_existing', default=False, action='store_true', dest='break_on_existing', default=False,
help="Stop the download process when encountering a file that's in the archive.") help='Stop the download process when encountering a file that is in the archive')
selection.add_option( selection.add_option(
'--break-on-reject', '--break-on-reject',
action='store_true', dest='break_on_reject', default=False, action='store_true', dest='break_on_reject', default=False,
help="Stop the download process when encountering a file that has been filtered out.") help='Stop the download process when encountering a file that has been filtered out')
selection.add_option( selection.add_option(
'--no-download-archive', '--no-download-archive',
dest='download_archive', action="store_const", const=None, dest='download_archive', action="store_const", const=None,
@ -386,7 +386,7 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
authentication.add_option( authentication.add_option(
'-p', '--password', '-p', '--password',
dest='password', metavar='PASSWORD', dest='password', metavar='PASSWORD',
help='Account password. If this option is left out, youtube-dlc will ask interactively.') help='Account password. If this option is left out, youtube-dlc will ask interactively')
authentication.add_option( authentication.add_option(
'-2', '--twofactor', '-2', '--twofactor',
dest='twofactor', metavar='TWOFACTOR', dest='twofactor', metavar='TWOFACTOR',
@ -412,7 +412,7 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
adobe_pass.add_option( adobe_pass.add_option(
'--ap-password', '--ap-password',
dest='ap_password', metavar='PASSWORD', dest='ap_password', metavar='PASSWORD',
help='Multiple-system operator account password. If this option is left out, youtube-dlc will ask interactively.') help='Multiple-system operator account password. If this option is left out, youtube-dlc will ask interactively')
adobe_pass.add_option( adobe_pass.add_option(
'--ap-list-mso', '--ap-list-mso',
action='store_true', dest='ap_list_mso', default=False, action='store_true', dest='ap_list_mso', default=False,
@ -471,27 +471,27 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
video_format.add_option( video_format.add_option(
'--list-formats-as-table', '--list-formats-as-table',
action='store_true', dest='listformats_table', default=True, action='store_true', dest='listformats_table', default=True,
help='Present the output of -F in a more tabular form (default)') help='Present the output of -F in tabular form (default)')
video_format.add_option( video_format.add_option(
'--list-formats-old', '--no-list-formats-as-table', '--list-formats-old', '--no-list-formats-as-table',
action='store_false', dest='listformats_table', action='store_false', dest='listformats_table',
help='Present the output of -F in the old form') help='Present the output of -F in the old form (Alias: --no-list-formats-as-table)')
video_format.add_option( video_format.add_option(
'--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest', '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
action='store_true', dest='youtube_include_dash_manifest', default=True, action='store_true', dest='youtube_include_dash_manifest', default=True,
help='Download the DASH manifests and related data on YouTube videos (default)') help='Download the DASH manifests and related data on YouTube videos (default) (Alias: --no-youtube-skip-dash-manifest)')
video_format.add_option( video_format.add_option(
'--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest', '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
action='store_false', dest='youtube_include_dash_manifest', action='store_false', dest='youtube_include_dash_manifest',
help='Do not download the DASH manifests and related data on YouTube videos') help='Do not download the DASH manifests and related data on YouTube videos (Alias: --no-youtube-include-dash-manifest)')
video_format.add_option( video_format.add_option(
'--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest', '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
action='store_true', dest='youtube_include_hls_manifest', default=True, action='store_true', dest='youtube_include_hls_manifest', default=True,
help='Download the HLS manifests and related data on YouTube videos (default)') help='Download the HLS manifests and related data on YouTube videos (default) (Alias: --no-youtube-skip-hls-manifest)')
video_format.add_option( video_format.add_option(
'--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest', '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
action='store_false', dest='youtube_include_hls_manifest', action='store_false', dest='youtube_include_hls_manifest',
help='Do not download the HLS manifests and related data on YouTube videos') help='Do not download the HLS manifests and related data on YouTube videos (Alias: --no-youtube-include-hls-manifest)')
video_format.add_option( video_format.add_option(
'--merge-output-format', '--merge-output-format',
action='store', dest='merge_output_format', metavar='FORMAT', default=None, action='store', dest='merge_output_format', metavar='FORMAT', default=None,
@ -543,7 +543,7 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
downloader.add_option( downloader.add_option(
'-R', '--retries', '-R', '--retries',
dest='retries', metavar='RETRIES', default=10, dest='retries', metavar='RETRIES', default=10,
help='Number of retries (default is %default), or "infinite".') help='Number of retries (default is %default), or "infinite"')
downloader.add_option( downloader.add_option(
'--fragment-retries', '--fragment-retries',
dest='fragment_retries', metavar='RETRIES', default=10, dest='fragment_retries', metavar='RETRIES', default=10,
@ -551,11 +551,11 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
downloader.add_option( downloader.add_option(
'--skip-unavailable-fragments', '--no-abort-on-unavailable-fragment', '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragment',
action='store_true', dest='skip_unavailable_fragments', default=True, action='store_true', dest='skip_unavailable_fragments', default=True,
help='Skip unavailable fragments for DASH, hlsnative and ISM (default)') help='Skip unavailable fragments for DASH, hlsnative and ISM (default) (Alias: --no-abort-on-unavailable-fragment)')
downloader.add_option( downloader.add_option(
'--abort-on-unavailable-fragment', '--no-skip-unavailable-fragments', '--abort-on-unavailable-fragment', '--no-skip-unavailable-fragments',
action='store_false', dest='skip_unavailable_fragments', action='store_false', dest='skip_unavailable_fragments',
help='Abort downloading when some fragment is unavailable') help='Abort downloading if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
downloader.add_option( downloader.add_option(
'--keep-fragments', '--keep-fragments',
action='store_true', dest='keep_fragments', default=False, action='store_true', dest='keep_fragments', default=False,
@ -665,14 +665,14 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
'Number of seconds to sleep before each download when used alone ' 'Number of seconds to sleep before each download when used alone '
'or a lower bound of a range for randomized sleep before each download ' 'or a lower bound of a range for randomized sleep before each download '
'(minimum possible number of seconds to sleep) when used along with ' '(minimum possible number of seconds to sleep) when used along with '
'--max-sleep-interval.')) '--max-sleep-interval'))
workarounds.add_option( workarounds.add_option(
'--max-sleep-interval', metavar='SECONDS', '--max-sleep-interval', metavar='SECONDS',
dest='max_sleep_interval', type=float, dest='max_sleep_interval', type=float,
help=( help=(
'Upper bound of a range for randomized sleep before each download ' 'Upper bound of a range for randomized sleep before each download '
'(maximum possible number of seconds to sleep). Must only be used ' '(maximum possible number of seconds to sleep). Must only be used '
'along with --min-sleep-interval.')) 'along with --min-sleep-interval'))
workarounds.add_option( workarounds.add_option(
'--sleep-subtitles', metavar='SECONDS', '--sleep-subtitles', metavar='SECONDS',
dest='sleep_interval_subtitles', default=0, type=int, dest='sleep_interval_subtitles', default=0, type=int,
@ -730,23 +730,23 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
verbosity.add_option( verbosity.add_option(
'-j', '--dump-json', '-j', '--dump-json',
action='store_true', dest='dumpjson', default=False, action='store_true', dest='dumpjson', default=False,
help='Simulate, quiet but print JSON information. See the "OUTPUT TEMPLATE" for a description of available keys.') help='Simulate, quiet but print JSON information. See "OUTPUT TEMPLATE" for a description of available keys')
verbosity.add_option( verbosity.add_option(
'-J', '--dump-single-json', '-J', '--dump-single-json',
action='store_true', dest='dump_single_json', default=False, action='store_true', dest='dump_single_json', default=False,
help=( help=(
'Simulate, quiet but print JSON information for each command-line argument. ' '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.')) 'If the URL refers to a playlist, dump the whole playlist information in a single line'))
verbosity.add_option( verbosity.add_option(
'--print-json', '--print-json',
action='store_true', dest='print_json', default=False, action='store_true', dest='print_json', default=False,
help='Be quiet and print the video information as JSON (video is still being downloaded).') help='Be quiet and print the video information as JSON (video is still being downloaded)')
verbosity.add_option( verbosity.add_option(
'--force-write-archive', '--force-write-download-archive', '--force-download-archive', '--force-write-archive', '--force-write-download-archive', '--force-download-archive',
action='store_true', dest='force_write_download_archive', default=False, action='store_true', dest='force_write_download_archive', default=False,
help=( help=(
'Force download archive entries to be written as far as no errors occur,' 'Force download archive entries to be written as far as no errors occur,'
'even if -s or another simulation switch is used.')) 'even if -s or another simulation switch is used (Alias: --force-download-archive)'))
verbosity.add_option( verbosity.add_option(
'--newline', '--newline',
action='store_true', dest='progress_with_newline', default=False, action='store_true', dest='progress_with_newline', default=False,
@ -793,14 +793,14 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
'-a', '--batch-file', '-a', '--batch-file',
dest='batchfile', metavar='FILE', dest='batchfile', metavar='FILE',
help="File containing URLs to download ('-' for stdin), one URL per line. " help="File containing URLs to download ('-' for stdin), one URL per line. "
"Lines starting with '#', ';' or ']' are considered as comments and ignored.") "Lines starting with '#', ';' or ']' are considered as comments and ignored")
filesystem.add_option( filesystem.add_option(
'--id', default=False, '--id', default=False,
action='store_true', dest='useid', help=optparse.SUPPRESS_HELP) action='store_true', dest='useid', help=optparse.SUPPRESS_HELP)
filesystem.add_option( filesystem.add_option(
'-o', '--output', '-o', '--output',
dest='outtmpl', metavar='TEMPLATE', dest='outtmpl', metavar='TEMPLATE',
help='Output filename template, see the "OUTPUT TEMPLATE" for details') help='Output filename template, see "OUTPUT TEMPLATE" for details')
filesystem.add_option( filesystem.add_option(
'--autonumber-size', '--autonumber-size',
dest='autonumber_size', metavar='NUMBER', type=int, dest='autonumber_size', metavar='NUMBER', type=int,
@ -903,7 +903,7 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
help='Do not read/dump cookies (default)') help='Do not read/dump cookies (default)')
filesystem.add_option( filesystem.add_option(
'--cache-dir', dest='cachedir', default=None, metavar='DIR', '--cache-dir', dest='cachedir', default=None, metavar='DIR',
help='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.') help='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')
filesystem.add_option( filesystem.add_option(
'--no-cache-dir', action='store_false', dest='cachedir', '--no-cache-dir', action='store_false', dest='cachedir',
help='Disable filesystem caching') help='Disable filesystem caching')
@ -938,19 +938,19 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
link.add_option( link.add_option(
'--write-link', '--write-link',
action='store_true', dest='writelink', default=False, action='store_true', dest='writelink', default=False,
help='Write an internet shortcut file, depending on the current platform (.url/.webloc/.desktop). The URL may be cached by the OS.') help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
link.add_option( link.add_option(
'--write-url-link', '--write-url-link',
action='store_true', dest='writeurllink', default=False, action='store_true', dest='writeurllink', default=False,
help='Write a Windows internet shortcut file (.url). Note that the OS caches the URL based on the file path.') help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
link.add_option( link.add_option(
'--write-webloc-link', '--write-webloc-link',
action='store_true', dest='writewebloclink', default=False, action='store_true', dest='writewebloclink', default=False,
help='Write a macOS internet shortcut file (.webloc)') help='Write a .webloc macOS internet shortcut')
link.add_option( link.add_option(
'--write-desktop-link', '--write-desktop-link',
action='store_true', dest='writedesktoplink', default=False, action='store_true', dest='writedesktoplink', default=False,
help='Write a Linux internet shortcut file (.desktop)') help='Write a .desktop Linux internet shortcut')
postproc = optparse.OptionGroup(parser, 'Post-Processing Options') postproc = optparse.OptionGroup(parser, 'Post-Processing Options')
postproc.add_option( postproc.add_option(
@ -1049,15 +1049,15 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
postproc.add_option( postproc.add_option(
'--prefer-avconv', '--no-prefer-ffmpeg', '--prefer-avconv', '--no-prefer-ffmpeg',
action='store_false', dest='prefer_ffmpeg', action='store_false', dest='prefer_ffmpeg',
help='Prefer avconv over ffmpeg for running the postprocessors') help='Prefer avconv over ffmpeg for running the postprocessors (Alias: --no-prefer-ffmpeg)')
postproc.add_option( postproc.add_option(
'--prefer-ffmpeg', '--no-prefer-avconv', '--prefer-ffmpeg', '--no-prefer-avconv',
action='store_true', dest='prefer_ffmpeg', action='store_true', dest='prefer_ffmpeg',
help='Prefer ffmpeg over avconv for running the postprocessors (default)') help='Prefer ffmpeg over avconv for running the postprocessors (default) (Alias: --no-prefer-avconv)')
postproc.add_option( postproc.add_option(
'--ffmpeg-location', '--avconv-location', metavar='PATH', '--ffmpeg-location', '--avconv-location', metavar='PATH',
dest='ffmpeg_location', dest='ffmpeg_location',
help='Location of the ffmpeg/avconv binary; either the path to the binary or its containing directory.') help='Location of the ffmpeg/avconv binary; either the path to the binary or its containing directory (Alias: --avconv-location)')
postproc.add_option( postproc.add_option(
'--exec', '--exec',
metavar='CMD', dest='exec_cmd', metavar='CMD', dest='exec_cmd',
@ -1067,12 +1067,14 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
metavar='FORMAT', dest='convertsubtitles', default=None, metavar='FORMAT', dest='convertsubtitles', default=None,
help='Convert the subtitles to other format (currently supported: srt|ass|vtt|lrc)') help='Convert the subtitles to other format (currently supported: srt|ass|vtt|lrc)')
sponskrub = optparse.OptionGroup(parser, 'SponSkrub Options (SponsorBlock)') sponskrub = optparse.OptionGroup(parser, 'SponSkrub (SponsorBlock) Options', description=(
'SponSkrub (https://github.com/pukkandan/SponSkrub) is a utility to mark/remove sponsor segments '
'from downloaded YouTube videos using SponsorBlock API (https://sponsor.ajay.app)'))
sponskrub.add_option( sponskrub.add_option(
'--sponskrub', '--sponskrub',
action='store_true', dest='sponskrub', default=None, action='store_true', dest='sponskrub', default=None,
help=( help=(
'Use sponskrub to mark sponsored sections with the data available in SponsorBlock API. ' 'Use sponskrub to mark sponsored sections. '
'This is enabled by default if the sponskrub binary exists (Youtube only)')) 'This is enabled by default if the sponskrub binary exists (Youtube only)'))
sponskrub.add_option( sponskrub.add_option(
'--no-sponskrub', '--no-sponskrub',
@ -1097,7 +1099,7 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
sponskrub.add_option( sponskrub.add_option(
'--sponskrub-location', metavar='PATH', '--sponskrub-location', metavar='PATH',
dest='sponskrub_path', default='', dest='sponskrub_path', default='',
help='Location of the sponskrub binary; either the path to the binary or its containing directory.') help='Location of the sponskrub binary; either the path to the binary or its containing directory')
sponskrub.add_option( sponskrub.add_option(
'--sponskrub-args', dest='sponskrub_args', metavar='ARGS', '--sponskrub-args', dest='sponskrub_args', metavar='ARGS',
help=optparse.SUPPRESS_HELP) help=optparse.SUPPRESS_HELP)
@ -1106,11 +1108,11 @@ def _comma_separated_values_options_callback(option, opt_str, value, parser):
extractor.add_option( extractor.add_option(
'--allow-dynamic-mpd', '--no-ignore-dynamic-mpd', '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
action='store_true', dest='dynamic_mpd', default=True, action='store_true', dest='dynamic_mpd', default=True,
help='Process dynamic DASH manifests (default)') help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
extractor.add_option( extractor.add_option(
'--ignore-dynamic-mpd', '--no-allow-dynamic-mpd', '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
action='store_false', dest='dynamic_mpd', action='store_false', dest='dynamic_mpd',
help='Do not process dynamic DASH manifests') help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
parser.add_option_group(general) parser.add_option_group(general)
parser.add_option_group(network) parser.add_option_group(network)