1 from __future__
import unicode_literals
8 from .downloader
.external
import list_external_downloaders
11 compat_get_terminal_size
,
19 from .version
import __version__
22 def parseOpts(overrideArguments
=None):
23 def _readOptions(filename_bytes
, default
=[]):
25 optionf
= open(filename_bytes
)
27 return default
# silently skip if file is not present
31 res
+= shlex
.split(l
, comments
=True)
37 xdg_config_home
= compat_getenv('XDG_CONFIG_HOME')
39 userConfFile
= os
.path
.join(xdg_config_home
, 'youtube-dl', 'config')
40 if not os
.path
.isfile(userConfFile
):
41 userConfFile
= os
.path
.join(xdg_config_home
, 'youtube-dl.conf')
43 userConfFile
= os
.path
.join(compat_expanduser('~'), '.config', 'youtube-dl', 'config')
44 if not os
.path
.isfile(userConfFile
):
45 userConfFile
= os
.path
.join(compat_expanduser('~'), '.config', 'youtube-dl.conf')
46 userConf
= _readOptions(userConfFile
, None)
49 appdata_dir
= compat_getenv('appdata')
51 userConf
= _readOptions(
52 os
.path
.join(appdata_dir
, 'youtube-dl', 'config'),
55 userConf
= _readOptions(
56 os
.path
.join(appdata_dir
, 'youtube-dl', 'config.txt'),
60 userConf
= _readOptions(
61 os
.path
.join(compat_expanduser('~'), 'youtube-dl.conf'),
64 userConf
= _readOptions(
65 os
.path
.join(compat_expanduser('~'), 'youtube-dl.conf.txt'),
73 def _format_option_string(option
):
74 ''' ('-o', '--option') -> -o, --format METAVAR'''
78 if option
._short
_opts
:
79 opts
.append(option
._short
_opts
[0])
81 opts
.append(option
._long
_opts
[0])
85 if option
.takes_value():
86 opts
.append(' %s' % option
.metavar
)
90 def _comma_separated_values_options_callback(option
, opt_str
, value
, parser
):
91 setattr(parser
.values
, option
.dest
, value
.split(','))
93 def _hide_login_info(opts
):
95 for private_opt
in ['-p', '--password', '-u', '--username', '--video-password']:
97 i
= opts
.index(private_opt
)
98 opts
[i
+ 1] = 'PRIVATE'
103 # No need to wrap help messages if we're on a wide console
104 columns
= compat_get_terminal_size().columns
105 max_width
= columns
if columns
else 80
106 max_help_position
= 80
108 fmt
= optparse
.IndentedHelpFormatter(width
=max_width
, max_help_position
=max_help_position
)
109 fmt
.format_option_strings
= _format_option_string
112 'version': __version__
,
114 'usage': '%prog [OPTIONS] URL [URL...]',
115 'conflict_handler': 'resolve',
118 parser
= optparse
.OptionParser(**compat_kwargs(kw
))
120 general
= optparse
.OptionGroup(parser
, 'General Options')
124 help='Print this help text and exit')
128 help='Print program version and exit')
131 action
='store_true', dest
='update_self',
132 help='Update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
134 '-i', '--ignore-errors',
135 action
='store_true', dest
='ignoreerrors', default
=False,
136 help='Continue on download errors, for example to skip unavailable videos in a playlist')
139 action
='store_false', dest
='ignoreerrors',
140 help='Abort downloading of further videos (in the playlist or the command line) if an error occurs')
143 action
='store_true', dest
='dump_user_agent', default
=False,
144 help='Display the current browser identification')
147 action
='store_true', dest
='list_extractors', default
=False,
148 help='List all supported extractors')
150 '--extractor-descriptions',
151 action
='store_true', dest
='list_extractor_descriptions', default
=False,
152 help='Output descriptions of all supported extractors')
154 '--force-generic-extractor',
155 action
='store_true', dest
='force_generic_extractor', default
=False,
156 help='Force extraction to use the generic extractor')
159 dest
='default_search', metavar
='PREFIX',
160 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.')
164 help='Do not read configuration files. '
165 'When given in the global configuration file /etc/youtube-dl.conf: '
166 'Do not read the user configuration in ~/.config/youtube-dl/config '
167 '(%APPDATA%/youtube-dl/config.txt on Windows)')
170 action
='store_const', dest
='extract_flat', const
='in_playlist',
172 help='Do not extract the videos of a playlist, only list them.')
174 '--no-color', '--no-colors',
175 action
='store_true', dest
='no_color',
177 help='Do not emit color codes in output')
179 network
= optparse
.OptionGroup(parser
, 'Network Options')
181 '--proxy', dest
='proxy',
182 default
=None, metavar
='URL',
183 help='Use the specified HTTP/HTTPS proxy. Pass in an empty string (--proxy "") for direct connection')
186 dest
='socket_timeout', type=float, default
=None, metavar
='SECONDS',
187 help='Time to wait before giving up, in seconds')
190 metavar
='IP', dest
='source_address', default
=None,
191 help='Client-side IP address to bind to (experimental)',
194 '-4', '--force-ipv4',
195 action
='store_const', const
='0.0.0.0', dest
='source_address',
196 help='Make all connections via IPv4 (experimental)',
199 '-6', '--force-ipv6',
200 action
='store_const', const
='::', dest
='source_address',
201 help='Make all connections via IPv6 (experimental)',
204 '--cn-verification-proxy',
205 dest
='cn_verification_proxy', default
=None, metavar
='URL',
206 help='Use this proxy to verify the IP address for some Chinese sites. '
207 'The default proxy specified by --proxy (or none, if the options is not present) is used for the actual downloading. (experimental)'
210 selection
= optparse
.OptionGroup(parser
, 'Video Selection')
211 selection
.add_option(
213 dest
='playliststart', metavar
='NUMBER', default
=1, type=int,
214 help='Playlist video to start at (default is %default)')
215 selection
.add_option(
217 dest
='playlistend', metavar
='NUMBER', default
=None, type=int,
218 help='Playlist video to end at (default is last)')
219 selection
.add_option(
221 dest
='playlist_items', metavar
='ITEM_SPEC', default
=None,
222 help='Playlist video items to download. Specify indices of the videos in the playlist seperated 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.')
223 selection
.add_option(
225 dest
='matchtitle', metavar
='REGEX',
226 help='Download only matching titles (regex or caseless sub-string)')
227 selection
.add_option(
229 dest
='rejecttitle', metavar
='REGEX',
230 help='Skip download for matching titles (regex or caseless sub-string)')
231 selection
.add_option(
233 dest
='max_downloads', metavar
='NUMBER', type=int, default
=None,
234 help='Abort after downloading NUMBER files')
235 selection
.add_option(
237 metavar
='SIZE', dest
='min_filesize', default
=None,
238 help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
239 selection
.add_option(
241 metavar
='SIZE', dest
='max_filesize', default
=None,
242 help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
243 selection
.add_option(
245 metavar
='DATE', dest
='date', default
=None,
246 help='Download only videos uploaded in this date')
247 selection
.add_option(
249 metavar
='DATE', dest
='datebefore', default
=None,
250 help='Download only videos uploaded on or before this date (i.e. inclusive)')
251 selection
.add_option(
253 metavar
='DATE', dest
='dateafter', default
=None,
254 help='Download only videos uploaded on or after this date (i.e. inclusive)')
255 selection
.add_option(
257 metavar
='COUNT', dest
='min_views', default
=None, type=int,
258 help='Do not download any videos with less than COUNT views')
259 selection
.add_option(
261 metavar
='COUNT', dest
='max_views', default
=None, type=int,
262 help='Do not download any videos with more than COUNT views')
263 selection
.add_option(
265 metavar
='FILTER', dest
='match_filter', default
=None,
267 'Generic video filter (experimental). '
268 'Specify any key (see help for -o for a list of available keys) to'
269 ' match if the key is present, '
270 '!key to check if the key is not present,'
271 'key > NUMBER (like "comment_count > 12", also works with '
272 '>=, <, <=, !=, =) to compare against a number, and '
273 '& to require multiple matches. '
274 'Values which are not known are excluded unless you'
275 ' put a question mark (?) after the operator.'
276 'For example, to only match videos that have been liked more than '
277 '100 times and disliked less than 50 times (or the dislike '
278 'functionality is not available at the given service), but who '
279 'also have a description, use --match-filter '
280 '"like_count > 100 & dislike_count <? 50 & description" .'
282 selection
.add_option(
284 action
='store_true', dest
='noplaylist', default
=False,
285 help='Download only the video, if the URL refers to a video and a playlist.')
286 selection
.add_option(
288 action
='store_false', dest
='noplaylist', default
=False,
289 help='Download the playlist, if the URL refers to a video and a playlist.')
290 selection
.add_option(
292 metavar
='YEARS', dest
='age_limit', default
=None, type=int,
293 help='Download only videos suitable for the given age')
294 selection
.add_option(
295 '--download-archive', metavar
='FILE',
296 dest
='download_archive',
297 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it.')
298 selection
.add_option(
300 dest
='include_ads', action
='store_true',
301 help='Download advertisements as well (experimental)')
303 authentication
= optparse
.OptionGroup(parser
, 'Authentication Options')
304 authentication
.add_option(
306 dest
='username', metavar
='USERNAME',
307 help='Login with this account ID')
308 authentication
.add_option(
310 dest
='password', metavar
='PASSWORD',
311 help='Account password. If this option is left out, youtube-dl will ask interactively.')
312 authentication
.add_option(
314 dest
='twofactor', metavar
='TWOFACTOR',
315 help='Two-factor auth code')
316 authentication
.add_option(
318 action
='store_true', dest
='usenetrc', default
=False,
319 help='Use .netrc authentication data')
320 authentication
.add_option(
322 dest
='videopassword', metavar
='PASSWORD',
323 help='Video password (vimeo, smotri)')
325 video_format
= optparse
.OptionGroup(parser
, 'Video Format Options')
326 video_format
.add_option(
328 action
='store', dest
='format', metavar
='FORMAT', default
=None,
329 help='Video format code, see the "FORMAT SELECTION" for all the info')
330 video_format
.add_option(
332 action
='store_const', dest
='format', const
='all',
333 help='Download all available video formats')
334 video_format
.add_option(
335 '--prefer-free-formats',
336 action
='store_true', dest
='prefer_free_formats', default
=False,
337 help='Prefer free video formats unless a specific one is requested')
338 video_format
.add_option(
339 '-F', '--list-formats',
340 action
='store_true', dest
='listformats',
341 help='List all available formats')
342 video_format
.add_option(
343 '--youtube-include-dash-manifest',
344 action
='store_true', dest
='youtube_include_dash_manifest', default
=True,
345 help=optparse
.SUPPRESS_HELP
)
346 video_format
.add_option(
347 '--youtube-skip-dash-manifest',
348 action
='store_false', dest
='youtube_include_dash_manifest',
349 help='Do not download the DASH manifest on YouTube videos')
350 video_format
.add_option(
351 '--merge-output-format',
352 action
='store', dest
='merge_output_format', metavar
='FORMAT', default
=None,
354 'If a merge is required (e.g. bestvideo+bestaudio), output to given container format. One of mkv, mp4, ogg, webm, flv.'
355 'Ignored if no merge is required'))
357 subtitles
= optparse
.OptionGroup(parser
, 'Subtitle Options')
358 subtitles
.add_option(
359 '--write-sub', '--write-srt',
360 action
='store_true', dest
='writesubtitles', default
=False,
361 help='Write subtitle file')
362 subtitles
.add_option(
363 '--write-auto-sub', '--write-automatic-sub',
364 action
='store_true', dest
='writeautomaticsub', default
=False,
365 help='Write automatic subtitle file (YouTube only)')
366 subtitles
.add_option(
368 action
='store_true', dest
='allsubtitles', default
=False,
369 help='Download all the available subtitles of the video')
370 subtitles
.add_option(
372 action
='store_true', dest
='listsubtitles', default
=False,
373 help='List all available subtitles for the video')
374 subtitles
.add_option(
376 action
='store', dest
='subtitlesformat', metavar
='FORMAT', default
='best',
377 help='Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"')
378 subtitles
.add_option(
379 '--sub-lang', '--sub-langs', '--srt-lang',
380 action
='callback', dest
='subtitleslangs', metavar
='LANGS', type='str',
381 default
=[], callback
=_comma_separated_values_options_callback
,
382 help='Languages of the subtitles to download (optional) separated by commas, use IETF language tags like \'en,pt\'')
384 downloader
= optparse
.OptionGroup(parser
, 'Download Options')
385 downloader
.add_option(
386 '-r', '--rate-limit',
387 dest
='ratelimit', metavar
='LIMIT',
388 help='Maximum download rate in bytes per second (e.g. 50K or 4.2M)')
389 downloader
.add_option(
391 dest
='retries', metavar
='RETRIES', default
=10,
392 help='Number of retries (default is %default), or "infinite".')
393 downloader
.add_option(
395 dest
='buffersize', metavar
='SIZE', default
='1024',
396 help='Size of download buffer (e.g. 1024 or 16K) (default is %default)')
397 downloader
.add_option(
398 '--no-resize-buffer',
399 action
='store_true', dest
='noresizebuffer', default
=False,
400 help='Do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.')
401 downloader
.add_option(
403 action
='store_true', dest
='test', default
=False,
404 help=optparse
.SUPPRESS_HELP
)
405 downloader
.add_option(
406 '--playlist-reverse',
408 help='Download playlist videos in reverse order')
409 downloader
.add_option(
410 '--xattr-set-filesize',
411 dest
='xattr_set_filesize', action
='store_true',
412 help='Set file xattribute ytdl.filesize with expected filesize (experimental)')
413 downloader
.add_option(
414 '--hls-prefer-native',
415 dest
='hls_prefer_native', action
='store_true',
416 help='Use the native HLS downloader instead of ffmpeg (experimental)')
417 downloader
.add_option(
418 '--external-downloader',
419 dest
='external_downloader', metavar
='COMMAND',
420 help='Use the specified external downloader. '
421 'Currently supports %s' % ','.join(list_external_downloaders()))
422 downloader
.add_option(
423 '--external-downloader-args',
424 dest
='external_downloader_args', metavar
='ARGS',
425 help='Give these arguments to the external downloader')
427 workarounds
= optparse
.OptionGroup(parser
, 'Workarounds')
428 workarounds
.add_option(
430 dest
='encoding', metavar
='ENCODING',
431 help='Force the specified encoding (experimental)')
432 workarounds
.add_option(
433 '--no-check-certificate',
434 action
='store_true', dest
='no_check_certificate', default
=False,
435 help='Suppress HTTPS certificate validation')
436 workarounds
.add_option(
438 '--prefer-unsecure', action
='store_true', dest
='prefer_insecure',
439 help='Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)')
440 workarounds
.add_option(
442 metavar
='UA', dest
='user_agent',
443 help='Specify a custom user agent')
444 workarounds
.add_option(
446 metavar
='URL', dest
='referer', default
=None,
447 help='Specify a custom referer, use if the video access is restricted to one domain',
449 workarounds
.add_option(
451 metavar
='FIELD:VALUE', dest
='headers', action
='append',
452 help='Specify a custom HTTP header and its value, separated by a colon \':\'. You can use this option multiple times',
454 workarounds
.add_option(
456 dest
='bidi_workaround', action
='store_true',
457 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
458 workarounds
.add_option(
459 '--sleep-interval', metavar
='SECONDS',
460 dest
='sleep_interval', type=float,
461 help='Number of seconds to sleep before each download.')
463 verbosity
= optparse
.OptionGroup(parser
, 'Verbosity / Simulation Options')
464 verbosity
.add_option(
466 action
='store_true', dest
='quiet', default
=False,
467 help='Activate quiet mode')
468 verbosity
.add_option(
470 dest
='no_warnings', action
='store_true', default
=False,
471 help='Ignore warnings')
472 verbosity
.add_option(
474 action
='store_true', dest
='simulate', default
=False,
475 help='Do not download the video and do not write anything to disk')
476 verbosity
.add_option(
478 action
='store_true', dest
='skip_download', default
=False,
479 help='Do not download the video')
480 verbosity
.add_option(
482 action
='store_true', dest
='geturl', default
=False,
483 help='Simulate, quiet but print URL')
484 verbosity
.add_option(
486 action
='store_true', dest
='gettitle', default
=False,
487 help='Simulate, quiet but print title')
488 verbosity
.add_option(
490 action
='store_true', dest
='getid', default
=False,
491 help='Simulate, quiet but print id')
492 verbosity
.add_option(
494 action
='store_true', dest
='getthumbnail', default
=False,
495 help='Simulate, quiet but print thumbnail URL')
496 verbosity
.add_option(
498 action
='store_true', dest
='getdescription', default
=False,
499 help='Simulate, quiet but print video description')
500 verbosity
.add_option(
502 action
='store_true', dest
='getduration', default
=False,
503 help='Simulate, quiet but print video length')
504 verbosity
.add_option(
506 action
='store_true', dest
='getfilename', default
=False,
507 help='Simulate, quiet but print output filename')
508 verbosity
.add_option(
510 action
='store_true', dest
='getformat', default
=False,
511 help='Simulate, quiet but print output format')
512 verbosity
.add_option(
514 action
='store_true', dest
='dumpjson', default
=False,
515 help='Simulate, quiet but print JSON information. See --output for a description of available keys.')
516 verbosity
.add_option(
517 '-J', '--dump-single-json',
518 action
='store_true', dest
='dump_single_json', default
=False,
519 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.')
520 verbosity
.add_option(
522 action
='store_true', dest
='print_json', default
=False,
523 help='Be quiet and print the video information as JSON (video is still being downloaded).',
525 verbosity
.add_option(
527 action
='store_true', dest
='progress_with_newline', default
=False,
528 help='Output progress bar as new lines')
529 verbosity
.add_option(
531 action
='store_true', dest
='noprogress', default
=False,
532 help='Do not print progress bar')
533 verbosity
.add_option(
535 action
='store_true', dest
='consoletitle', default
=False,
536 help='Display progress in console titlebar')
537 verbosity
.add_option(
539 action
='store_true', dest
='verbose', default
=False,
540 help='Print various debugging information')
541 verbosity
.add_option(
542 '--dump-pages', '--dump-intermediate-pages',
543 action
='store_true', dest
='dump_intermediate_pages', default
=False,
544 help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
545 verbosity
.add_option(
547 action
='store_true', dest
='write_pages', default
=False,
548 help='Write downloaded intermediary pages to files in the current directory to debug problems')
549 verbosity
.add_option(
550 '--youtube-print-sig-code',
551 action
='store_true', dest
='youtube_print_sig_code', default
=False,
552 help=optparse
.SUPPRESS_HELP
)
553 verbosity
.add_option(
554 '--print-traffic', '--dump-headers',
555 dest
='debug_printtraffic', action
='store_true', default
=False,
556 help='Display sent and read HTTP traffic')
557 verbosity
.add_option(
559 dest
='call_home', action
='store_true', default
=False,
560 help='Contact the youtube-dl server for debugging')
561 verbosity
.add_option(
563 dest
='call_home', action
='store_false', default
=False,
564 help='Do NOT contact the youtube-dl server for debugging')
566 filesystem
= optparse
.OptionGroup(parser
, 'Filesystem Options')
567 filesystem
.add_option(
568 '-a', '--batch-file',
569 dest
='batchfile', metavar
='FILE',
570 help='File containing URLs to download (\'-\' for stdin)')
571 filesystem
.add_option(
572 '--id', default
=False,
573 action
='store_true', dest
='useid', help='Use only video ID in file name')
574 filesystem
.add_option(
576 dest
='outtmpl', metavar
='TEMPLATE',
577 help=('Output filename template. Use %(title)s to get the title, '
578 '%(uploader)s for the uploader name, %(uploader_id)s for the uploader nickname if different, '
579 '%(autonumber)s to get an automatically incremented number, '
580 '%(ext)s for the filename extension, '
581 '%(format)s for the format description (like "22 - 1280x720" or "HD"), '
582 '%(format_id)s for the unique id of the format (like YouTube\'s itags: "137"), '
583 '%(upload_date)s for the upload date (YYYYMMDD), '
584 '%(extractor)s for the provider (youtube, metacafe, etc), '
585 '%(id)s for the video id, '
586 '%(playlist_title)s, %(playlist_id)s, or %(playlist)s (=title if present, ID otherwise) for the playlist the video is in, '
587 '%(playlist_index)s for the position in the playlist. '
588 '%(height)s and %(width)s for the width and height of the video format. '
589 '%(resolution)s for a textual description of the resolution of the video format. '
590 '%% for a literal percent. '
591 'Use - to output to stdout. Can also be used to download to a different directory, '
592 'for example with -o \'/my/downloads/%(uploader)s/%(title)s-%(id)s.%(ext)s\' .'))
593 filesystem
.add_option(
595 dest
='autonumber_size', metavar
='NUMBER',
596 help='Specify the number of digits in %(autonumber)s when it is present in output filename template or --auto-number option is given')
597 filesystem
.add_option(
598 '--restrict-filenames',
599 action
='store_true', dest
='restrictfilenames', default
=False,
600 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
601 filesystem
.add_option(
602 '-A', '--auto-number',
603 action
='store_true', dest
='autonumber', default
=False,
604 help='[deprecated; use -o "%(autonumber)s-%(title)s.%(ext)s" ] Number downloaded files starting from 00000')
605 filesystem
.add_option(
607 action
='store_true', dest
='usetitle', default
=False,
608 help='[deprecated] Use title in file name (default)')
609 filesystem
.add_option(
610 '-l', '--literal', default
=False,
611 action
='store_true', dest
='usetitle',
612 help='[deprecated] Alias of --title')
613 filesystem
.add_option(
614 '-w', '--no-overwrites',
615 action
='store_true', dest
='nooverwrites', default
=False,
616 help='Do not overwrite files')
617 filesystem
.add_option(
619 action
='store_true', dest
='continue_dl', default
=True,
620 help='Force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.')
621 filesystem
.add_option(
623 action
='store_false', dest
='continue_dl',
624 help='Do not resume partially downloaded files (restart from beginning)')
625 filesystem
.add_option(
627 action
='store_true', dest
='nopart', default
=False,
628 help='Do not use .part files - write directly into output file')
629 filesystem
.add_option(
631 action
='store_false', dest
='updatetime', default
=True,
632 help='Do not use the Last-modified header to set the file modification time')
633 filesystem
.add_option(
634 '--write-description',
635 action
='store_true', dest
='writedescription', default
=False,
636 help='Write video description to a .description file')
637 filesystem
.add_option(
639 action
='store_true', dest
='writeinfojson', default
=False,
640 help='Write video metadata to a .info.json file')
641 filesystem
.add_option(
642 '--write-annotations',
643 action
='store_true', dest
='writeannotations', default
=False,
644 help='Write video annotations to a .annotations.xml file')
645 filesystem
.add_option(
647 dest
='load_info_filename', metavar
='FILE',
648 help='JSON file containing the video information (created with the "--write-info-json" option)')
649 filesystem
.add_option(
651 dest
='cookiefile', metavar
='FILE',
652 help='File to read cookies from and dump cookie jar in')
653 filesystem
.add_option(
654 '--cache-dir', dest
='cachedir', default
=None, metavar
='DIR',
655 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.')
656 filesystem
.add_option(
657 '--no-cache-dir', action
='store_const', const
=False, dest
='cachedir',
658 help='Disable filesystem caching')
659 filesystem
.add_option(
661 action
='store_true', dest
='rm_cachedir',
662 help='Delete all filesystem cache files')
664 thumbnail
= optparse
.OptionGroup(parser
, 'Thumbnail images')
665 thumbnail
.add_option(
667 action
='store_true', dest
='writethumbnail', default
=False,
668 help='Write thumbnail image to disk')
669 thumbnail
.add_option(
670 '--write-all-thumbnails',
671 action
='store_true', dest
='write_all_thumbnails', default
=False,
672 help='Write all thumbnail image formats to disk')
673 thumbnail
.add_option(
675 action
='store_true', dest
='list_thumbnails', default
=False,
676 help='Simulate and list all available thumbnail formats')
678 postproc
= optparse
.OptionGroup(parser
, 'Post-processing Options')
680 '-x', '--extract-audio',
681 action
='store_true', dest
='extractaudio', default
=False,
682 help='Convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)')
684 '--audio-format', metavar
='FORMAT', dest
='audioformat', default
='best',
685 help='Specify audio format: "best", "aac", "vorbis", "mp3", "m4a", "opus", or "wav"; "%default" by default')
687 '--audio-quality', metavar
='QUALITY',
688 dest
='audioquality', default
='5',
689 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)')
692 metavar
='FORMAT', dest
='recodevideo', default
=None,
693 help='Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm|mkv)')
695 '-k', '--keep-video',
696 action
='store_true', dest
='keepvideo', default
=False,
697 help='Keep the video file on disk after the post-processing; the video is erased by default')
699 '--no-post-overwrites',
700 action
='store_true', dest
='nopostoverwrites', default
=False,
701 help='Do not overwrite post-processed files; the post-processed files are overwritten by default')
704 action
='store_true', dest
='embedsubtitles', default
=False,
705 help='Embed subtitles in the video (only for mkv and mp4 videos)')
708 action
='store_true', dest
='embedthumbnail', default
=False,
709 help='Embed thumbnail in the audio as cover art')
712 action
='store_true', dest
='addmetadata', default
=False,
713 help='Write metadata to the video file')
715 '--metadata-from-title',
716 metavar
='FORMAT', dest
='metafromtitle',
717 help='Parse additional metadata like song title / artist from the video title. '
718 'The format syntax is the same as --output, '
719 'the parsed parameters replace existing values. '
720 'Additional templates: %(album)s, %(artist)s. '
721 'Example: --metadata-from-title "%(artist)s - %(title)s" matches a title like '
722 '"Coldplay - Paradise"')
725 action
='store_true', dest
='xattrs', default
=False,
726 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
729 metavar
='POLICY', dest
='fixup', default
='detect_or_warn',
730 help='Automatically correct known faults of the file. '
731 'One of never (do nothing), warn (only emit a warning), '
732 'detect_or_warn(the default; fix file if we can, warn otherwise)')
735 action
='store_false', dest
='prefer_ffmpeg',
736 help='Prefer avconv over ffmpeg for running the postprocessors (default)')
739 action
='store_true', dest
='prefer_ffmpeg',
740 help='Prefer ffmpeg over avconv for running the postprocessors')
742 '--ffmpeg-location', '--avconv-location', metavar
='PATH',
743 dest
='ffmpeg_location',
744 help='Location of the ffmpeg/avconv binary; either the path to the binary or its containing directory.')
747 metavar
='CMD', dest
='exec_cmd',
748 help='Execute a command on the file after downloading, similar to find\'s -exec syntax. Example: --exec \'adb push {} /sdcard/Music/ && rm {}\'')
750 '--convert-subtitles', '--convert-subs',
751 metavar
='FORMAT', dest
='convertsubtitles', default
=None,
752 help='Convert the subtitles to other format (currently supported: srt|ass|vtt)')
754 parser
.add_option_group(general
)
755 parser
.add_option_group(network
)
756 parser
.add_option_group(selection
)
757 parser
.add_option_group(downloader
)
758 parser
.add_option_group(filesystem
)
759 parser
.add_option_group(thumbnail
)
760 parser
.add_option_group(verbosity
)
761 parser
.add_option_group(workarounds
)
762 parser
.add_option_group(video_format
)
763 parser
.add_option_group(subtitles
)
764 parser
.add_option_group(authentication
)
765 parser
.add_option_group(postproc
)
767 if overrideArguments
is not None:
768 opts
, args
= parser
.parse_args(overrideArguments
)
770 write_string('[debug] Override config: ' + repr(overrideArguments
) + '\n')
772 def compat_conf(conf
):
773 if sys
.version_info
< (3,):
774 return [a
.decode(preferredencoding(), 'replace') for a
in conf
]
777 command_line_conf
= compat_conf(sys
.argv
[1:])
779 if '--ignore-config' in command_line_conf
:
783 system_conf
= compat_conf(_readOptions('/etc/youtube-dl.conf'))
784 if '--ignore-config' in system_conf
:
787 user_conf
= compat_conf(_readUserConf())
788 argv
= system_conf
+ user_conf
+ command_line_conf
790 opts
, args
= parser
.parse_args(argv
)
792 write_string('[debug] System config: ' + repr(_hide_login_info(system_conf
)) + '\n')
793 write_string('[debug] User config: ' + repr(_hide_login_info(user_conf
)) + '\n')
794 write_string('[debug] Command-line args: ' + repr(_hide_login_info(command_line_conf
)) + '\n')
796 return parser
, opts
, args