1 from __future__ import unicode_literals
8 from .downloader.external import list_external_downloaders
11 compat_get_terminal_size,
20 from .version import __version__
23 def parseOpts(overrideArguments=None):
24 def _readOptions(filename_bytes, default=[]):
26 optionf = open(filename_bytes)
28 return default # silently skip if file is not present
30 # FIXME: https://github.com/rg3/youtube-dl/commit/dfe5fa49aed02cf36ba9f743b11b0903554b5e56
31 contents = optionf.read()
32 if sys.version_info < (3,):
33 contents = contents.decode(preferredencoding())
34 res = compat_shlex_split(contents, comments=True)
40 xdg_config_home = compat_getenv('XDG_CONFIG_HOME')
42 userConfFile = os.path.join(xdg_config_home, 'youtube-dl', 'config')
43 if not os.path.isfile(userConfFile):
44 userConfFile = os.path.join(xdg_config_home, 'youtube-dl.conf')
46 userConfFile = os.path.join(compat_expanduser('~'), '.config', 'youtube-dl', 'config')
47 if not os.path.isfile(userConfFile):
48 userConfFile = os.path.join(compat_expanduser('~'), '.config', 'youtube-dl.conf')
49 userConf = _readOptions(userConfFile, None)
52 appdata_dir = compat_getenv('appdata')
54 userConf = _readOptions(
55 os.path.join(appdata_dir, 'youtube-dl', 'config'),
58 userConf = _readOptions(
59 os.path.join(appdata_dir, 'youtube-dl', 'config.txt'),
63 userConf = _readOptions(
64 os.path.join(compat_expanduser('~'), 'youtube-dl.conf'),
67 userConf = _readOptions(
68 os.path.join(compat_expanduser('~'), 'youtube-dl.conf.txt'),
76 def _format_option_string(option):
77 ''' ('-o', '--option') -> -o, --format METAVAR'''
81 if option._short_opts:
82 opts.append(option._short_opts[0])
84 opts.append(option._long_opts[0])
88 if option.takes_value():
89 opts.append(' %s' % option.metavar)
93 def _comma_separated_values_options_callback(option, opt_str, value, parser):
94 setattr(parser.values, option.dest, value.split(','))
96 def _hide_login_info(opts):
97 PRIVATE_OPTS = ['-p', '--password', '-u', '--username', '--video-password', '--ap-password', '--ap-username']
98 eqre = re.compile('^(?P<key>' + ('|'.join(re.escape(po) for po in PRIVATE_OPTS)) + ')=.+$')
103 return m.group('key') + '=PRIVATE'
107 opts = list(map(_scrub_eq, opts))
108 for private_opt in PRIVATE_OPTS:
110 i = opts.index(private_opt)
111 opts[i + 1] = 'PRIVATE'
116 # No need to wrap help messages if we're on a wide console
117 columns = compat_get_terminal_size().columns
118 max_width = columns if columns else 80
119 max_help_position = 80
121 fmt = optparse.IndentedHelpFormatter(width=max_width, max_help_position=max_help_position)
122 fmt.format_option_strings = _format_option_string
125 'version': __version__,
127 'usage': '%prog [OPTIONS] URL [URL...]',
128 'conflict_handler': 'resolve',
131 parser = optparse.OptionParser(**compat_kwargs(kw))
133 general = optparse.OptionGroup(parser, 'General Options')
137 help='Print this help text and exit')
141 help='Print program version and exit')
144 action='store_true', dest='update_self',
145 help='Update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
147 '-i', '--ignore-errors',
148 action='store_true', dest='ignoreerrors', default=False,
149 help='Continue on download errors, for example to skip unavailable videos in a playlist')
152 action='store_false', dest='ignoreerrors',
153 help='Abort downloading of further videos (in the playlist or the command line) if an error occurs')
156 action='store_true', dest='dump_user_agent', default=False,
157 help='Display the current browser identification')
160 action='store_true', dest='list_extractors', default=False,
161 help='List all supported extractors')
163 '--extractor-descriptions',
164 action='store_true', dest='list_extractor_descriptions', default=False,
165 help='Output descriptions of all supported extractors')
167 '--force-generic-extractor',
168 action='store_true', dest='force_generic_extractor', default=False,
169 help='Force extraction to use the generic extractor')
172 dest='default_search', metavar='PREFIX',
173 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.')
177 help='Do not read configuration files. '
178 'When given in the global configuration file /etc/youtube-dl.conf: '
179 'Do not read the user configuration in ~/.config/youtube-dl/config '
180 '(%APPDATA%/youtube-dl/config.txt on Windows)')
183 action='store_const', dest='extract_flat', const='in_playlist',
185 help='Do not extract the videos of a playlist, only list them.')
188 action='store_true', dest='mark_watched', default=False,
189 help='Mark videos watched (YouTube only)')
192 action='store_false', dest='mark_watched', default=False,
193 help='Do not mark videos watched (YouTube only)')
195 '--no-color', '--no-colors',
196 action='store_true', dest='no_color',
198 help='Do not emit color codes in output')
200 network = optparse.OptionGroup(parser, 'Network Options')
202 '--proxy', dest='proxy',
203 default=None, metavar='URL',
204 help='Use the specified HTTP/HTTPS/SOCKS proxy. To enable experimental '
205 'SOCKS proxy, specify a proper scheme. For example '
206 'socks5://127.0.0.1:1080/. Pass in an empty string (--proxy "") '
207 'for direct connection')
210 dest='socket_timeout', type=float, default=None, metavar='SECONDS',
211 help='Time to wait before giving up, in seconds')
214 metavar='IP', dest='source_address', default=None,
215 help='Client-side IP address to bind to (experimental)',
218 '-4', '--force-ipv4',
219 action='store_const', const='0.0.0.0', dest='source_address',
220 help='Make all connections via IPv4 (experimental)',
223 '-6', '--force-ipv6',
224 action='store_const', const='::', dest='source_address',
225 help='Make all connections via IPv6 (experimental)',
228 '--geo-verification-proxy',
229 dest='geo_verification_proxy', default=None, metavar='URL',
230 help='Use this proxy to verify the IP address for some geo-restricted sites. '
231 'The default proxy specified by --proxy (or none, if the options is not present) is used for the actual downloading. (experimental)'
234 '--cn-verification-proxy',
235 dest='cn_verification_proxy', default=None, metavar='URL',
236 help=optparse.SUPPRESS_HELP,
239 selection = optparse.OptionGroup(parser, 'Video Selection')
240 selection.add_option(
242 dest='playliststart', metavar='NUMBER', default=1, type=int,
243 help='Playlist video to start at (default is %default)')
244 selection.add_option(
246 dest='playlistend', metavar='NUMBER', default=None, type=int,
247 help='Playlist video to end at (default is last)')
248 selection.add_option(
250 dest='playlist_items', metavar='ITEM_SPEC', default=None,
251 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.')
252 selection.add_option(
254 dest='matchtitle', metavar='REGEX',
255 help='Download only matching titles (regex or caseless sub-string)')
256 selection.add_option(
258 dest='rejecttitle', metavar='REGEX',
259 help='Skip download for matching titles (regex or caseless sub-string)')
260 selection.add_option(
262 dest='max_downloads', metavar='NUMBER', type=int, default=None,
263 help='Abort after downloading NUMBER files')
264 selection.add_option(
266 metavar='SIZE', dest='min_filesize', default=None,
267 help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
268 selection.add_option(
270 metavar='SIZE', dest='max_filesize', default=None,
271 help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
272 selection.add_option(
274 metavar='DATE', dest='date', default=None,
275 help='Download only videos uploaded in this date')
276 selection.add_option(
278 metavar='DATE', dest='datebefore', default=None,
279 help='Download only videos uploaded on or before this date (i.e. inclusive)')
280 selection.add_option(
282 metavar='DATE', dest='dateafter', default=None,
283 help='Download only videos uploaded on or after this date (i.e. inclusive)')
284 selection.add_option(
286 metavar='COUNT', dest='min_views', default=None, type=int,
287 help='Do not download any videos with less than COUNT views')
288 selection.add_option(
290 metavar='COUNT', dest='max_views', default=None, type=int,
291 help='Do not download any videos with more than COUNT views')
292 selection.add_option(
294 metavar='FILTER', dest='match_filter', default=None,
296 'Generic video filter (experimental). '
297 'Specify any key (see help for -o for a list of available keys) to'
298 ' match if the key is present, '
299 '!key to check if the key is not present,'
300 'key > NUMBER (like "comment_count > 12", also works with '
301 '>=, <, <=, !=, =) to compare against a number, and '
302 '& to require multiple matches. '
303 'Values which are not known are excluded unless you'
304 ' put a question mark (?) after the operator.'
305 'For example, to only match videos that have been liked more than '
306 '100 times and disliked less than 50 times (or the dislike '
307 'functionality is not available at the given service), but who '
308 'also have a description, use --match-filter '
309 '"like_count > 100 & dislike_count <? 50 & description" .'
311 selection.add_option(
313 action='store_true', dest='noplaylist', default=False,
314 help='Download only the video, if the URL refers to a video and a playlist.')
315 selection.add_option(
317 action='store_false', dest='noplaylist', default=False,
318 help='Download the playlist, if the URL refers to a video and a playlist.')
319 selection.add_option(
321 metavar='YEARS', dest='age_limit', default=None, type=int,
322 help='Download only videos suitable for the given age')
323 selection.add_option(
324 '--download-archive', metavar='FILE',
325 dest='download_archive',
326 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it.')
327 selection.add_option(
329 dest='include_ads', action='store_true',
330 help='Download advertisements as well (experimental)')
332 authentication = optparse.OptionGroup(parser, 'Authentication Options')
333 authentication.add_option(
335 dest='username', metavar='USERNAME',
336 help='Login with this account ID')
337 authentication.add_option(
339 dest='password', metavar='PASSWORD',
340 help='Account password. If this option is left out, youtube-dl will ask interactively.')
341 authentication.add_option(
343 dest='twofactor', metavar='TWOFACTOR',
344 help='Two-factor auth code')
345 authentication.add_option(
347 action='store_true', dest='usenetrc', default=False,
348 help='Use .netrc authentication data')
349 authentication.add_option(
351 dest='videopassword', metavar='PASSWORD',
352 help='Video password (vimeo, smotri, youku)')
354 adobe_pass = optparse.OptionGroup(parser, 'Adobe Pass Options')
355 adobe_pass.add_option(
357 dest='ap_mso', metavar='MSO',
358 help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
359 adobe_pass.add_option(
361 dest='ap_username', metavar='USERNAME',
362 help='Multiple-system operator account login')
363 adobe_pass.add_option(
365 dest='ap_password', metavar='PASSWORD',
366 help='Multiple-system operator account password. If this option is left out, youtube-dl will ask interactively.')
367 adobe_pass.add_option(
369 action='store_true', dest='ap_list_mso', default=False,
370 help='List all supported multiple-system operators')
372 video_format = optparse.OptionGroup(parser, 'Video Format Options')
373 video_format.add_option(
375 action='store', dest='format', metavar='FORMAT', default=None,
376 help='Video format code, see the "FORMAT SELECTION" for all the info')
377 video_format.add_option(
379 action='store_const', dest='format', const='all',
380 help='Download all available video formats')
381 video_format.add_option(
382 '--prefer-free-formats',
383 action='store_true', dest='prefer_free_formats', default=False,
384 help='Prefer free video formats unless a specific one is requested')
385 video_format.add_option(
386 '-F', '--list-formats',
387 action='store_true', dest='listformats',
388 help='List all available formats of requested videos')
389 video_format.add_option(
390 '--youtube-include-dash-manifest',
391 action='store_true', dest='youtube_include_dash_manifest', default=True,
392 help=optparse.SUPPRESS_HELP)
393 video_format.add_option(
394 '--youtube-skip-dash-manifest',
395 action='store_false', dest='youtube_include_dash_manifest',
396 help='Do not download the DASH manifests and related data on YouTube videos')
397 video_format.add_option(
398 '--merge-output-format',
399 action='store', dest='merge_output_format', metavar='FORMAT', default=None,
401 'If a merge is required (e.g. bestvideo+bestaudio), '
402 'output to given container format. One of mkv, mp4, ogg, webm, flv. '
403 'Ignored if no merge is required'))
405 subtitles = optparse.OptionGroup(parser, 'Subtitle Options')
406 subtitles.add_option(
407 '--write-sub', '--write-srt',
408 action='store_true', dest='writesubtitles', default=False,
409 help='Write subtitle file')
410 subtitles.add_option(
411 '--write-auto-sub', '--write-automatic-sub',
412 action='store_true', dest='writeautomaticsub', default=False,
413 help='Write automatically generated subtitle file (YouTube only)')
414 subtitles.add_option(
416 action='store_true', dest='allsubtitles', default=False,
417 help='Download all the available subtitles of the video')
418 subtitles.add_option(
420 action='store_true', dest='listsubtitles', default=False,
421 help='List all available subtitles for the video')
422 subtitles.add_option(
424 action='store', dest='subtitlesformat', metavar='FORMAT', default='best',
425 help='Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"')
426 subtitles.add_option(
427 '--sub-lang', '--sub-langs', '--srt-lang',
428 action='callback', dest='subtitleslangs', metavar='LANGS', type='str',
429 default=[], callback=_comma_separated_values_options_callback,
430 help='Languages of the subtitles to download (optional) separated by commas, use --list-subs for available language tags')
432 downloader = optparse.OptionGroup(parser, 'Download Options')
433 downloader.add_option(
434 '-r', '--limit-rate', '--rate-limit',
435 dest='ratelimit', metavar='RATE',
436 help='Maximum download rate in bytes per second (e.g. 50K or 4.2M)')
437 downloader.add_option(
439 dest='retries', metavar='RETRIES', default=10,
440 help='Number of retries (default is %default), or "infinite".')
441 downloader.add_option(
442 '--fragment-retries',
443 dest='fragment_retries', metavar='RETRIES', default=10,
444 help='Number of retries for a fragment (default is %default), or "infinite" (DASH and hlsnative only)')
445 downloader.add_option(
446 '--skip-unavailable-fragments',
447 action='store_true', dest='skip_unavailable_fragments', default=True,
448 help='Skip unavailable fragments (DASH and hlsnative only)')
450 '--abort-on-unavailable-fragment',
451 action='store_false', dest='skip_unavailable_fragments',
452 help='Abort downloading when some fragment is not available')
453 downloader.add_option(
455 dest='buffersize', metavar='SIZE', default='1024',
456 help='Size of download buffer (e.g. 1024 or 16K) (default is %default)')
457 downloader.add_option(
458 '--no-resize-buffer',
459 action='store_true', dest='noresizebuffer', default=False,
460 help='Do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.')
461 downloader.add_option(
463 action='store_true', dest='test', default=False,
464 help=optparse.SUPPRESS_HELP)
465 downloader.add_option(
466 '--playlist-reverse',
468 help='Download playlist videos in reverse order')
469 downloader.add_option(
470 '--xattr-set-filesize',
471 dest='xattr_set_filesize', action='store_true',
472 help='Set file xattribute ytdl.filesize with expected filesize (experimental)')
473 downloader.add_option(
474 '--hls-prefer-native',
475 dest='hls_prefer_native', action='store_true', default=None,
476 help='Use the native HLS downloader instead of ffmpeg')
477 downloader.add_option(
478 '--hls-prefer-ffmpeg',
479 dest='hls_prefer_native', action='store_false', default=None,
480 help='Use ffmpeg instead of the native HLS downloader')
481 downloader.add_option(
483 dest='hls_use_mpegts', action='store_true',
484 help='Use the mpegts container for HLS videos, allowing to play the '
485 'video while downloading (some players may not be able to play it)')
486 downloader.add_option(
487 '--external-downloader',
488 dest='external_downloader', metavar='COMMAND',
489 help='Use the specified external downloader. '
490 'Currently supports %s' % ','.join(list_external_downloaders()))
491 downloader.add_option(
492 '--external-downloader-args',
493 dest='external_downloader_args', metavar='ARGS',
494 help='Give these arguments to the external downloader')
496 workarounds = optparse.OptionGroup(parser, 'Workarounds')
497 workarounds.add_option(
499 dest='encoding', metavar='ENCODING',
500 help='Force the specified encoding (experimental)')
501 workarounds.add_option(
502 '--no-check-certificate',
503 action='store_true', dest='no_check_certificate', default=False,
504 help='Suppress HTTPS certificate validation')
505 workarounds.add_option(
507 '--prefer-unsecure', action='store_true', dest='prefer_insecure',
508 help='Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)')
509 workarounds.add_option(
511 metavar='UA', dest='user_agent',
512 help='Specify a custom user agent')
513 workarounds.add_option(
515 metavar='URL', dest='referer', default=None,
516 help='Specify a custom referer, use if the video access is restricted to one domain',
518 workarounds.add_option(
520 metavar='FIELD:VALUE', dest='headers', action='append',
521 help='Specify a custom HTTP header and its value, separated by a colon \':\'. You can use this option multiple times',
523 workarounds.add_option(
525 dest='bidi_workaround', action='store_true',
526 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
527 workarounds.add_option(
528 '--sleep-interval', '--min-sleep-interval', metavar='SECONDS',
529 dest='sleep_interval', type=float,
531 'Number of seconds to sleep before each download when used alone '
532 'or a lower bound of a range for randomized sleep before each download '
533 '(minimum possible number of seconds to sleep) when used along with '
534 '--max-sleep-interval.'))
535 workarounds.add_option(
536 '--max-sleep-interval', metavar='SECONDS',
537 dest='max_sleep_interval', type=float,
539 'Upper bound of a range for randomized sleep before each download '
540 '(maximum possible number of seconds to sleep). Must only be used '
541 'along with --min-sleep-interval.'))
543 verbosity = optparse.OptionGroup(parser, 'Verbosity / Simulation Options')
544 verbosity.add_option(
546 action='store_true', dest='quiet', default=False,
547 help='Activate quiet mode')
548 verbosity.add_option(
550 dest='no_warnings', action='store_true', default=False,
551 help='Ignore warnings')
552 verbosity.add_option(
554 action='store_true', dest='simulate', default=False,
555 help='Do not download the video and do not write anything to disk')
556 verbosity.add_option(
558 action='store_true', dest='skip_download', default=False,
559 help='Do not download the video')
560 verbosity.add_option(
562 action='store_true', dest='geturl', default=False,
563 help='Simulate, quiet but print URL')
564 verbosity.add_option(
566 action='store_true', dest='gettitle', default=False,
567 help='Simulate, quiet but print title')
568 verbosity.add_option(
570 action='store_true', dest='getid', default=False,
571 help='Simulate, quiet but print id')
572 verbosity.add_option(
574 action='store_true', dest='getthumbnail', default=False,
575 help='Simulate, quiet but print thumbnail URL')
576 verbosity.add_option(
578 action='store_true', dest='getdescription', default=False,
579 help='Simulate, quiet but print video description')
580 verbosity.add_option(
582 action='store_true', dest='getduration', default=False,
583 help='Simulate, quiet but print video length')
584 verbosity.add_option(
586 action='store_true', dest='getfilename', default=False,
587 help='Simulate, quiet but print output filename')
588 verbosity.add_option(
590 action='store_true', dest='getformat', default=False,
591 help='Simulate, quiet but print output format')
592 verbosity.add_option(
594 action='store_true', dest='dumpjson', default=False,
595 help='Simulate, quiet but print JSON information. See --output for a description of available keys.')
596 verbosity.add_option(
597 '-J', '--dump-single-json',
598 action='store_true', dest='dump_single_json', default=False,
599 help='Simulate, quiet but print JSON information for each command-line argument. If the URL refers to a playlist, dump the whole playlist information in a single line.')
600 verbosity.add_option(
602 action='store_true', dest='print_json', default=False,
603 help='Be quiet and print the video information as JSON (video is still being downloaded).',
605 verbosity.add_option(
607 action='store_true', dest='progress_with_newline', default=False,
608 help='Output progress bar as new lines')
609 verbosity.add_option(
611 action='store_true', dest='noprogress', default=False,
612 help='Do not print progress bar')
613 verbosity.add_option(
615 action='store_true', dest='consoletitle', default=False,
616 help='Display progress in console titlebar')
617 verbosity.add_option(
619 action='store_true', dest='verbose', default=False,
620 help='Print various debugging information')
621 verbosity.add_option(
622 '--dump-pages', '--dump-intermediate-pages',
623 action='store_true', dest='dump_intermediate_pages', default=False,
624 help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
625 verbosity.add_option(
627 action='store_true', dest='write_pages', default=False,
628 help='Write downloaded intermediary pages to files in the current directory to debug problems')
629 verbosity.add_option(
630 '--youtube-print-sig-code',
631 action='store_true', dest='youtube_print_sig_code', default=False,
632 help=optparse.SUPPRESS_HELP)
633 verbosity.add_option(
634 '--print-traffic', '--dump-headers',
635 dest='debug_printtraffic', action='store_true', default=False,
636 help='Display sent and read HTTP traffic')
637 verbosity.add_option(
639 dest='call_home', action='store_true', default=False,
640 help='Contact the youtube-dl server for debugging')
641 verbosity.add_option(
643 dest='call_home', action='store_false', default=False,
644 help='Do NOT contact the youtube-dl server for debugging')
646 filesystem = optparse.OptionGroup(parser, 'Filesystem Options')
647 filesystem.add_option(
648 '-a', '--batch-file',
649 dest='batchfile', metavar='FILE',
650 help='File containing URLs to download (\'-\' for stdin)')
651 filesystem.add_option(
652 '--id', default=False,
653 action='store_true', dest='useid', help='Use only video ID in file name')
654 filesystem.add_option(
656 dest='outtmpl', metavar='TEMPLATE',
657 help=('Output filename template, see the "OUTPUT TEMPLATE" for all the info'))
658 filesystem.add_option(
660 dest='autonumber_size', metavar='NUMBER',
661 help='Specify the number of digits in %(autonumber)s when it is present in output filename template or --auto-number option is given')
662 filesystem.add_option(
663 '--restrict-filenames',
664 action='store_true', dest='restrictfilenames', default=False,
665 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
666 filesystem.add_option(
667 '-A', '--auto-number',
668 action='store_true', dest='autonumber', default=False,
669 help='[deprecated; use -o "%(autonumber)s-%(title)s.%(ext)s" ] Number downloaded files starting from 00000')
670 filesystem.add_option(
672 action='store_true', dest='usetitle', default=False,
673 help='[deprecated] Use title in file name (default)')
674 filesystem.add_option(
675 '-l', '--literal', default=False,
676 action='store_true', dest='usetitle',
677 help='[deprecated] Alias of --title')
678 filesystem.add_option(
679 '-w', '--no-overwrites',
680 action='store_true', dest='nooverwrites', default=False,
681 help='Do not overwrite files')
682 filesystem.add_option(
684 action='store_true', dest='continue_dl', default=True,
685 help='Force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.')
686 filesystem.add_option(
688 action='store_false', dest='continue_dl',
689 help='Do not resume partially downloaded files (restart from beginning)')
690 filesystem.add_option(
692 action='store_true', dest='nopart', default=False,
693 help='Do not use .part files - write directly into output file')
694 filesystem.add_option(
696 action='store_false', dest='updatetime', default=True,
697 help='Do not use the Last-modified header to set the file modification time')
698 filesystem.add_option(
699 '--write-description',
700 action='store_true', dest='writedescription', default=False,
701 help='Write video description to a .description file')
702 filesystem.add_option(
704 action='store_true', dest='writeinfojson', default=False,
705 help='Write video metadata to a .info.json file')
706 filesystem.add_option(
707 '--write-annotations',
708 action='store_true', dest='writeannotations', default=False,
709 help='Write video annotations to a .annotations.xml file')
710 filesystem.add_option(
711 '--load-info-json', '--load-info',
712 dest='load_info_filename', metavar='FILE',
713 help='JSON file containing the video information (created with the "--write-info-json" option)')
714 filesystem.add_option(
716 dest='cookiefile', metavar='FILE',
717 help='File to read cookies from and dump cookie jar in')
718 filesystem.add_option(
719 '--cache-dir', dest='cachedir', default=None, metavar='DIR',
720 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.')
721 filesystem.add_option(
722 '--no-cache-dir', action='store_const', const=False, dest='cachedir',
723 help='Disable filesystem caching')
724 filesystem.add_option(
726 action='store_true', dest='rm_cachedir',
727 help='Delete all filesystem cache files')
729 thumbnail = optparse.OptionGroup(parser, 'Thumbnail images')
730 thumbnail.add_option(
732 action='store_true', dest='writethumbnail', default=False,
733 help='Write thumbnail image to disk')
734 thumbnail.add_option(
735 '--write-all-thumbnails',
736 action='store_true', dest='write_all_thumbnails', default=False,
737 help='Write all thumbnail image formats to disk')
738 thumbnail.add_option(
740 action='store_true', dest='list_thumbnails', default=False,
741 help='Simulate and list all available thumbnail formats')
743 postproc = optparse.OptionGroup(parser, 'Post-processing Options')
745 '-x', '--extract-audio',
746 action='store_true', dest='extractaudio', default=False,
747 help='Convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)')
749 '--audio-format', metavar='FORMAT', dest='audioformat', default='best',
750 help='Specify audio format: "best", "aac", "vorbis", "mp3", "m4a", "opus", or "wav"; "%default" by default')
752 '--audio-quality', metavar='QUALITY',
753 dest='audioquality', default='5',
754 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)')
757 metavar='FORMAT', dest='recodevideo', default=None,
758 help='Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm|mkv|avi)')
760 '--postprocessor-args',
761 dest='postprocessor_args', metavar='ARGS',
762 help='Give these arguments to the postprocessor')
764 '-k', '--keep-video',
765 action='store_true', dest='keepvideo', default=False,
766 help='Keep the video file on disk after the post-processing; the video is erased by default')
768 '--no-post-overwrites',
769 action='store_true', dest='nopostoverwrites', default=False,
770 help='Do not overwrite post-processed files; the post-processed files are overwritten by default')
773 action='store_true', dest='embedsubtitles', default=False,
774 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
777 action='store_true', dest='embedthumbnail', default=False,
778 help='Embed thumbnail in the audio as cover art')
781 action='store_true', dest='addmetadata', default=False,
782 help='Write metadata to the video file')
784 '--metadata-from-title',
785 metavar='FORMAT', dest='metafromtitle',
786 help='Parse additional metadata like song title / artist from the video title. '
787 'The format syntax is the same as --output, '
788 'the parsed parameters replace existing values. '
789 'Additional templates: %(album)s, %(artist)s. '
790 'Example: --metadata-from-title "%(artist)s - %(title)s" matches a title like '
791 '"Coldplay - Paradise"')
794 action='store_true', dest='xattrs', default=False,
795 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
798 metavar='POLICY', dest='fixup', default='detect_or_warn',
799 help='Automatically correct known faults of the file. '
800 'One of never (do nothing), warn (only emit a warning), '
801 'detect_or_warn (the default; fix file if we can, warn otherwise)')
804 action='store_false', dest='prefer_ffmpeg',
805 help='Prefer avconv over ffmpeg for running the postprocessors (default)')
808 action='store_true', dest='prefer_ffmpeg',
809 help='Prefer ffmpeg over avconv for running the postprocessors')
811 '--ffmpeg-location', '--avconv-location', metavar='PATH',
812 dest='ffmpeg_location',
813 help='Location of the ffmpeg/avconv binary; either the path to the binary or its containing directory.')
816 metavar='CMD', dest='exec_cmd',
817 help='Execute a command on the file after downloading, similar to find\'s -exec syntax. Example: --exec \'adb push {} /sdcard/Music/ && rm {}\'')
819 '--convert-subs', '--convert-subtitles',
820 metavar='FORMAT', dest='convertsubtitles', default=None,
821 help='Convert the subtitles to other format (currently supported: srt|ass|vtt)')
823 parser.add_option_group(general)
824 parser.add_option_group(network)
825 parser.add_option_group(selection)
826 parser.add_option_group(downloader)
827 parser.add_option_group(filesystem)
828 parser.add_option_group(thumbnail)
829 parser.add_option_group(verbosity)
830 parser.add_option_group(workarounds)
831 parser.add_option_group(video_format)
832 parser.add_option_group(subtitles)
833 parser.add_option_group(authentication)
834 parser.add_option_group(adobe_pass)
835 parser.add_option_group(postproc)
837 if overrideArguments is not None:
838 opts, args = parser.parse_args(overrideArguments)
840 write_string('[debug] Override config: ' + repr(overrideArguments) + '\n')
842 def compat_conf(conf):
843 if sys.version_info < (3,):
844 return [a.decode(preferredencoding(), 'replace') for a in conf]
847 command_line_conf = compat_conf(sys.argv[1:])
849 if '--ignore-config' in command_line_conf:
853 system_conf = _readOptions('/etc/youtube-dl.conf')
854 if '--ignore-config' in system_conf:
857 user_conf = _readUserConf()
858 argv = system_conf + user_conf + command_line_conf
860 opts, args = parser.parse_args(argv)
862 write_string('[debug] System config: ' + repr(_hide_login_info(system_conf)) + '\n')
863 write_string('[debug] User config: ' + repr(_hide_login_info(user_conf)) + '\n')
864 write_string('[debug] Command-line args: ' + repr(_hide_login_info(command_line_conf)) + '\n')
866 return parser, opts, args