youtube_dlc/options.py

   1 from __future__ import unicode_literals
   2
   3 import os.path
   4 import optparse
   5 import re
   6 import sys
   7
   8 from .downloader.external import list_external_downloaders
   9 from .compat import (
  10     compat_expanduser,
  11     compat_get_terminal_size,
  12     compat_getenv,
  13     compat_kwargs,
  14     compat_shlex_split,
  15 )
  16 from .utils import (
  17     expand_path,
  18     get_executable_path,
  19     preferredencoding,
  20     write_string,
  21 )
  22 from .version import __version__
  23
  24
  25 def _hide_login_info(opts):
  26     PRIVATE_OPTS = set(['-p', '--password', '-u', '--username', '--video-password', '--ap-password', '--ap-username'])
  27     eqre = re.compile('^(?P<key>' + ('|'.join(re.escape(po) for po in PRIVATE_OPTS)) + ')=.+$')
  28
  29     def _scrub_eq(o):
  30         m = eqre.match(o)
  31         if m:
  32             return m.group('key') + '=PRIVATE'
  33         else:
  34             return o
  35
  36     opts = list(map(_scrub_eq, opts))
  37     for idx, opt in enumerate(opts):
  38         if opt in PRIVATE_OPTS and idx + 1 < len(opts):
  39             opts[idx + 1] = 'PRIVATE'
  40     return opts
  41
  42
  43 def parseOpts(overrideArguments=None):
  44     def _readOptions(filename_bytes, default=[]):
  45         try:
  46             optionf = open(filename_bytes)
  47         except IOError:
  48             return default  # silently skip if file is not present
  49         try:
  50             # FIXME: https://github.com/ytdl-org/youtube-dl/commit/dfe5fa49aed02cf36ba9f743b11b0903554b5e56
  51             contents = optionf.read()
  52             if sys.version_info < (3,):
  53                 contents = contents.decode(preferredencoding())
  54             res = compat_shlex_split(contents, comments=True)
  55         finally:
  56             optionf.close()
  57         return res
  58
  59     def _readUserConf(package_name, default=[]):
  60         # .config
  61         xdg_config_home = compat_getenv('XDG_CONFIG_HOME') or compat_expanduser('~/.config')
  62         userConfFile = os.path.join(xdg_config_home, package_name, 'config')
  63         if not os.path.isfile(userConfFile):
  64             userConfFile = os.path.join(xdg_config_home, '%s.conf' % package_name)
  65         userConf = _readOptions(userConfFile, default=None)
  66         if userConf is not None:
  67             return userConf, userConfFile
  68
  69         # appdata
  70         appdata_dir = compat_getenv('appdata')
  71         if appdata_dir:
  72             userConfFile = os.path.join(appdata_dir, package_name, 'config')
  73             userConf = _readOptions(userConfFile, default=None)
  74             if userConf is None:
  75                 userConfFile += '.txt'
  76                 userConf = _readOptions(userConfFile, default=None)
  77         if userConf is not None:
  78             return userConf, userConfFile
  79
  80         # home
  81         userConfFile = os.path.join(compat_expanduser('~'), '%s.conf' % package_name)
  82         userConf = _readOptions(userConfFile, default=None)
  83         if userConf is None:
  84             userConfFile += '.txt'
  85             userConf = _readOptions(userConfFile, default=None)
  86         if userConf is not None:
  87             return userConf, userConfFile
  88
  89         return default, None
  90
  91     def _format_option_string(option):
  92         ''' ('-o', '--option') -> -o, --format METAVAR'''
  93
  94         opts = []
  95
  96         if option._short_opts:
  97             opts.append(option._short_opts[0])
  98         if option._long_opts:
  99             opts.append(option._long_opts[0])
 100         if len(opts) > 1:
 101             opts.insert(1, ', ')
 102
 103         if option.takes_value():
 104             opts.append(' %s' % option.metavar)
 105
 106         return ''.join(opts)
 107
 108     def _comma_separated_values_options_callback(option, opt_str, value, parser):
 109         setattr(parser.values, option.dest, value.split(','))
 110
 111     def _dict_from_multiple_values_options_callback(
 112             option, opt_str, value, parser, allowed_keys=r'[\w-]+', delimiter=':', default_key=None, process=None):
 113
 114         out_dict = getattr(parser.values, option.dest)
 115         mobj = re.match(r'(?i)(?P<key>%s)%s(?P<val>.*)$' % (allowed_keys, delimiter), value)
 116         if mobj is not None:
 117             key, val = mobj.group('key').lower(), mobj.group('val')
 118         elif default_key is not None:
 119             key, val = default_key, value
 120         else:
 121             raise optparse.OptionValueError(
 122                 'wrong %s formatting; it should be %s, not "%s"' % (opt_str, option.metavar, value))
 123         out_dict[key] = process(val) if callable(process) else val
 124
 125     # No need to wrap help messages if we're on a wide console
 126     columns = compat_get_terminal_size().columns
 127     max_width = columns if columns else 80
 128     max_help_position = 80
 129
 130     fmt = optparse.IndentedHelpFormatter(width=max_width, max_help_position=max_help_position)
 131     fmt.format_option_strings = _format_option_string
 132
 133     kw = {
 134         'version': __version__,
 135         'formatter': fmt,
 136         'usage': '%prog [OPTIONS] URL [URL...]',
 137         'conflict_handler': 'resolve',
 138     }
 139
 140     parser = optparse.OptionParser(**compat_kwargs(kw))
 141
 142     general = optparse.OptionGroup(parser, 'General Options')
 143     general.add_option(
 144         '-h', '--help',
 145         action='help',
 146         help='Print this help text and exit')
 147     general.add_option(
 148         '--version',
 149         action='version',
 150         help='Print program version and exit')
 151     general.add_option(
 152         '-U', '--update',
 153         action='store_true', dest='update_self',
 154         help='[BROKEN] Update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
 155     general.add_option(
 156         '-i', '--ignore-errors', '--no-abort-on-error',
 157         action='store_true', dest='ignoreerrors', default=True,
 158         help='Continue on download errors, for example to skip unavailable videos in a playlist (default) (Alias: --no-abort-on-error)')
 159     general.add_option(
 160         '--abort-on-error', '--no-ignore-errors',
 161         action='store_false', dest='ignoreerrors',
 162         help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)')
 163     general.add_option(
 164         '--dump-user-agent',
 165         action='store_true', dest='dump_user_agent', default=False,
 166         help='Display the current browser identification')
 167     general.add_option(
 168         '--list-extractors',
 169         action='store_true', dest='list_extractors', default=False,
 170         help='List all supported extractors')
 171     general.add_option(
 172         '--extractor-descriptions',
 173         action='store_true', dest='list_extractor_descriptions', default=False,
 174         help='Output descriptions of all supported extractors')
 175     general.add_option(
 176         '--force-generic-extractor',
 177         action='store_true', dest='force_generic_extractor', default=False,
 178         help='Force extraction to use the generic extractor')
 179     general.add_option(
 180         '--default-search',
 181         dest='default_search', metavar='PREFIX',
 182         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')
 183     general.add_option(
 184         '--ignore-config', '--no-config',
 185         action='store_true',
 186         help=(
 187             'Disable loading any configuration files except the one provided by --config-location. '
 188             'When given inside a configuration file, no further configuration files are loaded. '
 189             'Additionally, (for backward compatibility) if this option is found inside the '
 190             'system configuration file, the user configuration is not loaded'))
 191     general.add_option(
 192         '--config-location',
 193         dest='config_location', metavar='PATH',
 194         help='Location of the main configuration file; either the path to the config or its containing directory')
 195     general.add_option(
 196         '--flat-playlist',
 197         action='store_const', dest='extract_flat', const='in_playlist', default=False,
 198         help='Do not extract the videos of a playlist, only list them')
 199     general.add_option(
 200         '--flat-videos',
 201         action='store_true', dest='extract_flat',
 202         help='Do not resolve the video urls')
 203     general.add_option(
 204         '--no-flat-playlist',
 205         action='store_false', dest='extract_flat',
 206         help='Extract the videos of a playlist')
 207     general.add_option(
 208         '--mark-watched',
 209         action='store_true', dest='mark_watched', default=False,
 210         help='Mark videos watched (YouTube only)')
 211     general.add_option(
 212         '--no-mark-watched',
 213         action='store_false', dest='mark_watched', default=False,
 214         help='Do not mark videos watched')
 215     general.add_option(
 216         '--no-colors',
 217         action='store_true', dest='no_color',
 218         default=False,
 219         help='Do not emit color codes in output')
 220
 221     network = optparse.OptionGroup(parser, 'Network Options')
 222     network.add_option(
 223         '--proxy', dest='proxy',
 224         default=None, metavar='URL',
 225         help=(
 226             'Use the specified HTTP/HTTPS/SOCKS proxy. To enable '
 227             'SOCKS proxy, specify a proper scheme. For example '
 228             'socks5://127.0.0.1:1080/. Pass in an empty string (--proxy "") '
 229             'for direct connection'))
 230     network.add_option(
 231         '--socket-timeout',
 232         dest='socket_timeout', type=float, default=None, metavar='SECONDS',
 233         help='Time to wait before giving up, in seconds')
 234     network.add_option(
 235         '--source-address',
 236         metavar='IP', dest='source_address', default=None,
 237         help='Client-side IP address to bind to',
 238     )
 239     network.add_option(
 240         '-4', '--force-ipv4',
 241         action='store_const', const='0.0.0.0', dest='source_address',
 242         help='Make all connections via IPv4',
 243     )
 244     network.add_option(
 245         '-6', '--force-ipv6',
 246         action='store_const', const='::', dest='source_address',
 247         help='Make all connections via IPv6',
 248     )
 249
 250     geo = optparse.OptionGroup(parser, 'Geo Restriction')
 251     geo.add_option(
 252         '--geo-verification-proxy',
 253         dest='geo_verification_proxy', default=None, metavar='URL',
 254         help=(
 255             'Use this proxy to verify the IP address for some geo-restricted sites. '
 256             'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
 257     geo.add_option(
 258         '--cn-verification-proxy',
 259         dest='cn_verification_proxy', default=None, metavar='URL',
 260         help=optparse.SUPPRESS_HELP)
 261     geo.add_option(
 262         '--geo-bypass',
 263         action='store_true', dest='geo_bypass', default=True,
 264         help='Bypass geographic restriction via faking X-Forwarded-For HTTP header')
 265     geo.add_option(
 266         '--no-geo-bypass',
 267         action='store_false', dest='geo_bypass', default=True,
 268         help='Do not bypass geographic restriction via faking X-Forwarded-For HTTP header')
 269     geo.add_option(
 270         '--geo-bypass-country', metavar='CODE',
 271         dest='geo_bypass_country', default=None,
 272         help='Force bypass geographic restriction with explicitly provided two-letter ISO 3166-2 country code')
 273     geo.add_option(
 274         '--geo-bypass-ip-block', metavar='IP_BLOCK',
 275         dest='geo_bypass_ip_block', default=None,
 276         help='Force bypass geographic restriction with explicitly provided IP block in CIDR notation')
 277
 278     selection = optparse.OptionGroup(parser, 'Video Selection')
 279     selection.add_option(
 280         '--playlist-start',
 281         dest='playliststart', metavar='NUMBER', default=1, type=int,
 282         help='Playlist video to start at (default is %default)')
 283     selection.add_option(
 284         '--playlist-end',
 285         dest='playlistend', metavar='NUMBER', default=None, type=int,
 286         help='Playlist video to end at (default is last)')
 287     selection.add_option(
 288         '--playlist-items',
 289         dest='playlist_items', metavar='ITEM_SPEC', default=None,
 290         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')
 291     selection.add_option(
 292         '--match-title',
 293         dest='matchtitle', metavar='REGEX',
 294         help='Download only matching titles (regex or caseless sub-string)')
 295     selection.add_option(
 296         '--reject-title',
 297         dest='rejecttitle', metavar='REGEX',
 298         help='Skip download for matching titles (regex or caseless sub-string)')
 299     selection.add_option(
 300         '--max-downloads',
 301         dest='max_downloads', metavar='NUMBER', type=int, default=None,
 302         help='Abort after downloading NUMBER files')
 303     selection.add_option(
 304         '--min-filesize',
 305         metavar='SIZE', dest='min_filesize', default=None,
 306         help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
 307     selection.add_option(
 308         '--max-filesize',
 309         metavar='SIZE', dest='max_filesize', default=None,
 310         help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
 311     selection.add_option(
 312         '--date',
 313         metavar='DATE', dest='date', default=None,
 314         help=(
 315             'Download only videos uploaded in this date. '
 316             'The date can be "YYYYMMDD" or in the format '
 317             '"(now|today)[+-][0-9](day|week|month|year)(s)?"'))
 318     selection.add_option(
 319         '--datebefore',
 320         metavar='DATE', dest='datebefore', default=None,
 321         help=(
 322             'Download only videos uploaded on or before this date. '
 323             'The date formats accepted is the same as --date'))
 324     selection.add_option(
 325         '--dateafter',
 326         metavar='DATE', dest='dateafter', default=None,
 327         help=(
 328             'Download only videos uploaded on or after this date. '
 329             'The date formats accepted is the same as --date'))
 330     selection.add_option(
 331         '--min-views',
 332         metavar='COUNT', dest='min_views', default=None, type=int,
 333         help='Do not download any videos with less than COUNT views')
 334     selection.add_option(
 335         '--max-views',
 336         metavar='COUNT', dest='max_views', default=None, type=int,
 337         help='Do not download any videos with more than COUNT views')
 338     selection.add_option(
 339         '--match-filter',
 340         metavar='FILTER', dest='match_filter', default=None,
 341         help=(
 342             'Generic video filter. '
 343             'Specify any key (see "OUTPUT TEMPLATE" for a list of available keys) to '
 344             'match if the key is present, '
 345             '!key to check if the key is not present, '
 346             'key>NUMBER (like "comment_count > 12", also works with '
 347             '>=, <, <=, !=, =) to compare against a number, '
 348             'key = \'LITERAL\' (like "uploader = \'Mike Smith\'", also works with !=) '
 349             'to match against a string literal '
 350             'and & to require multiple matches. '
 351             'Values which are not known are excluded unless you '
 352             'put a question mark (?) after the operator. '
 353             'For example, to only match videos that have been liked more than '
 354             '100 times and disliked less than 50 times (or the dislike '
 355             'functionality is not available at the given service), but who '
 356             'also have a description, use --match-filter '
 357             '"like_count > 100 & dislike_count <? 50 & description"'))
 358     selection.add_option(
 359         '--no-match-filter',
 360         metavar='FILTER', dest='match_filter', action='store_const', const=None,
 361         help='Do not use generic video filter (default)')
 362     selection.add_option(
 363         '--no-playlist',
 364         action='store_true', dest='noplaylist', default=False,
 365         help='Download only the video, if the URL refers to a video and a playlist')
 366     selection.add_option(
 367         '--yes-playlist',
 368         action='store_false', dest='noplaylist', default=False,
 369         help='Download the playlist, if the URL refers to a video and a playlist')
 370     selection.add_option(
 371         '--age-limit',
 372         metavar='YEARS', dest='age_limit', default=None, type=int,
 373         help='Download only videos suitable for the given age')
 374     selection.add_option(
 375         '--download-archive', metavar='FILE',
 376         dest='download_archive',
 377         help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
 378     selection.add_option(
 379         '--break-on-existing',
 380         action='store_true', dest='break_on_existing', default=False,
 381         help='Stop the download process when encountering a file that is in the archive')
 382     selection.add_option(
 383         '--break-on-reject',
 384         action='store_true', dest='break_on_reject', default=False,
 385         help='Stop the download process when encountering a file that has been filtered out')
 386     selection.add_option(
 387         '--no-download-archive',
 388         dest='download_archive', action="store_const", const=None,
 389         help='Do not use archive file (default)')
 390     selection.add_option(
 391         '--include-ads',
 392         dest='include_ads', action='store_true',
 393         help='Download advertisements as well (experimental)')
 394     selection.add_option(
 395         '--no-include-ads',
 396         dest='include_ads', action='store_false',
 397         help='Do not download advertisements (default)')
 398
 399     authentication = optparse.OptionGroup(parser, 'Authentication Options')
 400     authentication.add_option(
 401         '-u', '--username',
 402         dest='username', metavar='USERNAME',
 403         help='Login with this account ID')
 404     authentication.add_option(
 405         '-p', '--password',
 406         dest='password', metavar='PASSWORD',
 407         help='Account password. If this option is left out, youtube-dlc will ask interactively')
 408     authentication.add_option(
 409         '-2', '--twofactor',
 410         dest='twofactor', metavar='TWOFACTOR',
 411         help='Two-factor authentication code')
 412     authentication.add_option(
 413         '-n', '--netrc',
 414         action='store_true', dest='usenetrc', default=False,
 415         help='Use .netrc authentication data')
 416     authentication.add_option(
 417         '--video-password',
 418         dest='videopassword', metavar='PASSWORD',
 419         help='Video password (vimeo, youku)')
 420
 421     adobe_pass = optparse.OptionGroup(parser, 'Adobe Pass Options')
 422     adobe_pass.add_option(
 423         '--ap-mso',
 424         dest='ap_mso', metavar='MSO',
 425         help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
 426     adobe_pass.add_option(
 427         '--ap-username',
 428         dest='ap_username', metavar='USERNAME',
 429         help='Multiple-system operator account login')
 430     adobe_pass.add_option(
 431         '--ap-password',
 432         dest='ap_password', metavar='PASSWORD',
 433         help='Multiple-system operator account password. If this option is left out, youtube-dlc will ask interactively')
 434     adobe_pass.add_option(
 435         '--ap-list-mso',
 436         action='store_true', dest='ap_list_mso', default=False,
 437         help='List all supported multiple-system operators')
 438
 439     video_format = optparse.OptionGroup(parser, 'Video Format Options')
 440     video_format.add_option(
 441         '-f', '--format',
 442         action='store', dest='format', metavar='FORMAT', default=None,
 443         help='Video format code, see "FORMAT SELECTION" for more details')
 444     video_format.add_option(
 445         '-S', '--format-sort', metavar='SORTORDER',
 446         dest='format_sort', default=[],
 447         action='callback', callback=_comma_separated_values_options_callback, type='str',
 448         help='Sort the formats by the fields given, see "Sorting Formats" for more details')
 449     video_format.add_option(
 450         '--format-sort-force', '--S-force',
 451         action='store_true', dest='format_sort_force', metavar='FORMAT', default=False,
 452         help=(
 453             'Force user specified sort order to have precedence over all fields, '
 454             'see "Sorting Formats" for more details'))
 455     video_format.add_option(
 456         '--no-format-sort-force',
 457         action='store_false', dest='format_sort_force', metavar='FORMAT', default=False,
 458         help=(
 459             'Some fields have precedence over the user specified sort order (default), '
 460             'see "Sorting Formats" for more details'))
 461     video_format.add_option(
 462         '--video-multistreams',
 463         action='store_true', dest='allow_multiple_video_streams', default=False,
 464         help='Allow multiple video streams to be merged into a single file')
 465     video_format.add_option(
 466         '--no-video-multistreams',
 467         action='store_false', dest='allow_multiple_video_streams',
 468         help='Only one video stream is downloaded for each output file (default)')
 469     video_format.add_option(
 470         '--audio-multistreams',
 471         action='store_true', dest='allow_multiple_audio_streams', default=False,
 472         help='Allow multiple audio streams to be merged into a single file')
 473     video_format.add_option(
 474         '--no-audio-multistreams',
 475         action='store_false', dest='allow_multiple_audio_streams',
 476         help='Only one audio stream is downloaded for each output file (default)')
 477     video_format.add_option(
 478         '--all-formats',
 479         action='store_const', dest='format', const='all',
 480         help='Download all available video formats')
 481     video_format.add_option(
 482         '--prefer-free-formats',
 483         action='store_true', dest='prefer_free_formats', default=False,
 484         help='Prefer free video formats over non-free formats of same quality')
 485     video_format.add_option(
 486         '-F', '--list-formats',
 487         action='store_true', dest='listformats',
 488         help='List all available formats of requested videos')
 489     video_format.add_option(
 490         '--list-formats-as-table',
 491         action='store_true', dest='listformats_table', default=True,
 492         help='Present the output of -F in tabular form (default)')
 493     video_format.add_option(
 494         '--list-formats-old', '--no-list-formats-as-table',
 495         action='store_false', dest='listformats_table',
 496         help='Present the output of -F in the old form (Alias: --no-list-formats-as-table)')
 497     video_format.add_option(
 498         '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
 499         action='store_true', dest='youtube_include_dash_manifest', default=True,
 500         help='Download the DASH manifests and related data on YouTube videos (default) (Alias: --no-youtube-skip-dash-manifest)')
 501     video_format.add_option(
 502         '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
 503         action='store_false', dest='youtube_include_dash_manifest',
 504         help='Do not download the DASH manifests and related data on YouTube videos (Alias: --no-youtube-include-dash-manifest)')
 505     video_format.add_option(
 506         '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
 507         action='store_true', dest='youtube_include_hls_manifest', default=True,
 508         help='Download the HLS manifests and related data on YouTube videos (default) (Alias: --no-youtube-skip-hls-manifest)')
 509     video_format.add_option(
 510         '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
 511         action='store_false', dest='youtube_include_hls_manifest',
 512         help='Do not download the HLS manifests and related data on YouTube videos (Alias: --no-youtube-include-hls-manifest)')
 513     video_format.add_option(
 514         '--merge-output-format',
 515         action='store', dest='merge_output_format', metavar='FORMAT', default=None,
 516         help=(
 517             'If a merge is required (e.g. bestvideo+bestaudio), '
 518             'output to given container format. One of mkv, mp4, ogg, webm, flv. '
 519             'Ignored if no merge is required'))
 520
 521     subtitles = optparse.OptionGroup(parser, 'Subtitle Options')
 522     subtitles.add_option(
 523         '--write-subs', '--write-srt',
 524         action='store_true', dest='writesubtitles', default=False,
 525         help='Write subtitle file')
 526     subtitles.add_option(
 527         '--no-write-subs', '--no-write-srt',
 528         action='store_false', dest='writesubtitles',
 529         help='Do not write subtitle file (default)')
 530     subtitles.add_option(
 531         '--write-auto-subs', '--write-automatic-subs',
 532         action='store_true', dest='writeautomaticsub', default=False,
 533         help='Write automatically generated subtitle file (YouTube only)')
 534     subtitles.add_option(
 535         '--no-write-auto-subs', '--no-write-automatic-subs',
 536         action='store_false', dest='writeautomaticsub', default=False,
 537         help='Do not write automatically generated subtitle file (default)')
 538     subtitles.add_option(
 539         '--all-subs',
 540         action='store_true', dest='allsubtitles', default=False,
 541         help='Download all the available subtitles of the video')
 542     subtitles.add_option(
 543         '--list-subs',
 544         action='store_true', dest='listsubtitles', default=False,
 545         help='List all available subtitles for the video')
 546     subtitles.add_option(
 547         '--sub-format',
 548         action='store', dest='subtitlesformat', metavar='FORMAT', default='best',
 549         help='Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"')
 550     subtitles.add_option(
 551         '--sub-lang', '--sub-langs', '--srt-lang',
 552         action='callback', dest='subtitleslangs', metavar='LANGS', type='str',
 553         default=[], callback=_comma_separated_values_options_callback,
 554         help='Languages of the subtitles to download (optional) separated by commas, use --list-subs for available language tags')
 555
 556     downloader = optparse.OptionGroup(parser, 'Download Options')
 557     downloader.add_option(
 558         '-r', '--limit-rate', '--rate-limit',
 559         dest='ratelimit', metavar='RATE',
 560         help='Maximum download rate in bytes per second (e.g. 50K or 4.2M)')
 561     downloader.add_option(
 562         '-R', '--retries',
 563         dest='retries', metavar='RETRIES', default=10,
 564         help='Number of retries (default is %default), or "infinite"')
 565     downloader.add_option(
 566         '--fragment-retries',
 567         dest='fragment_retries', metavar='RETRIES', default=10,
 568         help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)')
 569     downloader.add_option(
 570         '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragment',
 571         action='store_true', dest='skip_unavailable_fragments', default=True,
 572         help='Skip unavailable fragments for DASH, hlsnative and ISM (default) (Alias: --no-abort-on-unavailable-fragment)')
 573     downloader.add_option(
 574         '--abort-on-unavailable-fragment', '--no-skip-unavailable-fragments',
 575         action='store_false', dest='skip_unavailable_fragments',
 576         help='Abort downloading if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
 577     downloader.add_option(
 578         '--keep-fragments',
 579         action='store_true', dest='keep_fragments', default=False,
 580         help='Keep downloaded fragments on disk after downloading is finished')
 581     downloader.add_option(
 582         '--no-keep-fragments',
 583         action='store_false', dest='keep_fragments',
 584         help='Delete downloaded fragments after downloading is finished (default)')
 585     downloader.add_option(
 586         '--buffer-size',
 587         dest='buffersize', metavar='SIZE', default='1024',
 588         help='Size of download buffer (e.g. 1024 or 16K) (default is %default)')
 589     downloader.add_option(
 590         '--resize-buffer',
 591         action='store_false', dest='noresizebuffer',
 592         help='The buffer size is automatically resized from an initial value of --buffer-size (default)')
 593     downloader.add_option(
 594         '--no-resize-buffer',
 595         action='store_true', dest='noresizebuffer', default=False,
 596         help='Do not automatically adjust the buffer size')
 597     downloader.add_option(
 598         '--http-chunk-size',
 599         dest='http_chunk_size', metavar='SIZE', default=None,
 600         help=(
 601             'Size of a chunk for chunk-based HTTP downloading (e.g. 10485760 or 10M) (default is disabled). '
 602             'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)'))
 603     downloader.add_option(
 604         '--test',
 605         action='store_true', dest='test', default=False,
 606         help=optparse.SUPPRESS_HELP)
 607     downloader.add_option(
 608         '--playlist-reverse',
 609         action='store_true',
 610         help='Download playlist videos in reverse order')
 611     downloader.add_option(
 612         '--no-playlist-reverse',
 613         action='store_false', dest='playlist_reverse',
 614         help='Download playlist videos in default order (default)')
 615     downloader.add_option(
 616         '--playlist-random',
 617         action='store_true',
 618         help='Download playlist videos in random order')
 619     downloader.add_option(
 620         '--xattr-set-filesize',
 621         dest='xattr_set_filesize', action='store_true',
 622         help='Set file xattribute ytdl.filesize with expected file size')
 623     downloader.add_option(
 624         '--hls-prefer-native',
 625         dest='hls_prefer_native', action='store_true', default=None,
 626         help='Use the native HLS downloader instead of ffmpeg')
 627     downloader.add_option(
 628         '--hls-prefer-ffmpeg',
 629         dest='hls_prefer_native', action='store_false', default=None,
 630         help='Use ffmpeg instead of the native HLS downloader')
 631     downloader.add_option(
 632         '--hls-use-mpegts',
 633         dest='hls_use_mpegts', action='store_true',
 634         help=(
 635             'Use the mpegts container for HLS videos, allowing to play the '
 636             'video while downloading (some players may not be able to play it)'))
 637     downloader.add_option(
 638         '--external-downloader',
 639         dest='external_downloader', metavar='NAME',
 640         help=(
 641             'Use the specified external downloader. '
 642             'Currently supports %s' % ', '.join(list_external_downloaders())))
 643     downloader.add_option(
 644         '--downloader-args', '--external-downloader-args',
 645         metavar='NAME:ARGS', dest='external_downloader_args', default={}, type='str',
 646         action='callback', callback=_dict_from_multiple_values_options_callback,
 647         callback_kwargs={
 648             'allowed_keys': '|'.join(list_external_downloaders()),
 649             'default_key': 'default', 'process': compat_shlex_split},
 650         help=(
 651             'Give these arguments to the external downloader. '
 652             'Specify the downloader name and the arguments separated by a colon ":". '
 653             'You can use this option multiple times (Alias: --external-downloader-args)'))
 654
 655     workarounds = optparse.OptionGroup(parser, 'Workarounds')
 656     workarounds.add_option(
 657         '--encoding',
 658         dest='encoding', metavar='ENCODING',
 659         help='Force the specified encoding (experimental)')
 660     workarounds.add_option(
 661         '--no-check-certificate',
 662         action='store_true', dest='no_check_certificate', default=False,
 663         help='Suppress HTTPS certificate validation')
 664     workarounds.add_option(
 665         '--prefer-insecure', '--prefer-unsecure',
 666         action='store_true', dest='prefer_insecure',
 667         help='Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)')
 668     workarounds.add_option(
 669         '--user-agent',
 670         metavar='UA', dest='user_agent',
 671         help='Specify a custom user agent')
 672     workarounds.add_option(
 673         '--referer',
 674         metavar='URL', dest='referer', default=None,
 675         help='Specify a custom referer, use if the video access is restricted to one domain',
 676     )
 677     workarounds.add_option(
 678         '--add-header',
 679         metavar='FIELD:VALUE', dest='headers', default={}, type='str',
 680         action='callback', callback=_dict_from_multiple_values_options_callback,
 681         help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times',
 682     )
 683     workarounds.add_option(
 684         '--bidi-workaround',
 685         dest='bidi_workaround', action='store_true',
 686         help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
 687     workarounds.add_option(
 688         '--sleep-interval', '--min-sleep-interval', metavar='SECONDS',
 689         dest='sleep_interval', type=float,
 690         help=(
 691             'Number of seconds to sleep before each download when used alone '
 692             'or a lower bound of a range for randomized sleep before each download '
 693             '(minimum possible number of seconds to sleep) when used along with '
 694             '--max-sleep-interval'))
 695     workarounds.add_option(
 696         '--max-sleep-interval', metavar='SECONDS',
 697         dest='max_sleep_interval', type=float,
 698         help=(
 699             'Upper bound of a range for randomized sleep before each download '
 700             '(maximum possible number of seconds to sleep). Must only be used '
 701             'along with --min-sleep-interval'))
 702     workarounds.add_option(
 703         '--sleep-subtitles', metavar='SECONDS',
 704         dest='sleep_interval_subtitles', default=0, type=int,
 705         help='Enforce sleep interval on subtitles as well')
 706
 707     verbosity = optparse.OptionGroup(parser, 'Verbosity / Simulation Options')
 708     verbosity.add_option(
 709         '-q', '--quiet',
 710         action='store_true', dest='quiet', default=False,
 711         help='Activate quiet mode')
 712     verbosity.add_option(
 713         '--no-warnings',
 714         dest='no_warnings', action='store_true', default=False,
 715         help='Ignore warnings')
 716     verbosity.add_option(
 717         '-s', '--simulate',
 718         action='store_true', dest='simulate', default=False,
 719         help='Do not download the video and do not write anything to disk')
 720     verbosity.add_option(
 721         '--skip-download', '--no-download',
 722         action='store_true', dest='skip_download', default=False,
 723         help='Do not download the video')
 724     verbosity.add_option(
 725         '-g', '--get-url',
 726         action='store_true', dest='geturl', default=False,
 727         help='Simulate, quiet but print URL')
 728     verbosity.add_option(
 729         '-e', '--get-title',
 730         action='store_true', dest='gettitle', default=False,
 731         help='Simulate, quiet but print title')
 732     verbosity.add_option(
 733         '--get-id',
 734         action='store_true', dest='getid', default=False,
 735         help='Simulate, quiet but print id')
 736     verbosity.add_option(
 737         '--get-thumbnail',
 738         action='store_true', dest='getthumbnail', default=False,
 739         help='Simulate, quiet but print thumbnail URL')
 740     verbosity.add_option(
 741         '--get-description',
 742         action='store_true', dest='getdescription', default=False,
 743         help='Simulate, quiet but print video description')
 744     verbosity.add_option(
 745         '--get-duration',
 746         action='store_true', dest='getduration', default=False,
 747         help='Simulate, quiet but print video length')
 748     verbosity.add_option(
 749         '--get-filename',
 750         action='store_true', dest='getfilename', default=False,
 751         help='Simulate, quiet but print output filename')
 752     verbosity.add_option(
 753         '--get-format',
 754         action='store_true', dest='getformat', default=False,
 755         help='Simulate, quiet but print output format')
 756     verbosity.add_option(
 757         '-j', '--dump-json',
 758         action='store_true', dest='dumpjson', default=False,
 759         help='Simulate, quiet but print JSON information. See "OUTPUT TEMPLATE" for a description of available keys')
 760     verbosity.add_option(
 761         '-J', '--dump-single-json',
 762         action='store_true', dest='dump_single_json', default=False,
 763         help=(
 764             'Simulate, quiet but print JSON information for each command-line argument. '
 765             'If the URL refers to a playlist, dump the whole playlist information in a single line'))
 766     verbosity.add_option(
 767         '--print-json',
 768         action='store_true', dest='print_json', default=False,
 769         help='Be quiet and print the video information as JSON (video is still being downloaded)')
 770     verbosity.add_option(
 771         '--force-write-archive', '--force-write-download-archive', '--force-download-archive',
 772         action='store_true', dest='force_write_download_archive', default=False,
 773         help=(
 774             'Force download archive entries to be written as far as no errors occur,'
 775             'even if -s or another simulation switch is used (Alias: --force-download-archive)'))
 776     verbosity.add_option(
 777         '--newline',
 778         action='store_true', dest='progress_with_newline', default=False,
 779         help='Output progress bar as new lines')
 780     verbosity.add_option(
 781         '--no-progress',
 782         action='store_true', dest='noprogress', default=False,
 783         help='Do not print progress bar')
 784     verbosity.add_option(
 785         '--console-title',
 786         action='store_true', dest='consoletitle', default=False,
 787         help='Display progress in console titlebar')
 788     verbosity.add_option(
 789         '-v', '--verbose',
 790         action='store_true', dest='verbose', default=False,
 791         help='Print various debugging information')
 792     verbosity.add_option(
 793         '--dump-pages', '--dump-intermediate-pages',
 794         action='store_true', dest='dump_intermediate_pages', default=False,
 795         help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
 796     verbosity.add_option(
 797         '--write-pages',
 798         action='store_true', dest='write_pages', default=False,
 799         help='Write downloaded intermediary pages to files in the current directory to debug problems')
 800     verbosity.add_option(
 801         '--youtube-print-sig-code',
 802         action='store_true', dest='youtube_print_sig_code', default=False,
 803         help=optparse.SUPPRESS_HELP)
 804     verbosity.add_option(
 805         '--print-traffic', '--dump-headers',
 806         dest='debug_printtraffic', action='store_true', default=False,
 807         help='Display sent and read HTTP traffic')
 808     verbosity.add_option(
 809         '-C', '--call-home',
 810         dest='call_home', action='store_true', default=False,
 811         help='[Broken] Contact the youtube-dlc server for debugging')
 812     verbosity.add_option(
 813         '--no-call-home',
 814         dest='call_home', action='store_false',
 815         help='Do not contact the youtube-dlc server for debugging (default)')
 816
 817     filesystem = optparse.OptionGroup(parser, 'Filesystem Options')
 818     filesystem.add_option(
 819         '-a', '--batch-file',
 820         dest='batchfile', metavar='FILE',
 821         help="File containing URLs to download ('-' for stdin), one URL per line. "
 822              "Lines starting with '#', ';' or ']' are considered as comments and ignored")
 823     filesystem.add_option(
 824         '--id', default=False,
 825         action='store_true', dest='useid', help=optparse.SUPPRESS_HELP)
 826     filesystem.add_option(
 827         '-P', '--paths',
 828         metavar='TYPE:PATH', dest='paths', default={}, type='str',
 829         action='callback', callback=_dict_from_multiple_values_options_callback,
 830         callback_kwargs={
 831             'allowed_keys': 'home|temp|config|description|annotation|subtitle|infojson|thumbnail',
 832             'process': lambda x: x.strip()},
 833         help=(
 834             'The paths where the files should be downloaded. '
 835             'Specify the type of file and the path separated by a colon ":" '
 836             '(supported: description|annotation|subtitle|infojson|thumbnail). '
 837             'Additionally, you can also provide "home" and "temp" paths. '
 838             'All intermediary files are first downloaded to the temp path and '
 839             'then the final files are moved over to the home path after download is finished. '
 840             'Note that this option is ignored if --output is an absolute path'))
 841     filesystem.add_option(
 842         '-o', '--output',
 843         dest='outtmpl', metavar='TEMPLATE',
 844         help='Output filename template, see "OUTPUT TEMPLATE" for details')
 845     filesystem.add_option(
 846         '--output-na-placeholder',
 847         dest='outtmpl_na_placeholder', metavar='TEXT', default='NA',
 848         help=('Placeholder value for unavailable meta fields in output filename template (default: "%default")'))
 849     filesystem.add_option(
 850         '--autonumber-size',
 851         dest='autonumber_size', metavar='NUMBER', type=int,
 852         help=optparse.SUPPRESS_HELP)
 853     filesystem.add_option(
 854         '--autonumber-start',
 855         dest='autonumber_start', metavar='NUMBER', default=1, type=int,
 856         help='Specify the start value for %(autonumber)s (default is %default)')
 857     filesystem.add_option(
 858         '--restrict-filenames',
 859         action='store_true', dest='restrictfilenames', default=False,
 860         help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
 861     filesystem.add_option(
 862         '--no-restrict-filenames',
 863         action='store_false', dest='restrictfilenames', default=False,
 864         help='Allow Unicode characters, "&" and spaces in filenames (default)')
 865     filesystem.add_option(
 866         '-A', '--auto-number',
 867         action='store_true', dest='autonumber', default=False,
 868         help=optparse.SUPPRESS_HELP)
 869     filesystem.add_option(
 870         '-t', '--title',
 871         action='store_true', dest='usetitle', default=False,
 872         help=optparse.SUPPRESS_HELP)
 873     filesystem.add_option(
 874         '-l', '--literal', default=False,
 875         action='store_true', dest='usetitle',
 876         help=optparse.SUPPRESS_HELP)
 877     filesystem.add_option(
 878         '-w', '--no-overwrites',
 879         action='store_false', dest='overwrites', default=None,
 880         help='Do not overwrite any files')
 881     filesystem.add_option(
 882         '--force-overwrites', '--yes-overwrites',
 883         action='store_true', dest='overwrites',
 884         help='Overwrite all video and metadata files. This option includes --no-continue')
 885     filesystem.add_option(
 886         '--no-force-overwrites',
 887         action='store_const', dest='overwrites', const=None,
 888         help='Do not overwrite the video, but overwrite related files (default)')
 889     filesystem.add_option(
 890         '-c', '--continue',
 891         action='store_true', dest='continue_dl', default=True,
 892         help='Resume partially downloaded files (default)')
 893     filesystem.add_option(
 894         '--no-continue',
 895         action='store_false', dest='continue_dl',
 896         help='Restart download of partially downloaded files from beginning')
 897     filesystem.add_option(
 898         '--part',
 899         action='store_false', dest='nopart', default=False,
 900         help='Use .part files instead of writing directly into output file (default)')
 901     filesystem.add_option(
 902         '--no-part',
 903         action='store_true', dest='nopart',
 904         help='Do not use .part files - write directly into output file')
 905     filesystem.add_option(
 906         '--mtime',
 907         action='store_true', dest='updatetime', default=True,
 908         help='Use the Last-modified header to set the file modification time (default)')
 909     filesystem.add_option(
 910         '--no-mtime',
 911         action='store_false', dest='updatetime',
 912         help='Do not use the Last-modified header to set the file modification time')
 913     filesystem.add_option(
 914         '--write-description',
 915         action='store_true', dest='writedescription', default=False,
 916         help='Write video description to a .description file')
 917     filesystem.add_option(
 918         '--no-write-description',
 919         action='store_false', dest='writedescription',
 920         help='Do not write video description (default)')
 921     filesystem.add_option(
 922         '--write-info-json',
 923         action='store_true', dest='writeinfojson', default=False,
 924         help='Write video metadata to a .info.json file')
 925     filesystem.add_option(
 926         '--no-write-info-json',
 927         action='store_false', dest='writeinfojson',
 928         help='Do not write video metadata (default)')
 929     filesystem.add_option(
 930         '--write-annotations',
 931         action='store_true', dest='writeannotations', default=False,
 932         help='Write video annotations to a .annotations.xml file')
 933     filesystem.add_option(
 934         '--no-write-annotations',
 935         action='store_false', dest='writeannotations',
 936         help='Do not write video annotations (default)')
 937     filesystem.add_option(
 938         '--load-info-json', '--load-info',
 939         dest='load_info_filename', metavar='FILE',
 940         help='JSON file containing the video information (created with the "--write-info-json" option)')
 941     filesystem.add_option(
 942         '--cookies',
 943         dest='cookiefile', metavar='FILE',
 944         help='File to read cookies from and dump cookie jar in')
 945     filesystem.add_option(
 946         '--no-cookies',
 947         action='store_const', const=None, dest='cookiefile', metavar='FILE',
 948         help='Do not read/dump cookies (default)')
 949     filesystem.add_option(
 950         '--cache-dir', dest='cachedir', default=None, metavar='DIR',
 951         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')
 952     filesystem.add_option(
 953         '--no-cache-dir', action='store_false', dest='cachedir',
 954         help='Disable filesystem caching')
 955     filesystem.add_option(
 956         '--rm-cache-dir',
 957         action='store_true', dest='rm_cachedir',
 958         help='Delete all filesystem cache files')
 959     filesystem.add_option(
 960         '--trim-file-name', metavar='LENGTH',
 961         dest='trim_file_name', default=0, type=int,
 962         help='Limit the filename length (extension excluded)')
 963
 964     thumbnail = optparse.OptionGroup(parser, 'Thumbnail Images')
 965     thumbnail.add_option(
 966         '--write-thumbnail',
 967         action='store_true', dest='writethumbnail', default=False,
 968         help='Write thumbnail image to disk')
 969     thumbnail.add_option(
 970         '--no-write-thumbnail',
 971         action='store_false', dest='writethumbnail',
 972         help='Do not write thumbnail image to disk (default)')
 973     thumbnail.add_option(
 974         '--write-all-thumbnails',
 975         action='store_true', dest='write_all_thumbnails', default=False,
 976         help='Write all thumbnail image formats to disk')
 977     thumbnail.add_option(
 978         '--list-thumbnails',
 979         action='store_true', dest='list_thumbnails', default=False,
 980         help='Simulate and list all available thumbnail formats')
 981
 982     link = optparse.OptionGroup(parser, 'Internet Shortcut Options')
 983     link.add_option(
 984         '--write-link',
 985         action='store_true', dest='writelink', default=False,
 986         help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
 987     link.add_option(
 988         '--write-url-link',
 989         action='store_true', dest='writeurllink', default=False,
 990         help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
 991     link.add_option(
 992         '--write-webloc-link',
 993         action='store_true', dest='writewebloclink', default=False,
 994         help='Write a .webloc macOS internet shortcut')
 995     link.add_option(
 996         '--write-desktop-link',
 997         action='store_true', dest='writedesktoplink', default=False,
 998         help='Write a .desktop Linux internet shortcut')
 999
1000     postproc = optparse.OptionGroup(parser, 'Post-Processing Options')
1001     postproc.add_option(
1002         '-x', '--extract-audio',
1003         action='store_true', dest='extractaudio', default=False,
1004         help='Convert video files to audio-only files (requires ffmpeg/avconv and ffprobe/avprobe)')
1005     postproc.add_option(
1006         '--audio-format', metavar='FORMAT', dest='audioformat', default='best',
1007         help='Specify audio format: "best", "aac", "flac", "mp3", "m4a", "opus", "vorbis", or "wav"; "%default" by default; No effect without -x')
1008     postproc.add_option(
1009         '--audio-quality', metavar='QUALITY',
1010         dest='audioquality', default='5',
1011         help='Specify ffmpeg/avconv audio quality, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default %default)')
1012     postproc.add_option(
1013         '--remux-video',
1014         metavar='FORMAT', dest='remuxvideo', default=None,
1015         help=(
1016             'Remux the video into another container if necessary (currently supported: mp4|mkv). '
1017             'If target container does not support the video/audio codec, remuxing will fail'))
1018     postproc.add_option(
1019         '--recode-video',
1020         metavar='FORMAT', dest='recodevideo', default=None,
1021         help='Re-encode the video into another format if re-encoding is necessary (currently supported: mp4|flv|ogg|webm|mkv|avi)')
1022     postproc.add_option(
1023         '--postprocessor-args', '--ppa',
1024         metavar='NAME:ARGS', dest='postprocessor_args', default={}, type='str',
1025         action='callback', callback=_dict_from_multiple_values_options_callback,
1026         callback_kwargs={'default_key': 'default-compat', 'allowed_keys': r'\w+(?:\+\w+)?', 'process': compat_shlex_split},
1027         help=(
1028             'Give these arguments to the postprocessors. '
1029             'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
1030             'to give the argument to the specified postprocessor/executable. Supported postprocessors are: '
1031             'SponSkrub, ExtractAudio, VideoRemuxer, VideoConvertor, EmbedSubtitle, Metadata, Merger, '
1032             'FixupStretched, FixupM4a, FixupM3u8, SubtitlesConvertor and EmbedThumbnail. '
1033             'The supported executables are: SponSkrub, FFmpeg, FFprobe, avconf, avprobe and AtomicParsley. '
1034             'You can use this option multiple times to give different arguments to different postprocessors. '
1035             'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
1036             'only when being used by the specified postprocessor. '
1037             'You can use this option multiple times (Alias: --ppa)'))
1038     postproc.add_option(
1039         '-k', '--keep-video',
1040         action='store_true', dest='keepvideo', default=False,
1041         help='Keep the intermediate video file on disk after post-processing')
1042     postproc.add_option(
1043         '--no-keep-video',
1044         action='store_false', dest='keepvideo',
1045         help='Delete the intermediate video file after post-processing (default)')
1046     postproc.add_option(
1047         '--post-overwrites',
1048         action='store_false', dest='nopostoverwrites',
1049         help='Overwrite post-processed files (default)')
1050     postproc.add_option(
1051         '--no-post-overwrites',
1052         action='store_true', dest='nopostoverwrites', default=False,
1053         help='Do not overwrite post-processed files')
1054     postproc.add_option(
1055         '--embed-subs',
1056         action='store_true', dest='embedsubtitles', default=False,
1057         help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
1058     postproc.add_option(
1059         '--no-embed-subs',
1060         action='store_false', dest='embedsubtitles',
1061         help='Do not embed subtitles (default)')
1062     postproc.add_option(
1063         '--embed-thumbnail',
1064         action='store_true', dest='embedthumbnail', default=False,
1065         help='Embed thumbnail in the audio as cover art')
1066     postproc.add_option(
1067         '--no-embed-thumbnail',
1068         action='store_false', dest='embedthumbnail',
1069         help='Do not embed thumbnail (default)')
1070     postproc.add_option(
1071         '--add-metadata',
1072         action='store_true', dest='addmetadata', default=False,
1073         help='Write metadata to the video file')
1074     postproc.add_option(
1075         '--no-add-metadata',
1076         action='store_false', dest='addmetadata',
1077         help='Do not write metadata (default)')
1078     postproc.add_option(
1079         '--metadata-from-title',
1080         metavar='FORMAT', dest='metafromtitle',
1081         help=(
1082             'Parse additional metadata like song title / artist from the video title. '
1083             'The format syntax is the same as --output. Regular expression with '
1084             'named capture groups may also be used. '
1085             'The parsed parameters replace existing values. '
1086             'Example: --metadata-from-title "%(artist)s - %(title)s" matches a title like '
1087             '"Coldplay - Paradise". '
1088             'Example (regex): --metadata-from-title "(?P<artist>.+?) - (?P<title>.+)"'))
1089     postproc.add_option(
1090         '--xattrs',
1091         action='store_true', dest='xattrs', default=False,
1092         help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
1093     postproc.add_option(
1094         '--fixup',
1095         metavar='POLICY', dest='fixup', default='detect_or_warn',
1096         help=(
1097             'Automatically correct known faults of the file. '
1098             'One of never (do nothing), warn (only emit a warning), '
1099             'detect_or_warn (the default; fix file if we can, warn otherwise)'))
1100     postproc.add_option(
1101         '--prefer-avconv', '--no-prefer-ffmpeg',
1102         action='store_false', dest='prefer_ffmpeg',
1103         help='Prefer avconv over ffmpeg for running the postprocessors (Alias: --no-prefer-ffmpeg)')
1104     postproc.add_option(
1105         '--prefer-ffmpeg', '--no-prefer-avconv',
1106         action='store_true', dest='prefer_ffmpeg',
1107         help='Prefer ffmpeg over avconv for running the postprocessors (default) (Alias: --no-prefer-avconv)')
1108     postproc.add_option(
1109         '--ffmpeg-location', '--avconv-location', metavar='PATH',
1110         dest='ffmpeg_location',
1111         help='Location of the ffmpeg/avconv binary; either the path to the binary or its containing directory (Alias: --avconv-location)')
1112     postproc.add_option(
1113         '--exec',
1114         metavar='CMD', dest='exec_cmd',
1115         help='Execute a command on the file after downloading and post-processing, similar to find\'s -exec syntax. Example: --exec \'adb push {} /sdcard/Music/ && rm {}\'')
1116     postproc.add_option(
1117         '--convert-subs', '--convert-subtitles',
1118         metavar='FORMAT', dest='convertsubtitles', default=None,
1119         help='Convert the subtitles to other format (currently supported: srt|ass|vtt|lrc)')
1120
1121     sponskrub = optparse.OptionGroup(parser, 'SponSkrub (SponsorBlock) Options', description=(
1122         'SponSkrub (https://github.com/pukkandan/SponSkrub) is a utility to mark/remove sponsor segments '
1123         'from downloaded YouTube videos using SponsorBlock API (https://sponsor.ajay.app)'))
1124     sponskrub.add_option(
1125         '--sponskrub',
1126         action='store_true', dest='sponskrub', default=None,
1127         help=(
1128             'Use sponskrub to mark sponsored sections. '
1129             'This is enabled by default if the sponskrub binary exists (Youtube only)'))
1130     sponskrub.add_option(
1131         '--no-sponskrub',
1132         action='store_false', dest='sponskrub',
1133         help='Do not use sponskrub')
1134     sponskrub.add_option(
1135         '--sponskrub-cut', default=False,
1136         action='store_true', dest='sponskrub_cut',
1137         help='Cut out the sponsor sections instead of simply marking them')
1138     sponskrub.add_option(
1139         '--no-sponskrub-cut',
1140         action='store_false', dest='sponskrub_cut',
1141         help='Simply mark the sponsor sections, not cut them out (default)')
1142     sponskrub.add_option(
1143         '--sponskrub-force', default=False,
1144         action='store_true', dest='sponskrub_force',
1145         help='Run sponskrub even if the video was already downloaded')
1146     sponskrub.add_option(
1147         '--no-sponskrub-force',
1148         action='store_true', dest='sponskrub_force',
1149         help='Do not cut out the sponsor sections if the video was already downloaded (default)')
1150     sponskrub.add_option(
1151         '--sponskrub-location', metavar='PATH',
1152         dest='sponskrub_path', default='',
1153         help='Location of the sponskrub binary; either the path to the binary or its containing directory')
1154     sponskrub.add_option(
1155         '--sponskrub-args', dest='sponskrub_args', metavar='ARGS',
1156         help=optparse.SUPPRESS_HELP)
1157
1158     extractor = optparse.OptionGroup(parser, 'Extractor Options')
1159     extractor.add_option(
1160         '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
1161         action='store_true', dest='dynamic_mpd', default=True,
1162         help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
1163     extractor.add_option(
1164         '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
1165         action='store_false', dest='dynamic_mpd',
1166         help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
1167
1168     parser.add_option_group(general)
1169     parser.add_option_group(network)
1170     parser.add_option_group(geo)
1171     parser.add_option_group(selection)
1172     parser.add_option_group(downloader)
1173     parser.add_option_group(filesystem)
1174     parser.add_option_group(thumbnail)
1175     parser.add_option_group(link)
1176     parser.add_option_group(verbosity)
1177     parser.add_option_group(workarounds)
1178     parser.add_option_group(video_format)
1179     parser.add_option_group(subtitles)
1180     parser.add_option_group(authentication)
1181     parser.add_option_group(adobe_pass)
1182     parser.add_option_group(postproc)
1183     parser.add_option_group(sponskrub)
1184     parser.add_option_group(extractor)
1185
1186     if overrideArguments is not None:
1187         opts, args = parser.parse_args(overrideArguments)
1188         if opts.verbose:
1189             write_string('[debug] Override config: ' + repr(overrideArguments) + '\n')
1190     else:
1191         def compat_conf(conf):
1192             if sys.version_info < (3,):
1193                 return [a.decode(preferredencoding(), 'replace') for a in conf]
1194             return conf
1195
1196         configs = {
1197             'command-line': compat_conf(sys.argv[1:]),
1198             'custom': [], 'home': [], 'portable': [], 'user': [], 'system': []}
1199         paths = {'command-line': False}
1200         opts, args = parser.parse_args(configs['command-line'])
1201
1202         def get_configs():
1203             if '--config-location' in configs['command-line']:
1204                 location = compat_expanduser(opts.config_location)
1205                 if os.path.isdir(location):
1206                     location = os.path.join(location, 'youtube-dlc.conf')
1207                 if not os.path.exists(location):
1208                     parser.error('config-location %s does not exist.' % location)
1209                 configs['custom'] = _readOptions(location, default=None)
1210                 if configs['custom'] is None:
1211                     configs['custom'] = []
1212                 else:
1213                     paths['custom'] = location
1214             if '--ignore-config' in configs['command-line']:
1215                 return
1216             if '--ignore-config' in configs['custom']:
1217                 return
1218
1219             def read_options(path, user=False):
1220                 for package in ('yt-dlp', 'youtube-dlc'):
1221                     if user:
1222                         config, current_path = _readUserConf(package, default=None)
1223                     else:
1224                         current_path = os.path.join(path, '%s.conf' % package)
1225                         config = _readOptions(current_path, default=None)
1226                     if config is not None:
1227                         return config, current_path
1228                 return [], None
1229
1230             configs['portable'], paths['portable'] = read_options(get_executable_path())
1231             if '--ignore-config' in configs['portable']:
1232                 return
1233
1234             def get_home_path():
1235                 opts = parser.parse_args(configs['portable'] + configs['custom'] + configs['command-line'])[0]
1236                 return expand_path(opts.paths.get('home', '')).strip()
1237
1238             configs['home'], paths['home'] = read_options(get_home_path())
1239             if '--ignore-config' in configs['home']:
1240                 return
1241
1242             configs['system'], paths['system'] = read_options('/etc')
1243             if '--ignore-config' in configs['system']:
1244                 return
1245
1246             configs['user'], paths['user'] = read_options('', True)
1247             if '--ignore-config' in configs['user']:
1248                 configs['system'], paths['system'] = [], None
1249
1250         get_configs()
1251         argv = configs['system'] + configs['user'] + configs['home'] + configs['portable'] + configs['custom'] + configs['command-line']
1252         opts, args = parser.parse_args(argv)
1253         if opts.verbose:
1254             for label in ('System', 'User', 'Portable', 'Home', 'Custom', 'Command-line'):
1255                 key = label.lower()
1256                 if paths.get(key) is None:
1257                     continue
1258                 if paths[key]:
1259                     write_string('[debug] %s config file: %s\n' % (label, paths[key]))
1260                 write_string('[debug] %s config: %s\n' % (label, repr(_hide_login_info(configs[key]))))
1261
1262     return parser, opts, args