diff options
| -rw-r--r-- | README.md | 160 | ||||
| -rw-r--r-- | youtube_dlc/options.py | 266 |
2 files changed, 294 insertions, 132 deletions
@@ -97,14 +97,16 @@ I will add some memorable short links to the binaries so you can download them e # OPTIONS -h, --help Print this help text and exit --version Print program version and exit - -U, --update Update this program to latest version. Make + -U, --update (Doesn't work since there is no release) + 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 + (Same as --no-abort-on-error) + --abort-on-error Abort downloading of further videos if an + error occurs (Same as --no-ignore-errors) --dump-user-agent Display the current browser identification --list-extractors List all supported extractors --extractor-descriptions Output descriptions of all supported @@ -113,24 +115,26 @@ I will add some memorable short links to the binaries so you can download them e extractor --default-search PREFIX Use this prefix for unqualified URLs. For example "gvsearch2:" downloads two videos - from google videos for youtube-dlc "large + from google videos for youtube-dl "large apple". Use the value "auto" to let - youtube-dlc guess ("auto_warning" to emit a + 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 + --ignore-config, --no-config Do not read configuration files. When given in the global configuration file - /etc/youtube-dlc.conf: Do not read the user + /etc/youtube-dl.conf: Do not read the user configuration in ~/.config/youtube- - dlc/config (%APPDATA%/youtube- - dlc/config.txt on Windows) + dl/config (%APPDATA%/youtube-dl/config.txt + on Windows) --config-location PATH Location of the configuration file; either the path to the config or its containing directory. --flat-playlist Do not extract the videos of a playlist, 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 (YouTube only) --no-color Do not emit color codes in output @@ -183,11 +187,15 @@ I will add some memorable short links to the binaries so you can download them e 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 + --date DATE Download only videos uploaded in this date. + The date can be "YYYYMMDD" or in the format + "(now|today)[+-][0-9](day|week|month|year)(s)?" --datebefore DATE Download only videos uploaded on or before - this date (i.e. inclusive) + this date (i.e. inclusive). The date formats + accepted is the same as --date --dateafter DATE Download only videos uploaded on or after - this date (i.e. inclusive) + this date (i.e. inclusive). The date formats + accepted is the same as --date --min-views COUNT Do not download any videos with less than COUNT views --max-views COUNT Do not download any videos with more than @@ -211,6 +219,7 @@ I will add some memorable short links to the binaries so you can download them e service), but who also have a description, use --match-filter "like_count > 100 & dislike_count <? 50 & description" . + --no-match-filter FILTER Do not use generic video filter (default) --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 @@ -220,10 +229,11 @@ I will add some memorable short links to the binaries so you can download them e --download-archive FILE Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it. + --no-download-archive Do not use archive file (default) --break-on-existing Stop the download process after attempting to download a file that's in the archive. - --include-ads Download advertisements as well - (experimental) + --include-ads Download advertisements as well (experimental) + --no-include-ads Do not download advertisements (default) ## Download Options: -r, --limit-rate RATE Maximum download rate in bytes per second @@ -233,25 +243,28 @@ I will add some memorable short links to the binaries so you can download them e --fragment-retries RETRIES Number of retries for a fragment (default is 10), or "infinite" (DASH, hlsnative and ISM) - --skip-unavailable-fragments Skip unavailable fragments (DASH, hlsnative - and ISM) - --abort-on-unavailable-fragment Abort downloading when some fragment is not - available + --skip-unavailable-fragments Skip unavailable fragments for DASH, + hlsnative and ISM (default) + (Same as --no-abort-on-unavailable-fragment) + --abort-on-unavailable-fragment Abort downloading if a fragment is unavailable + (Same as --no-skip-unavailable-fragments) --keep-fragments Keep downloaded fragments on disk after - downloading is finished; fragments are - erased by default + downloading is finished + --no-keep-fragments Delete downloaded fragments after downloading + is finished (default) --buffer-size SIZE Size of download buffer (e.g. 1024 or 16K) (default is 1024) + --resize-buffer The buffer size is automatically resized from + an initial value of --buffer-size (default) --no-resize-buffer Do not automatically adjust the buffer - size. By default, the buffer size is - automatically resized from an initial value - of SIZE. + size --http-chunk-size SIZE Size of a chunk for chunk-based HTTP downloading (e.g. 10485760 or 10M) (default is disabled). May be useful for bypassing bandwidth throttling imposed by a webserver (experimental) --playlist-reverse Download playlist videos in reverse order + --no-playlist-reverse Download playlist videos in default order --playlist-random Download playlist videos in random order --xattr-set-filesize Set file xattribute ytdl.filesize with expected file size @@ -274,7 +287,6 @@ I will add some memorable short links to the binaries so you can download them e stdin), one URL per line. Lines starting with '#', ';' or ']' are considered as comments and ignored. - --id Use only video ID in file name -o, --output TEMPLATE Output filename template, see the "OUTPUT TEMPLATE" for all the info --autonumber-start NUMBER Specify the start value for %(autonumber)s @@ -282,31 +294,39 @@ I will add some memorable short links to the binaries so you can download them e --restrict-filenames Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames + --no-restrict-filenames Allow Unicode characters, "&" and spaces + in filenames (default) -w, --no-overwrites Do not overwrite files - -c, --continue Force resume of partially downloaded files. - By default, youtube-dlc will resume - downloads if possible. + -c, --continue Resume partially downloaded files (default) --no-continue Do not resume partially downloaded files (restart from beginning) + --part Use .part files instead of writing directly + into output file (default) --no-part Do not use .part files - write directly into output file + --mtime Use the Last-modified header to set the + file modification time --no-mtime Do not use the Last-modified header to set the file modification time --write-description Write video description to a .description file + --no-write-description Do not write video description (default) --write-info-json Write video metadata to a .info.json file + --no-write-info-json Do not write video metadata (default) --write-annotations Write video annotations to a .annotations.xml file + --no-write-annotations Do not write video annotations (default) --load-info-json 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- - dlc can store some downloaded information + --no-cookies Do not read/dump cookies (default) + --cache-dir DIR Location in the filesystem where youtube-dl + can store some downloaded information permanently. By default - $XDG_CACHE_HOME/youtube-dlc or - ~/.cache/youtube-dlc . At the moment, only + $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. @@ -317,6 +337,7 @@ I will add some memorable short links to the binaries so you can download them e ## Thumbnail images: --write-thumbnail Write thumbnail image to disk + --no-write-thumbnail Do not write thumbnail image to disk --write-all-thumbnails Write all thumbnail image formats to disk --list-thumbnails Simulate and list all available thumbnail formats @@ -325,10 +346,10 @@ I will add some memorable short links to the binaries so you can download them e --write-link Write an internet shortcut file, depending on the current platform (.url/.webloc/.desktop). The URL may be cached by the OS. - --write-url-link Write a Windows internet shortcut file (.url). - Note that the OS caches the URL based on the file path. - --write-webloc-link Write a macOS internet shortcut file (.webloc) - --write-desktop-link Write a Linux internet shortcut file (.desktop) + --write-url-link Write a Windows .url internet shortcut file. + (The OS caches the URL based on the file path) + --write-webloc-link Write a .webloc macOS internet shortcut file + --write-desktop-link Write a .desktop Linux internet shortcut file ## Verbosity / Simulation Options: -q, --quiet Activate quiet mode @@ -367,10 +388,9 @@ I will add some memorable short links to the binaries so you can download them e files in the current directory to debug problems --print-traffic Display sent and read HTTP traffic - -C, --call-home Contact the youtube-dlc server for - debugging - --no-call-home Do NOT contact the youtube-dlc server for - debugging + -C, --call-home Contact the youtube-dlc server for debugging + --no-call-home Do not contact the youtube-dlc server for + debugging (default) ## Workarounds: --encoding ENCODING Force the specified encoding (experimental) @@ -411,20 +431,34 @@ I will add some memorable short links to the binaries so you can download them e --no-format-sort-force Some fields have precedence over the user specified sort order, see "Sorting Formats" for more details (default) - --video-multistreams Allow multiple video streams to be merged into a single file (default) - --no-video-multistreams Only one video stream is downloaded for each output file - --audio-multistreams Allow multiple audio streams to be merged into a single file (default) - --no-audio-multistreams Only one audio stream is downloaded for each output file + --video-multistreams Allow multiple video streams to be merged into + a single file (default) + --no-video-multistreams Only one video stream is downloaded for each + output file + --audio-multistreams Allow multiple audio streams to be merged into + a single file (default) + --no-audio-multistreams Only one audio stream is downloaded for each + output file --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 of requested videos --list-formats-as-table Present the output of -F in a more tabular form + --list-formats-old Present the output of -F in older form (default) + (Same as --no-list-formats-as-table) --youtube-skip-dash-manifest Do not download the DASH manifests and related data on YouTube videos + (Same as --no-youtube-include-dash-manifest) + --youtube-include-dash-manifest Download the DASH manifests and related data + on YouTube videos (default) + (Same as --no-youtube-skip-dash-manifest) --youtube-skip-hls-manifest Do not download the HLS manifests and related data on YouTube videos + (Same as --no-youtube-include-hls-manifest) + --youtube-include-hls-manifest Download the HLS manifests and related data + on YouTube videos (default) + (Same as --no-youtube-skip-hls-manifest) --merge-output-format FORMAT If a merge is required (e.g. bestvideo+bestaudio), output to given container format. One of mkv, mp4, ogg, @@ -432,8 +466,11 @@ I will add some memorable short links to the binaries so you can download them e ## Subtitle Options: --write-sub Write subtitle file + --no-write-sub Do not write subtitle file (default) --write-auto-sub Write automatically generated subtitle file (YouTube only) + --no-write-auto-sub Do not write automatically generated + subtitle file (default) --all-subs Download all the available subtitles of the video --list-subs List all available subtitles for the video @@ -483,15 +520,19 @@ I will add some memorable short links to the binaries so you can download them e 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 + -k, --keep-video Keep the intermediate video file on disk + after post-processing + --no-keep-video Delete the intermediate video file after + post-processing (default) + --post-overwrites Overwrite post-processed files (default) + --no-post-overwrites Do not overwrite post-processed files --embed-subs Embed subtitles in the video (only for mp4, webm and mkv videos) + --no-embed-subs Do not embed subtitles in the video (default) --embed-thumbnail Embed thumbnail in the audio as cover art + --no-embed-thumbnail Do not embed thumbnail (default) --add-metadata Write metadata to the video file + --no-add-metadata Do not write metadata (default) --metadata-from-title FORMAT Parse additional metadata like song title / artist from the video title. The format syntax is the same as --output. Regular @@ -510,9 +551,10 @@ I will add some memorable short links to the binaries so you can download them e default; fix file if we can, warn otherwise) --prefer-avconv Prefer avconv over ffmpeg for running the - postprocessors + postprocessors (Same as --no-prefer-ffmpeg) --prefer-ffmpeg Prefer ffmpeg over avconv for running the postprocessors (default) + (Same as --no-prefer-avconv) --ffmpeg-location PATH Location of the ffmpeg/avconv binary; either the path to the binary or its containing directory. @@ -524,13 +566,18 @@ I will add some memorable short links to the binaries so you can download them e (currently supported: srt|ass|vtt|lrc) ## SponSkrub Options (SponsorBlock) - --sponskrub Use sponskrub to mark sponsored sections - with the data available in SponsorBlock API - (Youtube only) + --sponskrub Use sponskrub to mark sponsored sections with + the data available in SponsorBlock API. This + is enabled by default if the sponskrub binary + exists (Youtube only) --sponskrub-cut Cut out the sponsor sections instead of simply marking them - --sponskrub-force Run sponskrub even if the video was - already downloaded. Use with caution + --no-sponskrub-cut Simply mark the sponsor sections, not cut + them out (default) + --sponskrub-force Allow cutting out the sponsor sections even + if the video was already downloaded. + --no-sponskrub-force Do not cut out the sponsor sections if the + video was already downloaded (default) --sponskrub-location Location of the sponskrub binary; either the path to the binary or its containing directory @@ -538,6 +585,9 @@ I will add some memorable short links to the binaries so you can download them e ## 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) + (Same as --no-ignore-dynamic-mpd) # CONFIGURATION diff --git a/youtube_dlc/options.py b/youtube_dlc/options.py index 093b71a21..733eec8bd 100644 --- a/youtube_dlc/options.py +++ b/youtube_dlc/options.py @@ -142,13 +142,13 @@ def parseOpts(overrideArguments=None): action='store_true', dest='update_self', help='Update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)') general.add_option( - '-i', '--ignore-errors', + '-i', '--ignore-errors', '--no-abort-on-error', action='store_true', dest='ignoreerrors', default=False, help='Continue on download errors, for example to skip unavailable videos in a playlist') general.add_option( - '--abort-on-error', + '--abort-on-error', '--no-ignore-errors', action='store_false', dest='ignoreerrors', - help='Abort downloading of further videos (in the playlist or the command line) if an error occurs') + help='Abort downloading of further videos if an error occurs (default)') general.add_option( '--dump-user-agent', action='store_true', dest='dump_user_agent', default=False, @@ -168,31 +168,39 @@ def parseOpts(overrideArguments=None): general.add_option( '--default-search', dest='default_search', metavar='PREFIX', - help='Use this prefix for unqualified URLs. For example "gvsearch2:" downloads two videos from google videos for youtube-dlc "large apple". Use the value "auto" to let youtube-dlc 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( - '--ignore-config', + '--ignore-config', '--no-config', action='store_true', - help='Do not read configuration files. ' - 'When given in the global configuration file /etc/youtube-dlc.conf: ' - 'Do not read the user configuration in ~/.config/youtube-dlc/config ' - '(%APPDATA%/youtube-dlc/config.txt on Windows)') + help=( + '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)')) general.add_option( '--config-location', dest='config_location', metavar='PATH', help='Location of the configuration file; either the path to the config or its containing directory.') general.add_option( '--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.') general.add_option( + '--flat-videos', + action='store_true', dest='extract_flat', + help='Do not resolve the video urls') + general.add_option( + '--no-flat-playlist', + action='store_false', dest='extract_flat', + help='Extract the videos of a playlist') + general.add_option( '--mark-watched', action='store_true', dest='mark_watched', default=False, help='Mark videos watched (YouTube only)') general.add_option( '--no-mark-watched', action='store_false', dest='mark_watched', default=False, - help='Do not mark videos watched (YouTube only)') + help='Do not mark videos watched') general.add_option( '--no-color', '--no-colors', action='store_true', dest='no_color', @@ -203,10 +211,11 @@ def parseOpts(overrideArguments=None): network.add_option( '--proxy', dest='proxy', default=None, metavar='URL', - help='Use the specified HTTP/HTTPS/SOCKS proxy. To enable ' - 'SOCKS proxy, specify a proper scheme. For example ' - 'socks5://127.0.0.1:1080/. Pass in an empty string (--proxy "") ' - 'for direct connection') + help=( + 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable ' + 'SOCKS proxy, specify a proper scheme. For example ' + 'socks5://127.0.0.1:1080/. Pass in an empty string (--proxy "") ' + 'for direct connection')) network.add_option( '--socket-timeout', dest='socket_timeout', type=float, default=None, metavar='SECONDS', @@ -231,8 +240,9 @@ def parseOpts(overrideArguments=None): geo.add_option( '--geo-verification-proxy', dest='geo_verification_proxy', default=None, metavar='URL', - help='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.') + help=( + '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.')) geo.add_option( '--cn-verification-proxy', dest='cn_verification_proxy', default=None, metavar='URL', @@ -326,8 +336,11 @@ 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 <? 50 & description" .' - )) + '"like_count > 100 & dislike_count <? 50 & description" .')) + selection.add_option( + '--no-match-filter', + metavar='FILTER', dest='match_filter', action='store_const', const=None, + help='Do not use generic video filter (default)') selection.add_option( '--no-playlist', action='store_true', dest='noplaylist', default=False, @@ -349,9 +362,17 @@ def parseOpts(overrideArguments=None): action='store_true', dest='break_on_existing', default=False, help="Stop the download process after attempting to download a file that's in the archive.") selection.add_option( + '--no-download-archive', + dest='download_archive', action="store_const", const=None, + help='Do not use archive file (default)') + selection.add_option( '--include-ads', dest='include_ads', action='store_true', help='Download advertisements as well (experimental)') + selection.add_option( + '--no-include-ads', + dest='include_ads', action='store_false', + help='Do not download advertisements (default)') authentication = optparse.OptionGroup(parser, 'Authentication Options') authentication.add_option( @@ -448,23 +469,23 @@ def parseOpts(overrideArguments=None): action='store_true', dest='listformats_table', default=False, help='Present the output of -F in a more tabular form') video_format.add_option( - '--list-formats-old', + '--list-formats-old', '--no-list-formats-as-table', action='store_false', dest='listformats_table', - help=optparse.SUPPRESS_HELP) + help='Present the output of -F in the old form') video_format.add_option( - '--youtube-include-dash-manifest', + '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest', action='store_true', dest='youtube_include_dash_manifest', default=True, - help=optparse.SUPPRESS_HELP) + help='Download the DASH manifests and related data on YouTube videos (default)') video_format.add_option( - '--youtube-skip-dash-manifest', + '--youtube-skip-dash-manifest', '--no-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') video_format.add_option( - '--youtube-include-hls-manifest', + '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest', action='store_true', dest='youtube_include_hls_manifest', default=True, - help=optparse.SUPPRESS_HELP) + help='Download the HLS manifests and related data on YouTube videos (default)') video_format.add_option( - '--youtube-skip-hls-manifest', + '--youtube-skip-hls-manifest', '--no-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') video_format.add_option( @@ -477,14 +498,22 @@ def parseOpts(overrideArguments=None): subtitles = optparse.OptionGroup(parser, 'Subtitle Options') subtitles.add_option( - '--write-sub', '--write-srt', + '--write-subs', '--write-srt', action='store_true', dest='writesubtitles', default=False, help='Write subtitle file') subtitles.add_option( - '--write-auto-sub', '--write-automatic-sub', + '--no-write-subs', '--no-write-srt', + action='store_false', dest='writesubtitles', + help='Do not write subtitle file (default)') + subtitles.add_option( + '--write-auto-subs', '--write-automatic-subs', action='store_true', dest='writeautomaticsub', default=False, help='Write automatically generated subtitle file (YouTube only)') subtitles.add_option( + '--no-write-auto-subs', '--no-write-automatic-subs', + action='store_false', dest='writeautomaticsub', default=False, + help='Do not write automatically generated subtitle file (default)') + subtitles.add_option( '--all-subs', action='store_true', dest='allsubtitles', default=False, help='Download all the available subtitles of the video') @@ -516,30 +545,39 @@ def parseOpts(overrideArguments=None): dest='fragment_retries', metavar='RETRIES', default=10, help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)') downloader.add_option( - '--skip-unavailable-fragments', + '--skip-unavailable-fragments','--no-abort-on-unavailable-fragment', action='store_true', dest='skip_unavailable_fragments', default=True, - help='Skip unavailable fragments (DASH, hlsnative and ISM)') + help='Skip unavailable fragments for DASH, hlsnative and ISM (default)') downloader.add_option( - '--abort-on-unavailable-fragment', + '--abort-on-unavailable-fragment', '--no-skip-unavailable-fragments', action='store_false', dest='skip_unavailable_fragments', help='Abort downloading when some fragment is not available') downloader.add_option( '--keep-fragments', action='store_true', dest='keep_fragments', default=False, - help='Keep downloaded fragments on disk after downloading is finished; fragments are erased by default') + help='Keep downloaded fragments on disk after downloading is finished') + downloader.add_option( + '--no-keep-fragments', + action='store_false', dest='keep_fragments', + help='Delete downloaded fragments after downloading is finished (default)') downloader.add_option( '--buffer-size', dest='buffersize', metavar='SIZE', default='1024', help='Size of download buffer (e.g. 1024 or 16K) (default is %default)') downloader.add_option( + '--resize-buffer', + action='store_false', dest='noresizebuffer', + help='The buffer size is automatically resized from an initial value of --buffer-size (default)') + downloader.add_option( '--no-resize-buffer', action='store_true', dest='noresizebuffer', default=False, - help='Do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.') + help='Do not automatically adjust the buffer size') downloader.add_option( '--http-chunk-size', dest='http_chunk_size', metavar='SIZE', default=None, - help='Size of a chunk for chunk-based HTTP downloading (e.g. 10485760 or 10M) (default is disabled). ' - 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)') + help=( + 'Size of a chunk for chunk-based HTTP downloading (e.g. 10485760 or 10M) (default is disabled). ' + 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)')) downloader.add_option( '--test', action='store_true', dest='test', default=False, @@ -549,6 +587,10 @@ def parseOpts(overrideArguments=None): action='store_true', help='Download playlist videos in reverse order') downloader.add_option( + '--no-playlist-reverse', + action='store_false', dest='playlist_reverse', + help='Download playlist videos in default order (default)') + downloader.add_option( '--playlist-random', action='store_true', help='Download playlist videos in random order') @@ -567,13 +609,15 @@ def parseOpts(overrideArguments=None): downloader.add_option( '--hls-use-mpegts', dest='hls_use_mpegts', action='store_true', - help='Use the mpegts container for HLS videos, allowing to play the ' - 'video while downloading (some players may not be able to play it)') + help=( + 'Use the mpegts container for HLS videos, allowing to play the ' + 'video while downloading (some players may not be able to play it)')) downloader.add_option( '--external-downloader', dest='external_downloader', metavar='COMMAND', - help='Use the specified external downloader. ' - 'Currently supports %s' % ','.join(list_external_downloaders())) + help=( + 'Use the specified external downloader. ' + 'Currently supports %s' % ','.join(list_external_downloaders()) )) downloader.add_option( '--external-downloader-args', dest='external_downloader_args', metavar='ARGS', @@ -589,8 +633,8 @@ def parseOpts(overrideArguments=None): action='store_true', dest='no_check_certificate', default=False, help='Suppress HTTPS certificate validation') workarounds.add_option( - '--prefer-insecure', - '--prefer-unsecure', action='store_true', dest='prefer_insecure', + '--prefer-insecure', '--prefer-unsecure', + action='store_true', dest='prefer_insecure', help='Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)') workarounds.add_option( '--user-agent', @@ -644,7 +688,7 @@ def parseOpts(overrideArguments=None): action='store_true', dest='simulate', default=False, help='Do not download the video and do not write anything to disk') verbosity.add_option( - '--skip-download', + '--skip-download', '--no-download', action='store_true', dest='skip_download', default=False, help='Do not download the video') verbosity.add_option( @@ -686,7 +730,9 @@ def parseOpts(overrideArguments=None): verbosity.add_option( '-J', '--dump-single-json', action='store_true', dest='dump_single_json', default=False, - help='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.') + help=( + '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.')) verbosity.add_option( '--print-json', action='store_true', dest='print_json', default=False, @@ -735,8 +781,8 @@ def parseOpts(overrideArguments=None): help='Contact the youtube-dlc server for debugging') verbosity.add_option( '--no-call-home', - dest='call_home', action='store_false', default=False, - help='Do NOT contact the youtube-dlc server for debugging') + dest='call_home', action='store_false', + help='Do not contact the youtube-dlc server for debugging (default)') filesystem = optparse.OptionGroup(parser, 'Filesystem Options') filesystem.add_option( @@ -746,11 +792,11 @@ def parseOpts(overrideArguments=None): "Lines starting with '#', ';' or ']' are considered as comments and ignored.") filesystem.add_option( '--id', default=False, - action='store_true', dest='useid', help='Use only video ID in file name') + action='store_true', dest='useid', help=optparse.SUPPRESS_HELP) filesystem.add_option( '-o', '--output', dest='outtmpl', metavar='TEMPLATE', - help=('Output filename template, see the "OUTPUT TEMPLATE" for all the info')) + help='Output filename template, see the "OUTPUT TEMPLATE" for details') filesystem.add_option( '--autonumber-size', dest='autonumber_size', metavar='NUMBER', type=int, @@ -764,6 +810,10 @@ def parseOpts(overrideArguments=None): action='store_true', dest='restrictfilenames', default=False, help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames') filesystem.add_option( + '--no-restrict-filenames', + action='store_false', dest='restrictfilenames', default=False, + help='Allow Unicode characters, "&" and spaces in filenames (default)') + filesystem.add_option( '-A', '--auto-number', action='store_true', dest='autonumber', default=False, help=optparse.SUPPRESS_HELP) @@ -782,32 +832,52 @@ def parseOpts(overrideArguments=None): filesystem.add_option( '-c', '--continue', action='store_true', dest='continue_dl', default=True, - help='Force resume of partially downloaded files. By default, youtube-dlc will resume downloads if possible.') + help='Resume partially downloaded files (default)') filesystem.add_option( '--no-continue', action='store_false', dest='continue_dl', - help='Do not resume partially downloaded files (restart from beginning)') + help='Restart download of partially downloaded files from beginning') + filesystem.add_option( + '--part', + action='store_false', dest='nopart', default=False, + help='Use .part files instead of writing directly into output file (default)') filesystem.add_option( '--no-part', - action='store_true', dest='nopart', default=False, + action='store_true', dest='nopart', help='Do not use .part files - write directly into output file') filesystem.add_option( + '--mtime', + action='store_true', dest='updatetime', default=True, + help='Use the Last-modified header to set the file modification time (default)') + filesystem.add_option( '--no-mtime', - action='store_false', dest='updatetime', default=True, + action='store_false', dest='updatetime', help='Do not use the Last-modified header to set the file modification time') filesystem.add_option( '--write-description', action='store_true', dest='writedescription', default=False, help='Write video description to a .description file') filesystem.add_option( + '--no-write-description', + action='store_false', dest='writedescription', + help='Do not write video description (default)') + filesystem.add_option( '--write-info-json', action='store_true', dest='writeinfojson', default=False, help='Write video metadata to a .info.json file') filesystem.add_option( + '--no-write-info-json', + action='store_false', dest='writeinfojson', + help='Do not write video metadata (default)') + filesystem.add_option( '--write-annotations', action='store_true', dest='writeannotations', default=False, help='Write video annotations to a .annotations.xml file') filesystem.add_option( + '--no-write-annotations', + action='store_false', dest='writeannotations', + help='Do not write video annotations (default)') + filesystem.add_option( '--load-info-json', '--load-info', dest='load_info_filename', metavar='FILE', help='JSON file containing the video information (created with the "--write-info-json" option)') @@ -816,10 +886,14 @@ def parseOpts(overrideArguments=None): dest='cookiefile', metavar='FILE', help='File to read cookies from and dump cookie jar in') filesystem.add_option( + '--no-cookies', + action='store_const', const=None, dest='cookiefile', metavar='FILE', + help='Do not read/dump cookies (default)') + filesystem.add_option( '--cache-dir', dest='cachedir', default=None, metavar='DIR', - help='Location in the filesystem where youtube-dlc can store some downloaded information permanently. By default $XDG_CACHE_HOME/youtube-dlc or ~/.cache/youtube-dlc . 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( - '--no-cache-dir', action='store_const', const=False, dest='cachedir', + '--no-cache-dir', action='store_false', dest='cachedir', help='Disable filesystem caching') filesystem.add_option( '--rm-cache-dir', @@ -829,12 +903,16 @@ def parseOpts(overrideArguments=None): '--trim-file-name', dest='trim_file_name', default=0, type=int, help='Limit the filename length (extension excluded)') - thumbnail = optparse.OptionGroup(parser, 'Thumbnail images') + thumbnail = optparse.OptionGroup(parser, 'Thumbnail Images') thumbnail.add_option( '--write-thumbnail', action='store_true', dest='writethumbnail', default=False, help='Write thumbnail image to disk') thumbnail.add_option( + '--no-write-thumbnail', + action='store_false', dest='writethumbnail', + help='Do not write thumbnail image to disk (default)') + thumbnail.add_option( '--write-all-thumbnails', action='store_true', dest='write_all_thumbnails', default=False, help='Write all thumbnail image formats to disk') @@ -876,11 +954,13 @@ def parseOpts(overrideArguments=None): postproc.add_option( '--remux-video', metavar='FORMAT', dest='remuxvideo', default=None, - help='Remux the video to another container format if necessary (currently supported: mp4|mkv, target container format must support video / audio encoding, remuxing may fail)') + help=( + 'Remux the video into another container if necessary (currently supported: mp4|mkv). ' + 'If target container does not support the video/audio codec, remuxing will fail')) postproc.add_option( '--recode-video', metavar='FORMAT', dest='recodevideo', default=None, - help='Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm|mkv|avi)') + help='Re-encode the video into another format if re-encoding is necessary (currently supported: mp4|flv|ogg|webm|mkv|avi)') postproc.add_option( '--postprocessor-args', dest='postprocessor_args', metavar='ARGS', @@ -888,33 +968,54 @@ def parseOpts(overrideArguments=None): postproc.add_option( '-k', '--keep-video', action='store_true', dest='keepvideo', default=False, - help='Keep the video file on disk after the post-processing; the video is erased by default') + help='Keep the intermediate video file on disk after post-processing') + postproc.add_option( + '--no-keep-video', + action='store_false', dest='keepvideo', + help='Delete the intermediate video file after post-processing (default)') + postproc.add_option( + '--post-overwrites', + action='store_false', dest='nopostoverwrites', + help='Overwrite post-processed files (default)') postproc.add_option( '--no-post-overwrites', action='store_true', dest='nopostoverwrites', default=False, - help='Do not overwrite post-processed files; the post-processed files are overwritten by default') + help='Do not overwrite post-processed files') postproc.add_option( '--embed-subs', action='store_true', dest='embedsubtitles', default=False, help='Embed subtitles in the video (only for mp4, webm and mkv videos)') postproc.add_option( + '--no-embed-subs', + action='store_false', dest='embedsubtitles', + help='Do not embed subtitles (default)') + postproc.add_option( '--embed-thumbnail', action='store_true', dest='embedthumbnail', default=False, help='Embed thumbnail in the audio as cover art') postproc.add_option( + '--no-embed-thumbnail', + action='store_false', dest='embedthumbnail', + help='Do not embed thumbnail (default)') + postproc.add_option( '--add-metadata', action='store_true', dest='addmetadata', default=False, help='Write metadata to the video file') postproc.add_option( + '--no-add-metadata', + action='store_false', dest='addmetadata', + help='Do not write metadata (default)') + postproc.add_option( '--metadata-from-title', metavar='FORMAT', dest='metafromtitle', - help='Parse additional metadata like song title / artist from the video title. ' - 'The format syntax is the same as --output. Regular expression with ' - 'named capture groups may also be used. ' - 'The parsed parameters replace existing values. ' - 'Example: --metadata-from-title "%(artist)s - %(title)s" matches a title like ' - '"Coldplay - Paradise". ' - 'Example (regex): --metadata-from-title "(?P<artist>.+?) - (?P<title>.+)"') + help=( + 'Parse additional metadata like song title / artist from the video title. ' + 'The format syntax is the same as --output. Regular expression with ' + 'named capture groups may also be used. ' + 'The parsed parameters replace existing values. ' + 'Example: --metadata-from-title "%(artist)s - %(title)s" matches a title like ' + '"Coldplay - Paradise". ' + 'Example (regex): --metadata-from-title "(?P<artist>.+?) - (?P<title>.+)"')) postproc.add_option( '--xattrs', action='store_true', dest='xattrs', default=False, @@ -922,15 +1023,16 @@ def parseOpts(overrideArguments=None): postproc.add_option( '--fixup', metavar='POLICY', dest='fixup', default='detect_or_warn', - help='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)') + help=( + '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)')) postproc.add_option( - '--prefer-avconv', + '--prefer-avconv', '--no-prefer-ffmpeg', action='store_false', dest='prefer_ffmpeg', help='Prefer avconv over ffmpeg for running the postprocessors') postproc.add_option( - '--prefer-ffmpeg', + '--prefer-ffmpeg', '--no-prefer-avconv', action='store_true', dest='prefer_ffmpeg', help='Prefer ffmpeg over avconv for running the postprocessors (default)') postproc.add_option( @@ -950,20 +1052,30 @@ def parseOpts(overrideArguments=None): extractor.add_option( '--sponskrub', action='store_true', dest='sponskrub', default=None, - help='Use sponskrub to mark sponsored sections with the data available in SponsorBlock API (Youtube only)') + help=( + 'Use sponskrub to mark sponsored sections with the data available in SponsorBlock API. ' + 'This is enabled by default if the sponskrub binary exists (Youtube only)')) extractor.add_option( '--no-sponskrub', action='store_false', dest='sponskrub', - help=optparse.SUPPRESS_HELP) + help='Do not use sponskrub') extractor.add_option( '--sponskrub-cut', default=False, action='store_true', dest='sponskrub_cut', help='Cut out the sponsor sections instead of simply marking them') extractor.add_option( + '--no-sponskrub-cut', + action='store_false', dest='sponskrub_cut', + help='Simply mark the sponsor sections, not cut them out (default)') + extractor.add_option( '--sponskrub-force', default=False, action='store_true', dest='sponskrub_force', help='Run sponskrub even if the video was already downloaded') extractor.add_option( + '--no-sponskrub-force', + action='store_true', dest='sponskrub_force', + help='Do not cut out the sponsor sections if the video was already downloaded (default)') + extractor.add_option( '--sponskrub-location', metavar='PATH', dest='sponskrub_path', default='', help='Location of the sponskrub binary; either the path to the binary or its containing directory.') @@ -973,11 +1085,11 @@ def parseOpts(overrideArguments=None): extractor = optparse.OptionGroup(parser, 'Extractor Options') extractor.add_option( - '--allow-dynamic-mpd', + '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd', action='store_true', dest='dynamic_mpd', default=True, - help=optparse.SUPPRESS_HELP) + help='Process dynamic DASH manifests (default)') extractor.add_option( - '--ignore-dynamic-mpd', + '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd', action='store_false', dest='dynamic_mpd', help='Do not process dynamic DASH manifests') |