]> jfr.im git - yt-dlp.git/blame - yt_dlp/options.py
[crunchyroll:playlist] Force http
[yt-dlp.git] / yt_dlp / options.py
CommitLineData
2daabe49
PH
1from __future__ import unicode_literals
2
34a741a8
PH
3import os.path
4import optparse
3aa9a735 5import re
34a741a8
PH
6import sys
7
8c25f81b 8from .compat import (
4644ac55 9 compat_expanduser,
003c69a8 10 compat_get_terminal_size,
4644ac55 11 compat_getenv,
c7b0add8 12 compat_kwargs,
cab792ab 13 compat_shlex_split,
8c25f81b
PH
14)
15from .utils import (
0202b52a 16 expand_path,
f74980cb 17 get_executable_path,
de6000d9 18 OUTTMPL_TYPES,
ff556f5c 19 preferredencoding,
34a741a8
PH
20 write_string,
21)
22from .version import __version__
23
81a23040 24from .downloader.external import list_external_downloaders
25from .postprocessor.ffmpeg import (
26 FFmpegExtractAudioPP,
27 FFmpegSubtitlesConvertorPP,
28 FFmpegThumbnailsConvertorPP,
29 FFmpegVideoRemuxerPP,
30)
31
34a741a8 32
905d18a7
YCH
33def _hide_login_info(opts):
34 PRIVATE_OPTS = set(['-p', '--password', '-u', '--username', '--video-password', '--ap-password', '--ap-username'])
35 eqre = re.compile('^(?P<key>' + ('|'.join(re.escape(po) for po in PRIVATE_OPTS)) + ')=.+$')
36
37 def _scrub_eq(o):
38 m = eqre.match(o)
39 if m:
40 return m.group('key') + '=PRIVATE'
41 else:
42 return o
43
44 opts = list(map(_scrub_eq, opts))
45 for idx, opt in enumerate(opts):
46 if opt in PRIVATE_OPTS and idx + 1 < len(opts):
47 opts[idx + 1] = 'PRIVATE'
48 return opts
49
50
34a741a8
PH
51def parseOpts(overrideArguments=None):
52 def _readOptions(filename_bytes, default=[]):
53 try:
54 optionf = open(filename_bytes)
55 except IOError:
56 return default # silently skip if file is not present
57 try:
067aa17e 58 # FIXME: https://github.com/ytdl-org/youtube-dl/commit/dfe5fa49aed02cf36ba9f743b11b0903554b5e56
1251565e
S
59 contents = optionf.read()
60 if sys.version_info < (3,):
61 contents = contents.decode(preferredencoding())
62 res = compat_shlex_split(contents, comments=True)
34a741a8
PH
63 finally:
64 optionf.close()
65 return res
66
e2e43aea 67 def _readUserConf(package_name, default=[]):
68 # .config
69 xdg_config_home = compat_getenv('XDG_CONFIG_HOME') or compat_expanduser('~/.config')
70 userConfFile = os.path.join(xdg_config_home, package_name, 'config')
71 if not os.path.isfile(userConfFile):
72 userConfFile = os.path.join(xdg_config_home, '%s.conf' % package_name)
73 userConf = _readOptions(userConfFile, default=None)
74 if userConf is not None:
0202b52a 75 return userConf, userConfFile
34a741a8 76
e2e43aea 77 # appdata
78 appdata_dir = compat_getenv('appdata')
79 if appdata_dir:
80 userConfFile = os.path.join(appdata_dir, package_name, 'config')
81 userConf = _readOptions(userConfFile, default=None)
82 if userConf is None:
0202b52a 83 userConfFile += '.txt'
84 userConf = _readOptions(userConfFile, default=None)
e2e43aea 85 if userConf is not None:
0202b52a 86 return userConf, userConfFile
34a741a8 87
e2e43aea 88 # home
89 userConfFile = os.path.join(compat_expanduser('~'), '%s.conf' % package_name)
90 userConf = _readOptions(userConfFile, default=None)
34a741a8 91 if userConf is None:
0202b52a 92 userConfFile += '.txt'
93 userConf = _readOptions(userConfFile, default=None)
e2e43aea 94 if userConf is not None:
0202b52a 95 return userConf, userConfFile
34a741a8 96
0202b52a 97 return default, None
34a741a8
PH
98
99 def _format_option_string(option):
100 ''' ('-o', '--option') -> -o, --format METAVAR'''
101
102 opts = []
103
104 if option._short_opts:
105 opts.append(option._short_opts[0])
106 if option._long_opts:
107 opts.append(option._long_opts[0])
108 if len(opts) > 1:
109 opts.insert(1, ', ')
110
8450c15c
PH
111 if option.takes_value():
112 opts.append(' %s' % option.metavar)
34a741a8 113
611c1dd9 114 return ''.join(opts)
34a741a8 115
e632bce2 116 def _list_from_options_callback(option, opt_str, value, parser, append=True, delim=','):
117 # append can be True, False or -1 (prepend)
118 current = getattr(parser.values, option.dest) if append else []
119 value = [value] if delim is None else value.split(delim)
d818eb74 120 setattr(
121 parser.values, option.dest,
e632bce2 122 current + value if append is True else value + current)
34a741a8 123
e632bce2 124 def _dict_from_options_callback(
d818eb74 125 option, opt_str, value, parser,
126 allowed_keys=r'[\w-]+', delimiter=':', default_key=None, process=None, multiple_keys=True):
45016689 127
128 out_dict = getattr(parser.values, option.dest)
d818eb74 129 if multiple_keys:
130 allowed_keys = r'(%s)(,(%s))*' % (allowed_keys, allowed_keys)
131 mobj = re.match(r'(?i)(?P<keys>%s)%s(?P<val>.*)$' % (allowed_keys, delimiter), value)
45016689 132 if mobj is not None:
d818eb74 133 keys = [k.strip() for k in mobj.group('keys').lower().split(',')]
134 val = mobj.group('val')
45016689 135 elif default_key is not None:
d818eb74 136 keys, val = [default_key], value
45016689 137 else:
138 raise optparse.OptionValueError(
139 'wrong %s formatting; it should be %s, not "%s"' % (opt_str, option.metavar, value))
4bb6b02f 140 try:
141 val = process(val) if process else val
142 except Exception as err:
143 raise optparse.OptionValueError(
144 'wrong %s formatting; %s' % (opt_str, err))
d818eb74 145 for key in keys:
146 out_dict[key] = val
45016689 147
34a741a8 148 # No need to wrap help messages if we're on a wide console
003c69a8 149 columns = compat_get_terminal_size().columns
8450c15c
PH
150 max_width = columns if columns else 80
151 max_help_position = 80
34a741a8
PH
152
153 fmt = optparse.IndentedHelpFormatter(width=max_width, max_help_position=max_help_position)
154 fmt.format_option_strings = _format_option_string
155
156 kw = {
8450c15c
PH
157 'version': __version__,
158 'formatter': fmt,
a42419da 159 'usage': '%prog [OPTIONS] URL [URL...]',
8450c15c 160 'conflict_handler': 'resolve',
34a741a8
PH
161 }
162
c7b0add8 163 parser = optparse.OptionParser(**compat_kwargs(kw))
34a741a8 164
8450c15c
PH
165 general = optparse.OptionGroup(parser, 'General Options')
166 general.add_option(
167 '-h', '--help',
168 action='help',
17941321 169 help='Print this help text and exit')
8450c15c 170 general.add_option(
b76f0e58 171 '--version',
8450c15c 172 action='version',
17941321 173 help='Print program version and exit')
8450c15c
PH
174 general.add_option(
175 '-U', '--update',
176 action='store_true', dest='update_self',
8d801631 177 help='Update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
8450c15c 178 general.add_option(
6623ac34 179 '-i', '--ignore-errors', '--no-abort-on-error',
53ed7066 180 action='store_true', dest='ignoreerrors', default=None,
8a51f564 181 help='Continue on download errors, for example to skip unavailable videos in a playlist (default) (Alias: --no-abort-on-error)')
8450c15c 182 general.add_option(
6623ac34 183 '--abort-on-error', '--no-ignore-errors',
8450c15c 184 action='store_false', dest='ignoreerrors',
8a51f564 185 help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)')
8450c15c
PH
186 general.add_option(
187 '--dump-user-agent',
188 action='store_true', dest='dump_user_agent', default=False,
17941321 189 help='Display the current browser identification')
34a741a8 190 general.add_option(
8450c15c
PH
191 '--list-extractors',
192 action='store_true', dest='list_extractors', default=False,
9836cfb8 193 help='List all supported extractors')
8450c15c
PH
194 general.add_option(
195 '--extractor-descriptions',
196 action='store_true', dest='list_extractor_descriptions', default=False,
197 help='Output descriptions of all supported extractors')
d22dec74
S
198 general.add_option(
199 '--force-generic-extractor',
200 action='store_true', dest='force_generic_extractor', default=False,
201 help='Force extraction to use the generic extractor')
34a741a8
PH
202 general.add_option(
203 '--default-search',
204 dest='default_search', metavar='PREFIX',
8a51f564 205 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')
34a741a8 206 general.add_option(
6623ac34 207 '--ignore-config', '--no-config',
34a741a8 208 action='store_true',
6623ac34 209 help=(
298f597b 210 'Disable loading any configuration files except the one provided by --config-location. '
211 'When given inside a configuration file, no further configuration files are loaded. '
212 'Additionally, (for backward compatibility) if this option is found inside the '
8a51f564 213 'system configuration file, the user configuration is not loaded'))
e66dca5e 214 general.add_option(
b6ee45e9
S
215 '--config-location',
216 dest='config_location', metavar='PATH',
0202b52a 217 help='Location of the main configuration file; either the path to the config or its containing directory')
057a5206
PH
218 general.add_option(
219 '--flat-playlist',
6623ac34 220 action='store_const', dest='extract_flat', const='in_playlist', default=False,
8a51f564 221 help='Do not extract the videos of a playlist, only list them')
6623ac34 222 general.add_option(
223 '--flat-videos',
224 action='store_true', dest='extract_flat',
a40258a2 225 # help='Do not resolve the video urls')
226 # doesn't work
227 help=optparse.SUPPRESS_HELP)
6623ac34 228 general.add_option(
229 '--no-flat-playlist',
230 action='store_false', dest='extract_flat',
231 help='Extract the videos of a playlist')
d77ab8e2
S
232 general.add_option(
233 '--mark-watched',
234 action='store_true', dest='mark_watched', default=False,
235 help='Mark videos watched (YouTube only)')
90f794c6
S
236 general.add_option(
237 '--no-mark-watched',
597c1866 238 action='store_false', dest='mark_watched',
239 help='Do not mark videos watched (default)')
7e5db8c9 240 general.add_option(
8a51f564 241 '--no-colors',
597c1866 242 action='store_true', dest='no_color', default=False,
17941321 243 help='Do not emit color codes in output')
53ed7066 244 general.add_option(
245 '--compat-options',
246 metavar='OPTS', dest='compat_opts', default=[],
e632bce2 247 action='callback', callback=_list_from_options_callback, type='str',
53ed7066 248 help=(
249 'Options that can help keep compatibility with youtube-dl and youtube-dlc '
250 'configurations by reverting some of the changes made in yt-dlp. '
251 'See "Differences in default behavior" for details'))
34a741a8 252
be4a824d
PH
253 network = optparse.OptionGroup(parser, 'Network Options')
254 network.add_option(
255 '--proxy', dest='proxy',
256 default=None, metavar='URL',
6623ac34 257 help=(
258 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable '
259 'SOCKS proxy, specify a proper scheme. For example '
260 'socks5://127.0.0.1:1080/. Pass in an empty string (--proxy "") '
261 'for direct connection'))
be4a824d
PH
262 network.add_option(
263 '--socket-timeout',
264 dest='socket_timeout', type=float, default=None, metavar='SECONDS',
265 help='Time to wait before giving up, in seconds')
266 network.add_option(
267 '--source-address',
268 metavar='IP', dest='source_address', default=None,
24ee6b97 269 help='Client-side IP address to bind to',
be4a824d 270 )
500b8b41
PH
271 network.add_option(
272 '-4', '--force-ipv4',
273 action='store_const', const='0.0.0.0', dest='source_address',
24ee6b97 274 help='Make all connections via IPv4',
500b8b41
PH
275 )
276 network.add_option(
277 '-6', '--force-ipv6',
278 action='store_const', const='::', dest='source_address',
24ee6b97 279 help='Make all connections via IPv6',
500b8b41 280 )
0aa10994 281
b31fdeed 282 geo = optparse.OptionGroup(parser, 'Geo-restriction')
0aa10994 283 geo.add_option(
38cce791
YCH
284 '--geo-verification-proxy',
285 dest='geo_verification_proxy', default=None, metavar='URL',
6623ac34 286 help=(
287 'Use this proxy to verify the IP address for some geo-restricted sites. '
8a51f564 288 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
0aa10994 289 geo.add_option(
91410c9b
PH
290 '--cn-verification-proxy',
291 dest='cn_verification_proxy', default=None, metavar='URL',
0aa10994
S
292 help=optparse.SUPPRESS_HELP)
293 geo.add_option(
294 '--geo-bypass',
295 action='store_true', dest='geo_bypass', default=True,
504f20dd 296 help='Bypass geographic restriction via faking X-Forwarded-For HTTP header')
0aa10994
S
297 geo.add_option(
298 '--no-geo-bypass',
299 action='store_false', dest='geo_bypass', default=True,
504f20dd 300 help='Do not bypass geographic restriction via faking X-Forwarded-For HTTP header')
0aa10994
S
301 geo.add_option(
302 '--geo-bypass-country', metavar='CODE',
303 dest='geo_bypass_country', default=None,
504f20dd 304 help='Force bypass geographic restriction with explicitly provided two-letter ISO 3166-2 country code')
5f95927a
S
305 geo.add_option(
306 '--geo-bypass-ip-block', metavar='IP_BLOCK',
307 dest='geo_bypass_ip_block', default=None,
504f20dd 308 help='Force bypass geographic restriction with explicitly provided IP block in CIDR notation')
be4a824d 309
8450c15c 310 selection = optparse.OptionGroup(parser, 'Video Selection')
34a741a8
PH
311 selection.add_option(
312 '--playlist-start',
313 dest='playliststart', metavar='NUMBER', default=1, type=int,
17941321 314 help='Playlist video to start at (default is %default)')
34a741a8
PH
315 selection.add_option(
316 '--playlist-end',
317 dest='playlistend', metavar='NUMBER', default=None, type=int,
17941321 318 help='Playlist video to end at (default is last)')
c14e88f0
PH
319 selection.add_option(
320 '--playlist-items',
321 dest='playlist_items', metavar='ITEM_SPEC', default=None,
8a51f564 322 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')
34a741a8 323 selection.add_option(
8450c15c
PH
324 '--match-title',
325 dest='matchtitle', metavar='REGEX',
17941321 326 help='Download only matching titles (regex or caseless sub-string)')
8450c15c
PH
327 selection.add_option(
328 '--reject-title',
329 dest='rejecttitle', metavar='REGEX',
17941321 330 help='Skip download for matching titles (regex or caseless sub-string)')
8450c15c
PH
331 selection.add_option(
332 '--max-downloads',
333 dest='max_downloads', metavar='NUMBER', type=int, default=None,
334 help='Abort after downloading NUMBER files')
335 selection.add_option(
336 '--min-filesize',
337 metavar='SIZE', dest='min_filesize', default=None,
338 help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
339 selection.add_option(
340 '--max-filesize',
341 metavar='SIZE', dest='max_filesize', default=None,
342 help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
343 selection.add_option(
344 '--date',
345 metavar='DATE', dest='date', default=None,
c76eb41b 346 help=(
8a51f564 347 'Download only videos uploaded in this date. '
348 'The date can be "YYYYMMDD" or in the format '
c76eb41b 349 '"(now|today)[+-][0-9](day|week|month|year)(s)?"'))
8450c15c
PH
350 selection.add_option(
351 '--datebefore',
352 metavar='DATE', dest='datebefore', default=None,
c76eb41b 353 help=(
354 'Download only videos uploaded on or before this date. '
355 'The date formats accepted is the same as --date'))
34a741a8 356 selection.add_option(
8450c15c
PH
357 '--dateafter',
358 metavar='DATE', dest='dateafter', default=None,
c76eb41b 359 help=(
360 'Download only videos uploaded on or after this date. '
361 'The date formats accepted is the same as --date'))
34a741a8 362 selection.add_option(
8450c15c
PH
363 '--min-views',
364 metavar='COUNT', dest='min_views', default=None, type=int,
17941321 365 help='Do not download any videos with less than COUNT views')
34a741a8 366 selection.add_option(
8450c15c
PH
367 '--max-views',
368 metavar='COUNT', dest='max_views', default=None, type=int,
369 help='Do not download any videos with more than COUNT views')
347de493
PH
370 selection.add_option(
371 '--match-filter',
372 metavar='FILTER', dest='match_filter', default=None,
373 help=(
24ee6b97 374 'Generic video filter. '
8a51f564 375 'Specify any key (see "OUTPUT TEMPLATE" for a list of available keys) to '
2c1f442c
S
376 'match if the key is present, '
377 '!key to check if the key is not present, '
277d6ff5 378 'key>NUMBER (like "view_count > 12", also works with '
ac33accd
S
379 '>=, <, <=, !=, =) to compare against a number, '
380 'key = \'LITERAL\' (like "uploader = \'Mike Smith\'", also works with !=) '
381 'to match against a string literal '
382 'and & to require multiple matches. '
2c1f442c
S
383 'Values which are not known are excluded unless you '
384 'put a question mark (?) after the operator. '
347de493
PH
385 'For example, to only match videos that have been liked more than '
386 '100 times and disliked less than 50 times (or the dislike '
387 'functionality is not available at the given service), but who '
5495937f 388 'also have a description, use --match-filter '
8a51f564 389 '"like_count > 100 & dislike_count <? 50 & description"'))
6623ac34 390 selection.add_option(
391 '--no-match-filter',
392 metavar='FILTER', dest='match_filter', action='store_const', const=None,
393 help='Do not use generic video filter (default)')
34a741a8 394 selection.add_option(
8450c15c
PH
395 '--no-playlist',
396 action='store_true', dest='noplaylist', default=False,
8a51f564 397 help='Download only the video, if the URL refers to a video and a playlist')
df4bd0d5
PH
398 selection.add_option(
399 '--yes-playlist',
f0884c8b 400 action='store_false', dest='noplaylist',
8a51f564 401 help='Download the playlist, if the URL refers to a video and a playlist')
8450c15c
PH
402 selection.add_option(
403 '--age-limit',
404 metavar='YEARS', dest='age_limit', default=None, type=int,
17941321 405 help='Download only videos suitable for the given age')
8450c15c
PH
406 selection.add_option(
407 '--download-archive', metavar='FILE',
408 dest='download_archive',
8a51f564 409 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
ea6e0c2b 410 selection.add_option(
411 '--break-on-existing',
412 action='store_true', dest='break_on_existing', default=False,
8a51f564 413 help='Stop the download process when encountering a file that is in the archive')
8b0d7497 414 selection.add_option(
415 '--break-on-reject',
416 action='store_true', dest='break_on_reject', default=False,
8a51f564 417 help='Stop the download process when encountering a file that has been filtered out')
26e2805c 418 selection.add_option(
419 '--skip-playlist-after-errors', metavar='N',
420 dest='skip_playlist_after_errors', default=None, type=int,
421 help='Number of allowed failures until the rest of the playlist is skipped')
6623ac34 422 selection.add_option(
423 '--no-download-archive',
424 dest='download_archive', action="store_const", const=None,
425 help='Do not use archive file (default)')
8450c15c
PH
426 selection.add_option(
427 '--include-ads',
428 dest='include_ads', action='store_true',
d9aa2332 429 help=optparse.SUPPRESS_HELP)
6623ac34 430 selection.add_option(
431 '--no-include-ads',
432 dest='include_ads', action='store_false',
d9aa2332 433 help=optparse.SUPPRESS_HELP)
34a741a8 434
8450c15c
PH
435 authentication = optparse.OptionGroup(parser, 'Authentication Options')
436 authentication.add_option(
437 '-u', '--username',
438 dest='username', metavar='USERNAME',
17941321 439 help='Login with this account ID')
8450c15c
PH
440 authentication.add_option(
441 '-p', '--password',
442 dest='password', metavar='PASSWORD',
7a5c1cfe 443 help='Account password. If this option is left out, yt-dlp will ask interactively')
8450c15c
PH
444 authentication.add_option(
445 '-2', '--twofactor',
446 dest='twofactor', metavar='TWOFACTOR',
3540fe26 447 help='Two-factor authentication code')
8450c15c
PH
448 authentication.add_option(
449 '-n', '--netrc',
450 action='store_true', dest='usenetrc', default=False,
17941321 451 help='Use .netrc authentication data')
8450c15c
PH
452 authentication.add_option(
453 '--video-password',
454 dest='videopassword', metavar='PASSWORD',
29f7c58a 455 help='Video password (vimeo, youku)')
b31fdeed 456 authentication.add_option(
797c636b
RA
457 '--ap-mso',
458 dest='ap_mso', metavar='MSO',
537f7533 459 help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
b31fdeed 460 authentication.add_option(
1b6712ab 461 '--ap-username',
797c636b 462 dest='ap_username', metavar='USERNAME',
537f7533 463 help='Multiple-system operator account login')
b31fdeed 464 authentication.add_option(
1b6712ab 465 '--ap-password',
797c636b 466 dest='ap_password', metavar='PASSWORD',
7a5c1cfe 467 help='Multiple-system operator account password. If this option is left out, yt-dlp will ask interactively')
b31fdeed 468 authentication.add_option(
87148bb7
RA
469 '--ap-list-mso',
470 action='store_true', dest='ap_list_mso', default=False,
537f7533 471 help='List all supported multiple-system operators')
8450c15c
PH
472
473 video_format = optparse.OptionGroup(parser, 'Video Format Options')
474 video_format.add_option(
475 '-f', '--format',
476 action='store', dest='format', metavar='FORMAT', default=None,
eb8a4433 477 help='Video format code, see "FORMAT SELECTION" for more details')
478 video_format.add_option(
c76eb41b 479 '-S', '--format-sort', metavar='SORTORDER',
e632bce2 480 dest='format_sort', default=[], type='str', action='callback',
481 callback=_list_from_options_callback, callback_kwargs={'append': -1},
eb8a4433 482 help='Sort the formats by the fields given, see "Sorting Formats" for more details')
483 video_format.add_option(
484 '--format-sort-force', '--S-force',
485 action='store_true', dest='format_sort_force', metavar='FORMAT', default=False,
486 help=(
487 'Force user specified sort order to have precedence over all fields, '
488 'see "Sorting Formats" for more details'))
489 video_format.add_option(
490 '--no-format-sort-force',
491 action='store_false', dest='format_sort_force', metavar='FORMAT', default=False,
492 help=(
493 'Some fields have precedence over the user specified sort order (default), '
494 'see "Sorting Formats" for more details'))
909d24dd 495 video_format.add_option(
496 '--video-multistreams',
53ed7066 497 action='store_true', dest='allow_multiple_video_streams', default=None,
91ebc640 498 help='Allow multiple video streams to be merged into a single file')
909d24dd 499 video_format.add_option(
500 '--no-video-multistreams',
501 action='store_false', dest='allow_multiple_video_streams',
91ebc640 502 help='Only one video stream is downloaded for each output file (default)')
909d24dd 503 video_format.add_option(
504 '--audio-multistreams',
53ed7066 505 action='store_true', dest='allow_multiple_audio_streams', default=None,
91ebc640 506 help='Allow multiple audio streams to be merged into a single file')
909d24dd 507 video_format.add_option(
508 '--no-audio-multistreams',
509 action='store_false', dest='allow_multiple_audio_streams',
91ebc640 510 help='Only one audio stream is downloaded for each output file (default)')
8450c15c
PH
511 video_format.add_option(
512 '--all-formats',
513 action='store_const', dest='format', const='all',
d9aa2332 514 help=optparse.SUPPRESS_HELP)
8450c15c
PH
515 video_format.add_option(
516 '--prefer-free-formats',
517 action='store_true', dest='prefer_free_formats', default=False,
da9be05e 518 help=(
519 'Prefer video formats with free containers over non-free ones of same quality. '
520 'Use with "-S ext" to strictly prefer free containers irrespective of quality'))
521 video_format.add_option(
522 '--no-prefer-free-formats',
523 action='store_true', dest='prefer_free_formats', default=False,
524 help="Don't give any special preference to free containers (default)")
e8e73840 525 video_format.add_option(
526 '--check-formats',
527 action='store_true', dest='check_formats', default=False,
528 help="Check that the formats selected are actually downloadable (Experimental)")
8450c15c
PH
529 video_format.add_option(
530 '-F', '--list-formats',
531 action='store_true', dest='listformats',
4b3fbafd 532 help='List all available formats of requested videos')
76d321f6 533 video_format.add_option(
534 '--list-formats-as-table',
91ebc640 535 action='store_true', dest='listformats_table', default=True,
53ed7066 536 help=optparse.SUPPRESS_HELP)
76d321f6 537 video_format.add_option(
6623ac34 538 '--list-formats-old', '--no-list-formats-as-table',
76d321f6 539 action='store_false', dest='listformats_table',
53ed7066 540 help=optparse.SUPPRESS_HELP)
d120e901 541 video_format.add_option(
bd1a281e
PH
542 '--merge-output-format',
543 action='store', dest='merge_output_format', metavar='FORMAT', default=None,
d120e901 544 help=(
00334d0d
S
545 'If a merge is required (e.g. bestvideo+bestaudio), '
546 'output to given container format. One of mkv, mp4, ogg, webm, flv. '
d120e901 547 'Ignored if no merge is required'))
63ad4d43 548 video_format.add_option(
549 '--allow-unplayable-formats',
550 action='store_true', dest='allow_unplayable_formats', default=False,
551 help=(
552 'Allow unplayable formats to be listed and downloaded. '
e58c22a0 553 'All video post-processing will also be turned off'))
63ad4d43 554 video_format.add_option(
555 '--no-allow-unplayable-formats',
556 action='store_false', dest='allow_unplayable_formats',
557 help='Do not allow unplayable formats to be listed or downloaded (default)')
8450c15c
PH
558
559 subtitles = optparse.OptionGroup(parser, 'Subtitle Options')
560 subtitles.add_option(
6623ac34 561 '--write-subs', '--write-srt',
8450c15c 562 action='store_true', dest='writesubtitles', default=False,
17941321 563 help='Write subtitle file')
8450c15c 564 subtitles.add_option(
6623ac34 565 '--no-write-subs', '--no-write-srt',
566 action='store_false', dest='writesubtitles',
567 help='Do not write subtitle file (default)')
568 subtitles.add_option(
569 '--write-auto-subs', '--write-automatic-subs',
8450c15c 570 action='store_true', dest='writeautomaticsub', default=False,
e167860c 571 help='Write automatically generated subtitle file (Alias: --write-automatic-subs)')
6623ac34 572 subtitles.add_option(
573 '--no-write-auto-subs', '--no-write-automatic-subs',
574 action='store_false', dest='writeautomaticsub', default=False,
e167860c 575 help='Do not write auto-generated subtitles (default) (Alias: --no-write-automatic-subs)')
8450c15c
PH
576 subtitles.add_option(
577 '--all-subs',
578 action='store_true', dest='allsubtitles', default=False,
c32b0aab 579 help=optparse.SUPPRESS_HELP)
8450c15c
PH
580 subtitles.add_option(
581 '--list-subs',
582 action='store_true', dest='listsubtitles', default=False,
17941321 583 help='List all available subtitles for the video')
8450c15c
PH
584 subtitles.add_option(
585 '--sub-format',
a504ced0 586 action='store', dest='subtitlesformat', metavar='FORMAT', default='best',
4a3cdf81 587 help='Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"')
8450c15c 588 subtitles.add_option(
e167860c 589 '--sub-langs', '--srt-langs',
8450c15c 590 action='callback', dest='subtitleslangs', metavar='LANGS', type='str',
e632bce2 591 default=[], callback=_list_from_options_callback,
c32b0aab 592 help=(
593 'Languages of the subtitles to download (can be regex) or "all" separated by commas. (Eg: --sub-langs en.*,ja) '
594 'You can prefix the language code with a "-" to exempt it from the requested languages. (Eg: --sub-langs all,-live_chat) '
595 'Use --list-subs for a list of available language tags'))
8450c15c
PH
596
597 downloader = optparse.OptionGroup(parser, 'Download Options')
4cf1e5d2 598 downloader.add_option(
599 '-N', '--concurrent-fragments',
600 dest='concurrent_fragment_downloads', metavar='N', default=1, type=int,
b31fdeed 601 help='Number of fragments of a dash/hlsnative video that should be download concurrently (default is %default)')
8450c15c 602 downloader.add_option(
8ec2b2c4
S
603 '-r', '--limit-rate', '--rate-limit',
604 dest='ratelimit', metavar='RATE',
17941321 605 help='Maximum download rate in bytes per second (e.g. 50K or 4.2M)')
51d9739f 606 downloader.add_option(
607 '--throttled-rate',
608 dest='throttledratelimit', metavar='RATE',
609 help='Minimum download rate in bytes per second below which throttling is assumed and the video data is re-extracted (e.g. 100K)')
8450c15c
PH
610 downloader.add_option(
611 '-R', '--retries',
612 dest='retries', metavar='RETRIES', default=10,
8a51f564 613 help='Number of retries (default is %default), or "infinite"')
52bb437e
S
614 downloader.add_option(
615 '--fragment-retries',
616 dest='fragment_retries', metavar='RETRIES', default=10,
12ee65ea 617 help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)')
9603b660 618 downloader.add_option(
c76eb41b 619 '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragment',
9603b660 620 action='store_true', dest='skip_unavailable_fragments', default=True,
8a51f564 621 help='Skip unavailable fragments for DASH, hlsnative and ISM (default) (Alias: --no-abort-on-unavailable-fragment)')
732fb3f8 622 downloader.add_option(
6623ac34 623 '--abort-on-unavailable-fragment', '--no-skip-unavailable-fragments',
9603b660 624 action='store_false', dest='skip_unavailable_fragments',
8a51f564 625 help='Abort downloading if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
0eee52f3
S
626 downloader.add_option(
627 '--keep-fragments',
628 action='store_true', dest='keep_fragments', default=False,
6623ac34 629 help='Keep downloaded fragments on disk after downloading is finished')
630 downloader.add_option(
631 '--no-keep-fragments',
632 action='store_false', dest='keep_fragments',
633 help='Delete downloaded fragments after downloading is finished (default)')
8450c15c
PH
634 downloader.add_option(
635 '--buffer-size',
636 dest='buffersize', metavar='SIZE', default='1024',
17941321 637 help='Size of download buffer (e.g. 1024 or 16K) (default is %default)')
6623ac34 638 downloader.add_option(
639 '--resize-buffer',
640 action='store_false', dest='noresizebuffer',
641 help='The buffer size is automatically resized from an initial value of --buffer-size (default)')
8450c15c
PH
642 downloader.add_option(
643 '--no-resize-buffer',
644 action='store_true', dest='noresizebuffer', default=False,
6623ac34 645 help='Do not automatically adjust the buffer size')
ba515388
S
646 downloader.add_option(
647 '--http-chunk-size',
648 dest='http_chunk_size', metavar='SIZE', default=None,
6623ac34 649 help=(
650 'Size of a chunk for chunk-based HTTP downloading (e.g. 10485760 or 10M) (default is disabled). '
651 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)'))
8450c15c
PH
652 downloader.add_option(
653 '--test',
654 action='store_true', dest='test', default=False,
655 help=optparse.SUPPRESS_HELP)
ff815fe6
MS
656 downloader.add_option(
657 '--playlist-reverse',
658 action='store_true',
659 help='Download playlist videos in reverse order')
6623ac34 660 downloader.add_option(
661 '--no-playlist-reverse',
c76eb41b 662 action='store_false', dest='playlist_reverse',
6623ac34 663 help='Download playlist videos in default order (default)')
75822ca7
TC
664 downloader.add_option(
665 '--playlist-random',
666 action='store_true',
667 help='Download playlist videos in random order')
881e6a1f
PH
668 downloader.add_option(
669 '--xattr-set-filesize',
670 dest='xattr_set_filesize', action='store_true',
504f20dd 671 help='Set file xattribute ytdl.filesize with expected file size')
85729c51
PH
672 downloader.add_option(
673 '--hls-prefer-native',
bf09af3a 674 dest='hls_prefer_native', action='store_true', default=None,
52a8a1e1 675 help=optparse.SUPPRESS_HELP)
bf09af3a
S
676 downloader.add_option(
677 '--hls-prefer-ffmpeg',
678 dest='hls_prefer_native', action='store_false', default=None,
52a8a1e1 679 help=optparse.SUPPRESS_HELP)
7d106a65
JMF
680 downloader.add_option(
681 '--hls-use-mpegts',
9bd20204 682 dest='hls_use_mpegts', action='store_true', default=None,
6623ac34 683 help=(
9bd20204 684 'Use the mpegts container for HLS videos; '
685 'allowing some players to play the video while downloading, '
686 'and reducing the chance of file corruption if download is interrupted. '
687 'This is enabled by default for live streams'))
688 downloader.add_option(
689 '--no-hls-use-mpegts',
690 dest='hls_use_mpegts', action='store_false',
691 help=(
692 'Do not use the mpegts container for HLS videos. '
693 'This is default when not downloading live streams'))
222516d9 694 downloader.add_option(
52a8a1e1 695 '--downloader', '--external-downloader',
696 dest='external_downloader', metavar='[PROTO:]NAME', default={}, type='str',
e632bce2 697 action='callback', callback=_dict_from_options_callback,
52a8a1e1 698 callback_kwargs={
699 'allowed_keys': 'http|ftp|m3u8|dash|rtsp|rtmp|mms',
cc0ec3e1 700 'default_key': 'default',
701 'process': lambda x: x.strip()
702 },
6623ac34 703 help=(
52a8a1e1 704 'Name or path of the external downloader to use (optionally) prefixed by '
705 'the protocols (http, ftp, m3u8, dash, rstp, rtmp, mms) to use it for. '
706 'Currently supports native, %s (Recommended: aria2c). '
707 'You can use this option multiple times to set different downloaders for different protocols. '
708 'For example, --downloader aria2c --downloader "dash,m3u8:native" will use '
709 'aria2c for http/ftp downloads, and the native downloader for dash/m3u8 downloads '
710 '(Alias: --external-downloader)' % ', '.join(list_external_downloaders())))
c75f0b36 711 downloader.add_option(
46ee996e 712 '--downloader-args', '--external-downloader-args',
713 metavar='NAME:ARGS', dest='external_downloader_args', default={}, type='str',
e632bce2 714 action='callback', callback=_dict_from_options_callback,
b8f6bbe6 715 callback_kwargs={
0202b52a 716 'allowed_keys': '|'.join(list_external_downloaders()),
cc0ec3e1 717 'default_key': 'default',
718 'process': compat_shlex_split
719 },
46ee996e 720 help=(
721 'Give these arguments to the external downloader. '
722 'Specify the downloader name and the arguments separated by a colon ":". '
5d3a0e79 723 'You can use this option multiple times to give different arguments to different downloaders '
724 '(Alias: --external-downloader-args)'))
8450c15c
PH
725
726 workarounds = optparse.OptionGroup(parser, 'Workarounds')
34a741a8 727 workarounds.add_option(
8450c15c
PH
728 '--encoding',
729 dest='encoding', metavar='ENCODING',
34a741a8
PH
730 help='Force the specified encoding (experimental)')
731 workarounds.add_option(
8450c15c
PH
732 '--no-check-certificate',
733 action='store_true', dest='no_check_certificate', default=False,
17941321 734 help='Suppress HTTPS certificate validation')
34a741a8 735 workarounds.add_option(
6623ac34 736 '--prefer-insecure', '--prefer-unsecure',
737 action='store_true', dest='prefer_insecure',
e167860c 738 help='Use an unencrypted connection to retrieve information about the video (Currently supported only for YouTube)')
34a741a8 739 workarounds.add_option(
8450c15c
PH
740 '--user-agent',
741 metavar='UA', dest='user_agent',
17941321 742 help='Specify a custom user agent')
34a741a8 743 workarounds.add_option(
8450c15c
PH
744 '--referer',
745 metavar='URL', dest='referer', default=None,
17941321 746 help='Specify a custom referer, use if the video access is restricted to one domain',
34a741a8
PH
747 )
748 workarounds.add_option(
8450c15c 749 '--add-header',
45016689 750 metavar='FIELD:VALUE', dest='headers', default={}, type='str',
e632bce2 751 action='callback', callback=_dict_from_options_callback,
d818eb74 752 callback_kwargs={'multiple_keys': False},
45016689 753 help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times',
34a741a8
PH
754 )
755 workarounds.add_option(
8450c15c
PH
756 '--bidi-workaround',
757 dest='bidi_workaround', action='store_true',
758 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
1cf376f5 759 workarounds.add_option(
760 '--sleep-requests', metavar='SECONDS',
761 dest='sleep_interval_requests', type=float,
762 help='Number of seconds to sleep between requests during data extraction')
5f0d813d 763 workarounds.add_option(
065bc354 764 '--sleep-interval', '--min-sleep-interval', metavar='SECONDS',
649f7966 765 dest='sleep_interval', type=float,
7aa589a5 766 help=(
e167860c 767 'Number of seconds to sleep before each download. '
768 'This is the minimum time to sleep when used along with --max-sleep-interval '
769 '(Alias: --min-sleep-interval)'))
065bc354 770 workarounds.add_option(
771 '--max-sleep-interval', metavar='SECONDS',
772 dest='max_sleep_interval', type=float,
e167860c 773 help='Maximum number of seconds to sleep. Can only be used along with --min-sleep-interval')
0c9df79e 774 workarounds.add_option(
c76eb41b 775 '--sleep-subtitles', metavar='SECONDS',
31108ce9 776 dest='sleep_interval_subtitles', default=0, type=int,
1cf376f5 777 help='Number of seconds to sleep before each subtitle download')
34a741a8 778
0744a815 779 verbosity = optparse.OptionGroup(parser, 'Verbosity and Simulation Options')
8450c15c
PH
780 verbosity.add_option(
781 '-q', '--quiet',
782 action='store_true', dest='quiet', default=False,
17941321 783 help='Activate quiet mode')
34a741a8
PH
784 verbosity.add_option(
785 '--no-warnings',
786 dest='no_warnings', action='store_true', default=False,
787 help='Ignore warnings')
8450c15c
PH
788 verbosity.add_option(
789 '-s', '--simulate',
790 action='store_true', dest='simulate', default=False,
17941321 791 help='Do not download the video and do not write anything to disk')
b7da73eb 792 verbosity.add_option(
793 '--ignore-no-formats-error',
794 action='store_true', dest='ignore_no_formats_error', default=False,
795 help=(
796 'Ignore "No video formats" error. Usefull for extracting metadata '
797 'even if the video is not actually available for download (experimental)'))
798 verbosity.add_option(
799 '--no-ignore-no-formats-error',
800 action='store_false', dest='ignore_no_formats_error',
801 help='Throw error when no downloadable video formats are found (default)')
8450c15c 802 verbosity.add_option(
6623ac34 803 '--skip-download', '--no-download',
8450c15c 804 action='store_true', dest='skip_download', default=False,
e167860c 805 help='Do not download the video but write all related files (Alias: --no-download)')
53c18592 806 verbosity.add_option(
807 '-O', '--print', metavar='TEMPLATE',
d2a1fad9 808 action='callback', dest='forceprint', type='str', default=[],
53c18592 809 callback=_list_from_options_callback, callback_kwargs={'delim': None},
810 help=(
811 'Simulate, quiet but print the given fields. Either a field name '
812 'or similar formatting as the output template can be used'))
8450c15c
PH
813 verbosity.add_option(
814 '-g', '--get-url',
815 action='store_true', dest='geturl', default=False,
53c18592 816 help=optparse.SUPPRESS_HELP)
8450c15c
PH
817 verbosity.add_option(
818 '-e', '--get-title',
819 action='store_true', dest='gettitle', default=False,
53c18592 820 help=optparse.SUPPRESS_HELP)
8450c15c
PH
821 verbosity.add_option(
822 '--get-id',
823 action='store_true', dest='getid', default=False,
53c18592 824 help=optparse.SUPPRESS_HELP)
8450c15c
PH
825 verbosity.add_option(
826 '--get-thumbnail',
827 action='store_true', dest='getthumbnail', default=False,
53c18592 828 help=optparse.SUPPRESS_HELP)
8450c15c
PH
829 verbosity.add_option(
830 '--get-description',
831 action='store_true', dest='getdescription', default=False,
53c18592 832 help=optparse.SUPPRESS_HELP)
8450c15c
PH
833 verbosity.add_option(
834 '--get-duration',
835 action='store_true', dest='getduration', default=False,
53c18592 836 help=optparse.SUPPRESS_HELP)
8450c15c
PH
837 verbosity.add_option(
838 '--get-filename',
839 action='store_true', dest='getfilename', default=False,
53c18592 840 help=optparse.SUPPRESS_HELP)
8450c15c
PH
841 verbosity.add_option(
842 '--get-format',
843 action='store_true', dest='getformat', default=False,
53c18592 844 help=optparse.SUPPRESS_HELP)
8450c15c
PH
845 verbosity.add_option(
846 '-j', '--dump-json',
847 action='store_true', dest='dumpjson', default=False,
8a51f564 848 help='Simulate, quiet but print JSON information. See "OUTPUT TEMPLATE" for a description of available keys')
63e0be34
PH
849 verbosity.add_option(
850 '-J', '--dump-single-json',
851 action='store_true', dest='dump_single_json', default=False,
6623ac34 852 help=(
c76eb41b 853 'Simulate, quiet but print JSON information for each command-line argument. '
8a51f564 854 'If the URL refers to a playlist, dump the whole playlist information in a single line'))
c0bdf32a
PH
855 verbosity.add_option(
856 '--print-json',
857 action='store_true', dest='print_json', default=False,
8a51f564 858 help='Be quiet and print the video information as JSON (video is still being downloaded)')
2d30509f 859 verbosity.add_option(
c76eb41b 860 '--force-write-archive', '--force-write-download-archive', '--force-download-archive',
2d30509f 861 action='store_true', dest='force_write_download_archive', default=False,
862 help=(
e58c22a0 863 'Force download archive entries to be written as far as no errors occur, '
864 'even if -s or another simulation option is used (Alias: --force-download-archive)'))
8450c15c
PH
865 verbosity.add_option(
866 '--newline',
867 action='store_true', dest='progress_with_newline', default=False,
17941321 868 help='Output progress bar as new lines')
8450c15c
PH
869 verbosity.add_option(
870 '--no-progress',
871 action='store_true', dest='noprogress', default=False,
17941321 872 help='Do not print progress bar')
8450c15c
PH
873 verbosity.add_option(
874 '--console-title',
875 action='store_true', dest='consoletitle', default=False,
17941321 876 help='Display progress in console titlebar')
8450c15c
PH
877 verbosity.add_option(
878 '-v', '--verbose',
879 action='store_true', dest='verbose', default=False,
17941321 880 help='Print various debugging information')
8450c15c 881 verbosity.add_option(
8bba753c 882 '--dump-pages', '--dump-intermediate-pages',
8450c15c 883 action='store_true', dest='dump_intermediate_pages', default=False,
79979c68 884 help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
8450c15c
PH
885 verbosity.add_option(
886 '--write-pages',
887 action='store_true', dest='write_pages', default=False,
888 help='Write downloaded intermediary pages to files in the current directory to debug problems')
889 verbosity.add_option(
890 '--youtube-print-sig-code',
891 action='store_true', dest='youtube_print_sig_code', default=False,
892 help=optparse.SUPPRESS_HELP)
893 verbosity.add_option(
2f543a21 894 '--print-traffic', '--dump-headers',
8450c15c
PH
895 dest='debug_printtraffic', action='store_true', default=False,
896 help='Display sent and read HTTP traffic')
58b1f00d
PH
897 verbosity.add_option(
898 '-C', '--call-home',
899 dest='call_home', action='store_true', default=False,
7a5c1cfe 900 # help='[Broken] Contact the yt-dlp server for debugging')
8d801631 901 help=optparse.SUPPRESS_HELP)
8bfa7545
PH
902 verbosity.add_option(
903 '--no-call-home',
6623ac34 904 dest='call_home', action='store_false',
7a5c1cfe 905 # help='Do not contact the yt-dlp server for debugging (default)')
8d801631 906 help=optparse.SUPPRESS_HELP)
8450c15c
PH
907
908 filesystem = optparse.OptionGroup(parser, 'Filesystem Options')
909 filesystem.add_option(
910 '-a', '--batch-file',
911 dest='batchfile', metavar='FILE',
5d60b997 912 help="File containing URLs to download ('-' for stdin), one URL per line. "
8a51f564 913 "Lines starting with '#', ';' or ']' are considered as comments and ignored")
8450c15c
PH
914 filesystem.add_option(
915 '--id', default=False,
6623ac34 916 action='store_true', dest='useid', help=optparse.SUPPRESS_HELP)
0202b52a 917 filesystem.add_option(
918 '-P', '--paths',
d818eb74 919 metavar='TYPES:PATH', dest='paths', default={}, type='str',
e632bce2 920 action='callback', callback=_dict_from_options_callback,
cc0ec3e1 921 callback_kwargs={'allowed_keys': 'home|temp|%s' % '|'.join(OUTTMPL_TYPES.keys())},
0202b52a 922 help=(
923 'The paths where the files should be downloaded. '
de6000d9 924 'Specify the type of file and the path separated by a colon ":". '
925 'All the same types as --output are supported. '
0202b52a 926 'Additionally, you can also provide "home" and "temp" paths. '
927 'All intermediary files are first downloaded to the temp path and '
928 'then the final files are moved over to the home path after download is finished. '
de6000d9 929 'This option is ignored if --output is an absolute path'))
8450c15c
PH
930 filesystem.add_option(
931 '-o', '--output',
d818eb74 932 metavar='[TYPES:]TEMPLATE', dest='outtmpl', default={}, type='str',
e632bce2 933 action='callback', callback=_dict_from_options_callback,
de6000d9 934 callback_kwargs={
935 'allowed_keys': '|'.join(OUTTMPL_TYPES.keys()),
cc0ec3e1 936 'default_key': 'default'
937 },
73cd218f 938 help='Output filename template; see "OUTPUT TEMPLATE" for details')
a820dc72
RA
939 filesystem.add_option(
940 '--output-na-placeholder',
0bc0a322 941 dest='outtmpl_na_placeholder', metavar='TEXT', default='NA',
942 help=('Placeholder value for unavailable meta fields in output filename template (default: "%default")'))
8450c15c
PH
943 filesystem.add_option(
944 '--autonumber-size',
be5df5ee
S
945 dest='autonumber_size', metavar='NUMBER', type=int,
946 help=optparse.SUPPRESS_HELP)
acbb2374
CP
947 filesystem.add_option(
948 '--autonumber-start',
1a241a2d 949 dest='autonumber_start', metavar='NUMBER', default=1, type=int,
a439a3a4 950 help=optparse.SUPPRESS_HELP)
8450c15c
PH
951 filesystem.add_option(
952 '--restrict-filenames',
953 action='store_true', dest='restrictfilenames', default=False,
954 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
6623ac34 955 filesystem.add_option(
956 '--no-restrict-filenames',
c2934512 957 action='store_false', dest='restrictfilenames',
6623ac34 958 help='Allow Unicode characters, "&" and spaces in filenames (default)')
c2934512 959 filesystem.add_option(
960 '--windows-filenames',
961 action='store_true', dest='windowsfilenames', default=False,
962 help='Force filenames to be windows compatible')
963 filesystem.add_option(
964 '--no-windows-filenames',
965 action='store_false', dest='windowsfilenames',
966 help='Make filenames windows compatible only if using windows (default)')
967 filesystem.add_option(
968 '--trim-filenames', '--trim-file-names', metavar='LENGTH',
969 dest='trim_file_name', default=0, type=int,
970 help='Limit the filename length (excluding extension) to the specified number of characters')
2865cf04 971 filesystem.add_option(
486fb179 972 '--auto-number',
2865cf04 973 action='store_true', dest='autonumber', default=False,
be5df5ee 974 help=optparse.SUPPRESS_HELP)
8450c15c 975 filesystem.add_option(
486fb179 976 '--title',
8450c15c 977 action='store_true', dest='usetitle', default=False,
be5df5ee 978 help=optparse.SUPPRESS_HELP)
8450c15c 979 filesystem.add_option(
486fb179 980 '--literal', default=False,
8450c15c 981 action='store_true', dest='usetitle',
be5df5ee 982 help=optparse.SUPPRESS_HELP)
8450c15c
PH
983 filesystem.add_option(
984 '-w', '--no-overwrites',
0c3d0f51 985 action='store_false', dest='overwrites', default=None,
986 help='Do not overwrite any files')
987 filesystem.add_option(
988 '--force-overwrites', '--yes-overwrites',
989 action='store_true', dest='overwrites',
990 help='Overwrite all video and metadata files. This option includes --no-continue')
991 filesystem.add_option(
992 '--no-force-overwrites',
993 action='store_const', dest='overwrites', const=None,
994 help='Do not overwrite the video, but overwrite related files (default)')
8450c15c
PH
995 filesystem.add_option(
996 '-c', '--continue',
997 action='store_true', dest='continue_dl', default=True,
c25228e5 998 help='Resume partially downloaded files/fragments (default)')
8450c15c
PH
999 filesystem.add_option(
1000 '--no-continue',
1001 action='store_false', dest='continue_dl',
c25228e5 1002 help=(
1003 'Do not resume partially downloaded fragments. '
e58c22a0 1004 'If the file is not fragmented, restart download of the entire file'))
6623ac34 1005 filesystem.add_option(
1006 '--part',
1007 action='store_false', dest='nopart', default=False,
1008 help='Use .part files instead of writing directly into output file (default)')
8450c15c
PH
1009 filesystem.add_option(
1010 '--no-part',
6623ac34 1011 action='store_true', dest='nopart',
17941321 1012 help='Do not use .part files - write directly into output file')
6623ac34 1013 filesystem.add_option(
1014 '--mtime',
1015 action='store_true', dest='updatetime', default=True,
1016 help='Use the Last-modified header to set the file modification time (default)')
8450c15c
PH
1017 filesystem.add_option(
1018 '--no-mtime',
6623ac34 1019 action='store_false', dest='updatetime',
17941321 1020 help='Do not use the Last-modified header to set the file modification time')
8450c15c
PH
1021 filesystem.add_option(
1022 '--write-description',
1023 action='store_true', dest='writedescription', default=False,
17941321 1024 help='Write video description to a .description file')
6623ac34 1025 filesystem.add_option(
1026 '--no-write-description',
1027 action='store_false', dest='writedescription',
1028 help='Do not write video description (default)')
8450c15c
PH
1029 filesystem.add_option(
1030 '--write-info-json',
1031 action='store_true', dest='writeinfojson', default=False,
c25228e5 1032 help='Write video metadata to a .info.json file (this may contain personal information)')
6623ac34 1033 filesystem.add_option(
1034 '--no-write-info-json',
1035 action='store_false', dest='writeinfojson',
1036 help='Do not write video metadata (default)')
8450c15c
PH
1037 filesystem.add_option(
1038 '--write-annotations',
1039 action='store_true', dest='writeannotations', default=False,
0669c89c 1040 help='Write video annotations to a .annotations.xml file')
6623ac34 1041 filesystem.add_option(
1042 '--no-write-annotations',
1043 action='store_false', dest='writeannotations',
1044 help='Do not write video annotations (default)')
cac96421 1045 filesystem.add_option(
1046 '--write-playlist-metafiles',
53ed7066 1047 action='store_true', dest='allow_playlist_files', default=None,
cac96421 1048 help=(
1049 'Write playlist metadata in addition to the video metadata '
1050 'when using --write-info-json, --write-description etc. (default)'))
1051 filesystem.add_option(
1052 '--no-write-playlist-metafiles',
1053 action='store_false', dest='allow_playlist_files',
e167860c 1054 help='Do not write playlist metadata when using --write-info-json, --write-description etc.')
75d43ca0 1055 filesystem.add_option(
1056 '--clean-infojson',
1057 action='store_true', dest='clean_infojson', default=True,
1058 help=(
1059 'Remove some private fields such as filenames from the infojson. '
1060 'Note that it could still contain some personal information (default)'))
1061 filesystem.add_option(
1062 '--no-clean-infojson',
1063 action='store_false', dest='clean_infojson',
1064 help='Write all fields to the infojson')
06167fbb 1065 filesystem.add_option(
2305e2e5 1066 '--write-comments', '--get-comments',
06167fbb 1067 action='store_true', dest='getcomments', default=False,
277d6ff5 1068 help=(
2305e2e5 1069 'Retrieve video comments to be placed in the infojson. '
1070 'The comments are fetched even without this option if the extraction is known to be quick (Alias: --get-comments)'))
1071 filesystem.add_option(
1072 '--no-write-comments', '--no-get-comments',
1073 action='store_true', dest='getcomments', default=False,
1074 help='Do not retrieve video comments unless the extraction is known to be quick (Alias: --no-get-comments)')
8450c15c 1075 filesystem.add_option(
244fe977 1076 '--load-info-json', '--load-info',
8450c15c 1077 dest='load_info_filename', metavar='FILE',
1a48181a 1078 help='JSON file containing the video information (created with the "--write-info-json" option)')
8450c15c
PH
1079 filesystem.add_option(
1080 '--cookies',
1081 dest='cookiefile', metavar='FILE',
17941321 1082 help='File to read cookies from and dump cookie jar in')
6623ac34 1083 filesystem.add_option(
1084 '--no-cookies',
1085 action='store_const', const=None, dest='cookiefile', metavar='FILE',
1086 help='Do not read/dump cookies (default)')
34a741a8
PH
1087 filesystem.add_option(
1088 '--cache-dir', dest='cachedir', default=None, metavar='DIR',
3b1fe47d 1089 help='Location in the filesystem where youtube-dl can store some downloaded information (such as client ids and signatures) permanently. By default $XDG_CACHE_HOME/youtube-dl or ~/.cache/youtube-dl')
34a741a8 1090 filesystem.add_option(
6623ac34 1091 '--no-cache-dir', action='store_false', dest='cachedir',
34a741a8
PH
1092 help='Disable filesystem caching')
1093 filesystem.add_option(
8450c15c
PH
1094 '--rm-cache-dir',
1095 action='store_true', dest='rm_cachedir',
34a741a8
PH
1096 help='Delete all filesystem cache files')
1097
b31fdeed 1098 thumbnail = optparse.OptionGroup(parser, 'Thumbnail Options')
cfb56d1a
PH
1099 thumbnail.add_option(
1100 '--write-thumbnail',
1101 action='store_true', dest='writethumbnail', default=False,
17941321 1102 help='Write thumbnail image to disk')
6623ac34 1103 thumbnail.add_option(
1104 '--no-write-thumbnail',
1105 action='store_false', dest='writethumbnail',
1106 help='Do not write thumbnail image to disk (default)')
ec82d85a
PH
1107 thumbnail.add_option(
1108 '--write-all-thumbnails',
1109 action='store_true', dest='write_all_thumbnails', default=False,
17941321 1110 help='Write all thumbnail image formats to disk')
cfb56d1a
PH
1111 thumbnail.add_option(
1112 '--list-thumbnails',
1113 action='store_true', dest='list_thumbnails', default=False,
1114 help='Simulate and list all available thumbnail formats')
1115
732044af 1116 link = optparse.OptionGroup(parser, 'Internet Shortcut Options')
1117 link.add_option(
1118 '--write-link',
1119 action='store_true', dest='writelink', default=False,
8a51f564 1120 help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
732044af 1121 link.add_option(
1122 '--write-url-link',
1123 action='store_true', dest='writeurllink', default=False,
8a51f564 1124 help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
732044af 1125 link.add_option(
1126 '--write-webloc-link',
1127 action='store_true', dest='writewebloclink', default=False,
8a51f564 1128 help='Write a .webloc macOS internet shortcut')
732044af 1129 link.add_option(
1130 '--write-desktop-link',
1131 action='store_true', dest='writedesktoplink', default=False,
8a51f564 1132 help='Write a .desktop Linux internet shortcut')
732044af 1133
1134 postproc = optparse.OptionGroup(parser, 'Post-Processing Options')
8450c15c
PH
1135 postproc.add_option(
1136 '-x', '--extract-audio',
1137 action='store_true', dest='extractaudio', default=False,
e4172ac9 1138 help='Convert video files to audio-only files (requires ffmpeg and ffprobe)')
8450c15c
PH
1139 postproc.add_option(
1140 '--audio-format', metavar='FORMAT', dest='audioformat', default='best',
81a23040 1141 help=(
1142 'Specify audio format to convert the audio to when -x is used. Currently supported formats are: '
1143 'best (default) or one of %s' % '|'.join(FFmpegExtractAudioPP.SUPPORTED_EXTS)))
8450c15c
PH
1144 postproc.add_option(
1145 '--audio-quality', metavar='QUALITY',
1146 dest='audioquality', default='5',
e4172ac9 1147 help='Specify ffmpeg audio quality, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default %default)')
efe87a10
FS
1148 postproc.add_option(
1149 '--remux-video',
1150 metavar='FORMAT', dest='remuxvideo', default=None,
6623ac34 1151 help=(
17912249 1152 'Remux the video into another container if necessary (currently supported: %s). '
06167fbb 1153 'If target container does not support the video/audio codec, remuxing will fail. '
81a23040 1154 'You can specify multiple rules; Eg. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 '
1155 'and anything else to mkv.' % '|'.join(FFmpegVideoRemuxerPP.SUPPORTED_EXTS)))
8450c15c
PH
1156 postproc.add_option(
1157 '--recode-video',
1158 metavar='FORMAT', dest='recodevideo', default=None,
17912249 1159 help=(
1160 'Re-encode the video into another format if re-encoding is necessary. '
81a23040 1161 'The syntax and supported formats are the same as --remux-video'))
d84f1d14 1162 postproc.add_option(
45016689 1163 '--postprocessor-args', '--ppa',
1164 metavar='NAME:ARGS', dest='postprocessor_args', default={}, type='str',
e632bce2 1165 action='callback', callback=_dict_from_options_callback,
d818eb74 1166 callback_kwargs={
1167 'allowed_keys': r'\w+(?:\+\w+)?', 'default_key': 'default-compat',
cc0ec3e1 1168 'process': compat_shlex_split,
1169 'multiple_keys': False
1170 },
1b77b347 1171 help=(
1172 'Give these arguments to the postprocessors. '
43820c03 1173 'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
8fa43c73 1174 'to give the argument to the specified postprocessor/executable. Supported PP are: '
1175 'Merger, ExtractAudio, SplitChapters, Metadata, EmbedSubtitle, EmbedThumbnail, '
1176 'SubtitlesConvertor, ThumbnailsConvertor, VideoRemuxer, VideoConvertor, '
e36d50c5 1177 'SponSkrub, FixupStretched, FixupM4a, FixupM3u8, FixupTimestamp and FixupDuration. '
8fa43c73 1178 'The supported executables are: AtomicParsley, FFmpeg, FFprobe, and SponSkrub. '
43820c03 1179 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
5b1ecbb3 1180 'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, '
597c1866 1181 '"_i"/"_o" can be appended to the prefix optionally followed by a number to pass the argument '
1182 'before the specified input/output file. Eg: --ppa "Merger+ffmpeg_i1:-v quiet". '
5b1ecbb3 1183 'You can use this option multiple times to give different arguments to different '
1184 'postprocessors. (Alias: --ppa)'))
8450c15c
PH
1185 postproc.add_option(
1186 '-k', '--keep-video',
1187 action='store_true', dest='keepvideo', default=False,
6623ac34 1188 help='Keep the intermediate video file on disk after post-processing')
1189 postproc.add_option(
1190 '--no-keep-video',
1191 action='store_false', dest='keepvideo',
1192 help='Delete the intermediate video file after post-processing (default)')
1193 postproc.add_option(
1194 '--post-overwrites',
1195 action='store_false', dest='nopostoverwrites',
1196 help='Overwrite post-processed files (default)')
8450c15c
PH
1197 postproc.add_option(
1198 '--no-post-overwrites',
1199 action='store_true', dest='nopostoverwrites', default=False,
6623ac34 1200 help='Do not overwrite post-processed files')
8450c15c
PH
1201 postproc.add_option(
1202 '--embed-subs',
1203 action='store_true', dest='embedsubtitles', default=False,
40025ee2 1204 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
6623ac34 1205 postproc.add_option(
1206 '--no-embed-subs',
1207 action='store_false', dest='embedsubtitles',
1208 help='Do not embed subtitles (default)')
8450c15c
PH
1209 postproc.add_option(
1210 '--embed-thumbnail',
1211 action='store_true', dest='embedthumbnail', default=False,
6aecd871 1212 help='Embed thumbnail in the video as cover art')
6623ac34 1213 postproc.add_option(
1214 '--no-embed-thumbnail',
1215 action='store_false', dest='embedthumbnail',
1216 help='Do not embed thumbnail (default)')
8450c15c 1217 postproc.add_option(
7e067091 1218 '--embed-metadata', '--add-metadata',
8450c15c 1219 action='store_true', dest='addmetadata', default=False,
7e067091 1220 help='Embed metadata including chapter markers (if supported by the format) to the video file (Alias: --add-metadata)')
6623ac34 1221 postproc.add_option(
7e067091 1222 '--no-embed-metadata', '--no-add-metadata',
6623ac34 1223 action='store_false', dest='addmetadata',
7e067091 1224 help='Do not write metadata (default) (Alias: --no-add-metadata)')
e7db87f7 1225 postproc.add_option(
1226 '--metadata-from-title',
1227 metavar='FORMAT', dest='metafromtitle',
5bfa4862 1228 help=optparse.SUPPRESS_HELP)
1229 postproc.add_option(
1230 '--parse-metadata',
73cd218f 1231 metavar='FROM:TO', dest='metafromfield', action='append',
6623ac34 1232 help=(
73cd218f 1233 'Parse additional metadata like title/artist from other fields; '
1234 'see "MODIFYING METADATA" for details'))
8450c15c
PH
1235 postproc.add_option(
1236 '--xattrs',
1237 action='store_true', dest='xattrs', default=False,
17941321 1238 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
6271f1ca
PH
1239 postproc.add_option(
1240 '--fixup',
99594a11 1241 metavar='POLICY', dest='fixup', default=None,
f89b3e2d 1242 choices=('never', 'ignore', 'warn', 'detect_or_warn', 'force'),
6623ac34 1243 help=(
1244 'Automatically correct known faults of the file. '
1245 'One of never (do nothing), warn (only emit a warning), '
f89b3e2d 1246 'detect_or_warn (the default; fix file if we can, warn otherwise), '
1247 'force (try fixing even if file already exists'))
8450c15c 1248 postproc.add_option(
6623ac34 1249 '--prefer-avconv', '--no-prefer-ffmpeg',
8450c15c 1250 action='store_false', dest='prefer_ffmpeg',
e4172ac9 1251 help=optparse.SUPPRESS_HELP)
8450c15c 1252 postproc.add_option(
6623ac34 1253 '--prefer-ffmpeg', '--no-prefer-avconv',
e4172ac9 1254 action='store_true', dest='prefer_ffmpeg', default=True,
1255 help=optparse.SUPPRESS_HELP)
73fac4e9
PH
1256 postproc.add_option(
1257 '--ffmpeg-location', '--avconv-location', metavar='PATH',
1258 dest='ffmpeg_location',
e4172ac9 1259 help='Location of the ffmpeg binary; either the path to the binary or its containing directory')
34a741a8 1260 postproc.add_option(
8450c15c
PH
1261 '--exec',
1262 metavar='CMD', dest='exec_cmd',
9de3ea31 1263 help=(
1264 'Execute a command on the file after downloading and post-processing. '
1265 'Similar syntax to the output template can be used to pass any field as arguments to the command. '
1266 'An additional field "filepath" that contains the final path of the downloaded file is also available. '
1267 'If no fields are passed, "%(filepath)s" is appended to the end of the command'))
5520aa2d 1268 postproc.add_option(
1269 '--exec-before-download',
1270 metavar='CMD', dest='exec_before_dl_cmd',
1271 help='Execute a command before the actual download. The syntax is the same as --exec')
e9fade72 1272 postproc.add_option(
e167860c 1273 '--convert-subs', '--convert-sub', '--convert-subtitles',
e9fade72 1274 metavar='FORMAT', dest='convertsubtitles', default=None,
81a23040 1275 help=(
1276 'Convert the subtitles to another format (currently supported: %s) '
1277 '(Alias: --convert-subtitles)' % '|'.join(FFmpegSubtitlesConvertorPP.SUPPORTED_EXTS)))
8fa43c73 1278 postproc.add_option(
1279 '--convert-thumbnails',
1280 metavar='FORMAT', dest='convertthumbnails', default=None,
81a23040 1281 help=(
1282 'Convert the thumbnails to another format '
1283 '(currently supported: %s) ' % '|'.join(FFmpegThumbnailsConvertorPP.SUPPORTED_EXTS)))
72755351 1284 postproc.add_option(
1285 '--split-chapters', '--split-tracks',
1286 dest='split_chapters', action='store_true', default=False,
1287 help=(
1288 'Split video into multiple files based on internal chapters. '
1289 'The "chapter:" prefix can be used with "--paths" and "--output" to '
1290 'set the output filename for the split files. See "OUTPUT TEMPLATE" for details'))
1291 postproc.add_option(
1292 '--no-split-chapters', '--no-split-tracks',
1293 dest='split_chapters', action='store_false',
1294 help='Do not split video based on chapters (default)')
34a741a8 1295
8a51f564 1296 sponskrub = optparse.OptionGroup(parser, 'SponSkrub (SponsorBlock) Options', description=(
7a5c1cfe 1297 'SponSkrub (https://github.com/yt-dlp/SponSkrub) is a utility to mark/remove sponsor segments '
8a51f564 1298 'from downloaded YouTube videos using SponsorBlock API (https://sponsor.ajay.app)'))
c76eb41b 1299 sponskrub.add_option(
a9e7f546 1300 '--sponskrub',
1301 action='store_true', dest='sponskrub', default=None,
6623ac34 1302 help=(
8a51f564 1303 'Use sponskrub to mark sponsored sections. '
6623ac34 1304 'This is enabled by default if the sponskrub binary exists (Youtube only)'))
c76eb41b 1305 sponskrub.add_option(
a9e7f546 1306 '--no-sponskrub',
1307 action='store_false', dest='sponskrub',
6623ac34 1308 help='Do not use sponskrub')
c76eb41b 1309 sponskrub.add_option(
a9e7f546 1310 '--sponskrub-cut', default=False,
1311 action='store_true', dest='sponskrub_cut',
1312 help='Cut out the sponsor sections instead of simply marking them')
c76eb41b 1313 sponskrub.add_option(
6623ac34 1314 '--no-sponskrub-cut',
1315 action='store_false', dest='sponskrub_cut',
1316 help='Simply mark the sponsor sections, not cut them out (default)')
c76eb41b 1317 sponskrub.add_option(
a9e7f546 1318 '--sponskrub-force', default=False,
1319 action='store_true', dest='sponskrub_force',
1320 help='Run sponskrub even if the video was already downloaded')
c76eb41b 1321 sponskrub.add_option(
6623ac34 1322 '--no-sponskrub-force',
1323 action='store_true', dest='sponskrub_force',
1324 help='Do not cut out the sponsor sections if the video was already downloaded (default)')
c76eb41b 1325 sponskrub.add_option(
a9e7f546 1326 '--sponskrub-location', metavar='PATH',
1327 dest='sponskrub_path', default='',
8a51f564 1328 help='Location of the sponskrub binary; either the path to the binary or its containing directory')
c76eb41b 1329 sponskrub.add_option(
1330 '--sponskrub-args', dest='sponskrub_args', metavar='ARGS',
1b77b347 1331 help=optparse.SUPPRESS_HELP)
a9e7f546 1332
78895bd3 1333 extractor = optparse.OptionGroup(parser, 'Extractor Options')
62bff2c1 1334 extractor.add_option(
1335 '--extractor-retries',
d6e51845 1336 dest='extractor_retries', metavar='RETRIES', default=3,
62bff2c1 1337 help='Number of retries for known extractor errors (default is %default), or "infinite"')
78895bd3 1338 extractor.add_option(
6623ac34 1339 '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
78895bd3 1340 action='store_true', dest='dynamic_mpd', default=True,
8a51f564 1341 help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
78895bd3 1342 extractor.add_option(
6623ac34 1343 '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
78895bd3 1344 action='store_false', dest='dynamic_mpd',
8a51f564 1345 help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
310c2ed2 1346 extractor.add_option(
1347 '--hls-split-discontinuity',
1348 dest='hls_split_discontinuity', action='store_true', default=False,
1349 help='Split HLS playlists to different formats at discontinuities such as ad breaks'
1350 )
1351 extractor.add_option(
1352 '--no-hls-split-discontinuity',
1353 dest='hls_split_discontinuity', action='store_false',
1354 help='Do not split HLS playlists to different formats at discontinuities such as ad breaks (default)')
4bb6b02f 1355 _extractor_arg_parser = lambda key, vals='': (key.strip().lower(), [val.strip() for val in vals.split(',')])
5d3a0e79 1356 extractor.add_option(
1357 '--extractor-args',
1358 metavar='KEY:ARGS', dest='extractor_args', default={}, type='str',
1359 action='callback', callback=_dict_from_options_callback,
1360 callback_kwargs={
1361 'multiple_keys': False,
1362 'process': lambda val: dict(
4bb6b02f 1363 _extractor_arg_parser(*arg.split('=', 1)) for arg in val.split(';'))
5d3a0e79 1364 },
1365 help=(
1366 'Pass these arguments to the extractor. See "EXTRACTOR ARGUMENTS" for details. '
4bb6b02f 1367 'You can use this option multiple times to give arguments for different extractors'))
e409895f 1368 extractor.add_option(
1369 '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
1370 action='store_true', dest='youtube_include_dash_manifest', default=True,
5d3a0e79 1371 help=optparse.SUPPRESS_HELP)
e409895f 1372 extractor.add_option(
1373 '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
1374 action='store_false', dest='youtube_include_dash_manifest',
5d3a0e79 1375 help=optparse.SUPPRESS_HELP)
e409895f 1376 extractor.add_option(
1377 '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
1378 action='store_true', dest='youtube_include_hls_manifest', default=True,
5d3a0e79 1379 help=optparse.SUPPRESS_HELP)
e409895f 1380 extractor.add_option(
1381 '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
1382 action='store_false', dest='youtube_include_hls_manifest',
5d3a0e79 1383 help=optparse.SUPPRESS_HELP)
78895bd3 1384
34a741a8 1385 parser.add_option_group(general)
be4a824d 1386 parser.add_option_group(network)
0aa10994 1387 parser.add_option_group(geo)
34a741a8
PH
1388 parser.add_option_group(selection)
1389 parser.add_option_group(downloader)
1390 parser.add_option_group(filesystem)
cfb56d1a 1391 parser.add_option_group(thumbnail)
732044af 1392 parser.add_option_group(link)
34a741a8
PH
1393 parser.add_option_group(verbosity)
1394 parser.add_option_group(workarounds)
1395 parser.add_option_group(video_format)
1396 parser.add_option_group(subtitles)
1397 parser.add_option_group(authentication)
1398 parser.add_option_group(postproc)
c76eb41b 1399 parser.add_option_group(sponskrub)
78895bd3 1400 parser.add_option_group(extractor)
34a741a8
PH
1401
1402 if overrideArguments is not None:
1403 opts, args = parser.parse_args(overrideArguments)
1404 if opts.verbose:
8450c15c 1405 write_string('[debug] Override config: ' + repr(overrideArguments) + '\n')
34a741a8 1406 else:
b04b94da
S
1407 def compat_conf(conf):
1408 if sys.version_info < (3,):
1409 return [a.decode(preferredencoding(), 'replace') for a in conf]
1410 return conf
1411
e2e43aea 1412 configs = {
0202b52a 1413 'command-line': compat_conf(sys.argv[1:]),
1414 'custom': [], 'home': [], 'portable': [], 'user': [], 'system': []}
1415 paths = {'command-line': False}
1416 opts, args = parser.parse_args(configs['command-line'])
f5e2efbb 1417
e2e43aea 1418 def get_configs():
0202b52a 1419 if '--config-location' in configs['command-line']:
e2e43aea 1420 location = compat_expanduser(opts.config_location)
1421 if os.path.isdir(location):
7a5c1cfe 1422 location = os.path.join(location, 'yt-dlp.conf')
e2e43aea 1423 if not os.path.exists(location):
1424 parser.error('config-location %s does not exist.' % location)
0202b52a 1425 configs['custom'] = _readOptions(location, default=None)
1426 if configs['custom'] is None:
1427 configs['custom'] = []
1428 else:
1429 paths['custom'] = location
1430 if '--ignore-config' in configs['command-line']:
e2e43aea 1431 return
1432 if '--ignore-config' in configs['custom']:
1433 return
1434
0202b52a 1435 def read_options(path, user=False):
7a5c1cfe
P
1436 # Multiple package names can be given here
1437 # Eg: ('yt-dlp', 'youtube-dlc', 'youtube-dl') will look for
1438 # the configuration file of any of these three packages
1439 for package in ('yt-dlp',):
0202b52a 1440 if user:
b5d26563 1441 config, current_path = _readUserConf(package, default=None)
1442 else:
1443 current_path = os.path.join(path, '%s.conf' % package)
1444 config = _readOptions(current_path, default=None)
1445 if config is not None:
1446 return config, current_path
1447 return [], None
0202b52a 1448
f74980cb 1449 configs['portable'], paths['portable'] = read_options(get_executable_path())
e2e43aea 1450 if '--ignore-config' in configs['portable']:
1451 return
e2e43aea 1452
0202b52a 1453 def get_home_path():
1454 opts = parser.parse_args(configs['portable'] + configs['custom'] + configs['command-line'])[0]
1455 return expand_path(opts.paths.get('home', '')).strip()
1456
1457 configs['home'], paths['home'] = read_options(get_home_path())
1458 if '--ignore-config' in configs['home']:
1459 return
1460
1461 configs['system'], paths['system'] = read_options('/etc')
e2e43aea 1462 if '--ignore-config' in configs['system']:
1463 return
0202b52a 1464
1465 configs['user'], paths['user'] = read_options('', True)
e2e43aea 1466 if '--ignore-config' in configs['user']:
0202b52a 1467 configs['system'], paths['system'] = [], None
e66dca5e 1468
e2e43aea 1469 get_configs()
0202b52a 1470 argv = configs['system'] + configs['user'] + configs['home'] + configs['portable'] + configs['custom'] + configs['command-line']
34a741a8
PH
1471 opts, args = parser.parse_args(argv)
1472 if opts.verbose:
0202b52a 1473 for label in ('System', 'User', 'Portable', 'Home', 'Custom', 'Command-line'):
1474 key = label.lower()
1475 if paths.get(key) is None:
1476 continue
1477 if paths[key]:
1478 write_string('[debug] %s config file: %s\n' % (label, paths[key]))
1479 write_string('[debug] %s config: %s\n' % (label, repr(_hide_login_info(configs[key]))))
34a741a8
PH
1480
1481 return parser, opts, args