mirrors/yt-dlp
1
0
Fork 0
mirror of https://github.com/yt-dlp/yt-dlp.git synced 2024-11-27 10:31:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

[doc, cleanup] Re-indent "Usage and Options" section

Browse source
This commit is contained in:
pukkandan 2022-05-19 20:05:17 +05:30
parent 23326151c4
commit 2dd5a2e3a1
No known key found for this signature in database
GPG key ID: 7EEE9E1E817D0A39
2 changed files with 750 additions and 755 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1439
README.md
View file

File diff suppressed because it is too large Load diff

66
yt_dlp/options.py
View file

@ -134,10 +134,8 @@ class _YoutubeDLHelpFormatter(optparse.IndentedHelpFormatter):
def __init__(self): def __init__(self):
# No need to wrap help messages if we're on a wide console # No need to wrap help messages if we're on a wide console
max_width = compat_get_terminal_size().columns or 80 max_width = compat_get_terminal_size().columns or 80
# 47% is chosen because that is how README.md is currently formatted # The % is chosen to get a pretty output in README.md
# and moving help text even further to the right is undesirable. super().__init__(width=max_width, max_help_position=int(0.45 * max_width))
# This can be reduced in the future to get a prettier output
super().__init__(width=max_width, max_help_position=int(0.47 * max_width))
@staticmethod @staticmethod
def format_option_strings(option): def format_option_strings(option):
@ -345,7 +343,12 @@ def _alias_callback(option, opt_str, value, parser, opts, nargs):
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 the search term "large apple". Use the value "auto" to let yt-dlp 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. '
'Eg: "gvsearch2:python" downloads two videos from google videos for the search term "python". '
'Use the value "auto" to let yt-dlp 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', dest='ignoreconfig', action='store_true', dest='ignoreconfig',
@ -439,10 +442,8 @@ def _alias_callback(option, opt_str, value, parser, opts, nargs):
'--proxy', dest='proxy', '--proxy', dest='proxy',
default=None, metavar='URL', default=None, metavar='URL',
help=( help=(
'Use the specified HTTP/HTTPS/SOCKS proxy. To enable ' 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable SOCKS proxy, specify a proper scheme. '
'SOCKS proxy, specify a proper scheme. For example ' 'Eg: socks5://user:pass@127.0.0.1:1080/. Pass in an empty string (--proxy "") for direct connection'))
'socks5://user:pass@127.0.0.1:1080/. Pass in an empty string (--proxy "") '
'for direct connection'))
network.add_option( network.add_option(
'--socket-timeout', '--socket-timeout',
dest='socket_timeout', type=float, default=None, metavar='SECONDS', dest='socket_timeout', type=float, default=None, metavar='SECONDS',
@ -550,7 +551,7 @@ def _alias_callback(option, opt_str, value, parser, opts, nargs):
'--match-filters', '--match-filters',
metavar='FILTER', dest='match_filter', action='append', metavar='FILTER', dest='match_filter', action='append',
help=( help=(
'Generic video filter. Any field (see "OUTPUT TEMPLATE") can be compared with a ' 'Generic video filter. Any "OUTPUT TEMPLATE" field can be compared with a '
'number or a string using the operators defined in "Filtering formats". ' 'number or a string using the operators defined in "Filtering formats". '
'You can also simply specify a field to match if the field is present, ' 'You can also simply specify a field to match if the field is present, '
'use "!field" to check if the field is not present, and "&" to check multiple conditions. ' 'use "!field" to check if the field is not present, and "&" to check multiple conditions. '
@ -559,7 +560,7 @@ def _alias_callback(option, opt_str, value, parser, opts, nargs):
'!is_live --match-filter "like_count>?100 & description~=\'(?i)\\bcats \\& dogs\\b\'" ' '!is_live --match-filter "like_count>?100 & description~=\'(?i)\\bcats \\& dogs\\b\'" '
'matches only videos that are not live OR those that have a like count more than 100 ' 'matches only videos that are not live OR those that have a like count more than 100 '
'(or the like field is not available) and also has a description ' '(or the like field is not available) and also has a description '
'that contains the phrase "cats & dogs" (ignoring case). ' 'that contains the phrase "cats & dogs" (caseless). '
'Use "--match-filter -" to interactively ask whether to download each video')) 'Use "--match-filter -" to interactively ask whether to download each video'))
selection.add_option( selection.add_option(
'--no-match-filter', '--no-match-filter',
@ -671,7 +672,7 @@ def _alias_callback(option, opt_str, value, parser, opts, nargs):
'--client-certificate-password', '--client-certificate-password',
dest='client_certificate_password', metavar='PASSWORD', dest='client_certificate_password', metavar='PASSWORD',
help='Password for client certificate private key, if encrypted. ' help='Password for client certificate private key, if encrypted. '
'If not provided and the key is encrypted, yt-dlp will ask interactively') 'If not provided, and the key is encrypted, yt-dlp will ask interactively')
video_format = optparse.OptionGroup(parser, 'Video Format Options') video_format = optparse.OptionGroup(parser, 'Video Format Options')
video_format.add_option( video_format.add_option(
@ -688,13 +689,11 @@ def _alias_callback(option, opt_str, value, parser, opts, nargs):
action='store_true', dest='format_sort_force', metavar='FORMAT', default=False, action='store_true', dest='format_sort_force', metavar='FORMAT', default=False,
help=( help=(
'Force user specified sort order to have precedence over all fields, ' 'Force user specified sort order to have precedence over all fields, '
'see "Sorting Formats" for more details')) 'see "Sorting Formats" for more details (Alias: --S-force)'))
video_format.add_option( video_format.add_option(
'--no-format-sort-force', '--no-format-sort-force',
action='store_false', dest='format_sort_force', metavar='FORMAT', default=False, action='store_false', dest='format_sort_force', metavar='FORMAT', default=False,
help=( help='Some fields have precedence over the user specified sort order (default)')
'Some fields have precedence over the user specified sort order (default), '
'see "Sorting Formats" for more details'))
video_format.add_option( video_format.add_option(
'--video-multistreams', '--video-multistreams',
action='store_true', dest='allow_multiple_video_streams', default=None, action='store_true', dest='allow_multiple_video_streams', default=None,
@ -793,14 +792,14 @@ def _alias_callback(option, opt_str, value, parser, opts, nargs):
subtitles.add_option( subtitles.add_option(
'--sub-format', '--sub-format',
action='store', dest='subtitlesformat', metavar='FORMAT', default='best', action='store', dest='subtitlesformat', metavar='FORMAT', default='best',
help='Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"') help='Subtitle format; accepts formats preference, Eg: "srt" or "ass/srt/best"')
subtitles.add_option( subtitles.add_option(
'--sub-langs', '--srt-langs', '--sub-langs', '--srt-langs',
action='callback', dest='subtitleslangs', metavar='LANGS', type='str', action='callback', dest='subtitleslangs', metavar='LANGS', type='str',
default=[], callback=_list_from_options_callback, default=[], callback=_list_from_options_callback,
help=( help=(
'Languages of the subtitles to download (can be regex) or "all" separated by commas. (Eg: --sub-langs "en.*,ja") ' 'Languages of the subtitles to download (can be regex) or "all" separated by commas. (Eg: --sub-langs "en.*,ja") '
'You can prefix the language code with a "-" to exempt it from the requested languages. (Eg: --sub-langs all,-live_chat) ' 'You can prefix the language code with a "-" to exclude it from the requested languages. (Eg: --sub-langs all,-live_chat) '
'Use --list-subs for a list of available language tags')) 'Use --list-subs for a list of available language tags'))
downloader = optparse.OptionGroup(parser, 'Download Options') downloader = optparse.OptionGroup(parser, 'Download Options')
@ -837,17 +836,18 @@ def _alias_callback(option, opt_str, value, parser, opts, nargs):
'default_key': 'http', 'default_key': 'http',
}, help=( }, help=(
'An expression for the time to sleep between retries in seconds (optionally) prefixed ' 'An expression for the time to sleep between retries in seconds (optionally) prefixed '
'by the type of retry (http (default), fragment, file_access) to apply the sleep to. ' 'by the type of retry (file_access, fragment, http (default)) to apply the sleep to. '
'EXPR can be a number, or of the forms linear=START[:END[:STEP=1]] or exp=START[:END[:BASE=2]]. ' 'EXPR can be a number, linear=START[:END[:STEP=1]] or exp=START[:END[:BASE=2]]. '
'This option can be used multiple times to set the sleep for the different retry types. '
'Eg: --retry-sleep linear=1::2 --retry-sleep fragment:exp=1:20')) 'Eg: --retry-sleep linear=1::2 --retry-sleep fragment:exp=1:20'))
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) (Alias: --no-abort-on-unavailable-fragment)') help='Skip unavailable fragments for DASH, hlsnative and ISM downloads (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 if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)') help='Abort download 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,
@ -1213,7 +1213,7 @@ def _alias_callback(option, opt_str, value, parser, opts, nargs):
filesystem.add_option( filesystem.add_option(
'--output-na-placeholder', '--output-na-placeholder',
dest='outtmpl_na_placeholder', metavar='TEXT', default='NA', dest='outtmpl_na_placeholder', metavar='TEXT', default='NA',
help=('Placeholder value for unavailable meta fields in output filename template (default: "%default")')) help=('Placeholder for unavailable fields in "OUTPUT TEMPLATE" (default: "%default")'))
filesystem.add_option( filesystem.add_option(
'--autonumber-size', '--autonumber-size',
dest='autonumber_size', metavar='NUMBER', type=int, dest='autonumber_size', metavar='NUMBER', type=int,
@ -1436,9 +1436,7 @@ def _alias_callback(option, opt_str, value, parser, opts, nargs):
postproc.add_option( postproc.add_option(
'--recode-video', '--recode-video',
metavar='FORMAT', dest='recodevideo', default=None, metavar='FORMAT', dest='recodevideo', default=None,
help=( help='Re-encode the video into another format if necessary. The syntax and supported formats are the same as --remux-video')
'Re-encode the video into another format if re-encoding is necessary. '
'The syntax and supported formats are the same as --remux-video'))
postproc.add_option( postproc.add_option(
'--postprocessor-args', '--ppa', '--postprocessor-args', '--ppa',
metavar='NAME:ARGS', dest='postprocessor_args', default={}, type='str', metavar='NAME:ARGS', dest='postprocessor_args', default={}, type='str',
@ -1635,9 +1633,9 @@ def _alias_callback(option, opt_str, value, parser, opts, nargs):
'--force-keyframes-at-cuts', '--force-keyframes-at-cuts',
action='store_true', dest='force_keyframes_at_cuts', default=False, action='store_true', dest='force_keyframes_at_cuts', default=False,
help=( help=(
'Force keyframes around the chapters before removing/splitting them. ' 'Force keyframes around chapters when removing/splitting them. '
'Requires a re-encode and thus is very slow, but the resulting video ' 'The resulting video may have fewer artifacts around the cuts, '
'may have fewer artifacts around the cuts')) 'but is very slow due to needing a re-encode'))
postproc.add_option( postproc.add_option(
'--no-force-keyframes-at-cuts', '--no-force-keyframes-at-cuts',
action='store_false', dest='force_keyframes_at_cuts', action='store_false', dest='force_keyframes_at_cuts',
@ -1675,8 +1673,8 @@ def _alias_callback(option, opt_str, value, parser, opts, nargs):
'aliases': {'default': ['all']} 'aliases': {'default': ['all']}
}, help=( }, help=(
'SponsorBlock categories to create chapters for, separated by commas. ' 'SponsorBlock categories to create chapters for, separated by commas. '
f'Available categories are all, default(=all), {", ".join(SponsorBlockPP.CATEGORIES.keys())}. ' f'Available categories are {", ".join(SponsorBlockPP.CATEGORIES.keys())}, all and default (=all). '
'You can prefix the category with a "-" to exempt it. See [1] for description of the categories. ' 'You can prefix the category with a "-" to exclude it. See [1] for description of the categories. '
'Eg: --sponsorblock-mark all,-preview [1] https://wiki.sponsor.ajay.app/w/Segment_Categories')) 'Eg: --sponsorblock-mark all,-preview [1] https://wiki.sponsor.ajay.app/w/Segment_Categories'))
sponsorblock.add_option( sponsorblock.add_option(
'--sponsorblock-remove', metavar='CATS', '--sponsorblock-remove', metavar='CATS',
@ -1697,9 +1695,9 @@ def _alias_callback(option, opt_str, value, parser, opts, nargs):
'--sponsorblock-chapter-title', metavar='TEMPLATE', '--sponsorblock-chapter-title', metavar='TEMPLATE',
default=DEFAULT_SPONSORBLOCK_CHAPTER_TITLE, dest='sponsorblock_chapter_title', default=DEFAULT_SPONSORBLOCK_CHAPTER_TITLE, dest='sponsorblock_chapter_title',
help=( help=(
'The title template for SponsorBlock chapters created by --sponsorblock-mark. ' 'An output template for the title of the SponsorBlock chapters created by --sponsorblock-mark. '
'The same syntax as the output template is used, but the only available fields are ' 'The only available fields are start_time, end_time, category, categories, name, category_names. '
'start_time, end_time, category, categories, name, category_names. Defaults to "%default"')) 'Defaults to "%default"'))
sponsorblock.add_option( sponsorblock.add_option(
'--no-sponsorblock', default=False, '--no-sponsorblock', default=False,
action='store_true', dest='no_sponsorblock', action='store_true', dest='no_sponsorblock',