Merge remote-tracking branch 'rupertbaxter2/master'
[ytdl] / youtube_dl / options.py
1 from __future__ import unicode_literals
2
3 import os.path
4 import optparse
5 import shlex
6 import sys
7
8 from .compat import (
9     compat_expanduser,
10     compat_getenv,
11     compat_kwargs,
12 )
13 from .utils import (
14     get_term_width,
15     write_string,
16 )
17 from .version import __version__
18
19
20 def parseOpts(overrideArguments=None):
21     def _readOptions(filename_bytes, default=[]):
22         try:
23             optionf = open(filename_bytes)
24         except IOError:
25             return default  # silently skip if file is not present
26         try:
27             res = []
28             for l in optionf:
29                 res += shlex.split(l, comments=True)
30         finally:
31             optionf.close()
32         return res
33
34     def _readUserConf():
35         xdg_config_home = compat_getenv('XDG_CONFIG_HOME')
36         if xdg_config_home:
37             userConfFile = os.path.join(xdg_config_home, 'youtube-dl', 'config')
38             if not os.path.isfile(userConfFile):
39                 userConfFile = os.path.join(xdg_config_home, 'youtube-dl.conf')
40         else:
41             userConfFile = os.path.join(compat_expanduser('~'), '.config', 'youtube-dl', 'config')
42             if not os.path.isfile(userConfFile):
43                 userConfFile = os.path.join(compat_expanduser('~'), '.config', 'youtube-dl.conf')
44         userConf = _readOptions(userConfFile, None)
45
46         if userConf is None:
47             appdata_dir = compat_getenv('appdata')
48             if appdata_dir:
49                 userConf = _readOptions(
50                     os.path.join(appdata_dir, 'youtube-dl', 'config'),
51                     default=None)
52                 if userConf is None:
53                     userConf = _readOptions(
54                         os.path.join(appdata_dir, 'youtube-dl', 'config.txt'),
55                         default=None)
56
57         if userConf is None:
58             userConf = _readOptions(
59                 os.path.join(compat_expanduser('~'), 'youtube-dl.conf'),
60                 default=None)
61         if userConf is None:
62             userConf = _readOptions(
63                 os.path.join(compat_expanduser('~'), 'youtube-dl.conf.txt'),
64                 default=None)
65
66         if userConf is None:
67             userConf = []
68
69         return userConf
70
71     def _format_option_string(option):
72         ''' ('-o', '--option') -> -o, --format METAVAR'''
73
74         opts = []
75
76         if option._short_opts:
77             opts.append(option._short_opts[0])
78         if option._long_opts:
79             opts.append(option._long_opts[0])
80         if len(opts) > 1:
81             opts.insert(1, ', ')
82
83         if option.takes_value():
84             opts.append(' %s' % option.metavar)
85
86         return "".join(opts)
87
88     def _comma_separated_values_options_callback(option, opt_str, value, parser):
89         setattr(parser.values, option.dest, value.split(','))
90
91     def _hide_login_info(opts):
92         opts = list(opts)
93         for private_opt in ['-p', '--password', '-u', '--username', '--video-password']:
94             try:
95                 i = opts.index(private_opt)
96                 opts[i + 1] = 'PRIVATE'
97             except ValueError:
98                 pass
99         return opts
100
101     # No need to wrap help messages if we're on a wide console
102     columns = get_term_width()
103     max_width = columns if columns else 80
104     max_help_position = 80
105
106     fmt = optparse.IndentedHelpFormatter(width=max_width, max_help_position=max_help_position)
107     fmt.format_option_strings = _format_option_string
108
109     kw = {
110         'version': __version__,
111         'formatter': fmt,
112         'usage': '%prog [OPTIONS] URL [URL...]',
113         'conflict_handler': 'resolve',
114     }
115
116     parser = optparse.OptionParser(**compat_kwargs(kw))
117
118     general = optparse.OptionGroup(parser, 'General Options')
119     general.add_option(
120         '-h', '--help',
121         action='help',
122         help='print this help text and exit')
123     general.add_option(
124         '-v', '--version',
125         action='version',
126         help='print program version and exit')
127     general.add_option(
128         '-U', '--update',
129         action='store_true', dest='update_self',
130         help='update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
131     general.add_option(
132         '-i', '--ignore-errors',
133         action='store_true', dest='ignoreerrors', default=False,
134         help='continue on download errors, for example to skip unavailable videos in a playlist')
135     general.add_option(
136         '--abort-on-error',
137         action='store_false', dest='ignoreerrors',
138         help='Abort downloading of further videos (in the playlist or the command line) if an error occurs')
139     general.add_option(
140         '--dump-user-agent',
141         action='store_true', dest='dump_user_agent', default=False,
142         help='display the current browser identification')
143     general.add_option(
144         '--list-extractors',
145         action='store_true', dest='list_extractors', default=False,
146         help='List all supported extractors and the URLs they would handle')
147     general.add_option(
148         '--extractor-descriptions',
149         action='store_true', dest='list_extractor_descriptions', default=False,
150         help='Output descriptions of all supported extractors')
151     general.add_option(
152         '--default-search',
153         dest='default_search', metavar='PREFIX',
154         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.')
155     general.add_option(
156         '--ignore-config',
157         action='store_true',
158         help='Do not read configuration files. '
159         'When given in the global configuration file /etc/youtube-dl.conf: '
160         'Do not read the user configuration in ~/.config/youtube-dl/config '
161         '(%APPDATA%/youtube-dl/config.txt on Windows)')
162     general.add_option(
163         '--flat-playlist',
164         action='store_const', dest='extract_flat', const='in_playlist',
165         default=False,
166         help='Do not extract the videos of a playlist, only list them.')
167
168     network = optparse.OptionGroup(parser, 'Network Options')
169     network.add_option(
170         '--proxy', dest='proxy',
171         default=None, metavar='URL',
172         help='Use the specified HTTP/HTTPS proxy. Pass in an empty string (--proxy "") for direct connection')
173     network.add_option(
174         '--socket-timeout',
175         dest='socket_timeout', type=float, default=None, metavar='SECONDS',
176         help='Time to wait before giving up, in seconds')
177     network.add_option(
178         '--source-address',
179         metavar='IP', dest='source_address', default=None,
180         help='Client-side IP address to bind to (experimental)',
181     )
182     network.add_option(
183         '-4', '--force-ipv4',
184         action='store_const', const='0.0.0.0', dest='source_address',
185         help='Make all connections via IPv4 (experimental)',
186     )
187     network.add_option(
188         '-6', '--force-ipv6',
189         action='store_const', const='::', dest='source_address',
190         help='Make all connections via IPv6 (experimental)',
191     )
192
193     selection = optparse.OptionGroup(parser, 'Video Selection')
194     selection.add_option(
195         '--playlist-start',
196         dest='playliststart', metavar='NUMBER', default=1, type=int,
197         help='playlist video to start at (default is %default)')
198     selection.add_option(
199         '--playlist-end',
200         dest='playlistend', metavar='NUMBER', default=None, type=int,
201         help='playlist video to end at (default is last)')
202     selection.add_option(
203         '--match-title',
204         dest='matchtitle', metavar='REGEX',
205         help='download only matching titles (regex or caseless sub-string)')
206     selection.add_option(
207         '--reject-title',
208         dest='rejecttitle', metavar='REGEX',
209         help='skip download for matching titles (regex or caseless sub-string)')
210     selection.add_option(
211         '--max-downloads',
212         dest='max_downloads', metavar='NUMBER', type=int, default=None,
213         help='Abort after downloading NUMBER files')
214     selection.add_option(
215         '--min-filesize',
216         metavar='SIZE', dest='min_filesize', default=None,
217         help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
218     selection.add_option(
219         '--max-filesize',
220         metavar='SIZE', dest='max_filesize', default=None,
221         help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
222     selection.add_option(
223         '--date',
224         metavar='DATE', dest='date', default=None,
225         help='download only videos uploaded in this date')
226     selection.add_option(
227         '--datebefore',
228         metavar='DATE', dest='datebefore', default=None,
229         help='download only videos uploaded on or before this date (i.e. inclusive)')
230     selection.add_option(
231         '--dateafter',
232         metavar='DATE', dest='dateafter', default=None,
233         help='download only videos uploaded on or after this date (i.e. inclusive)')
234     selection.add_option(
235         '--min-views',
236         metavar='COUNT', dest='min_views', default=None, type=int,
237         help='Do not download any videos with less than COUNT views',)
238     selection.add_option(
239         '--max-views',
240         metavar='COUNT', dest='max_views', default=None, type=int,
241         help='Do not download any videos with more than COUNT views')
242     selection.add_option(
243         '--no-playlist',
244         action='store_true', dest='noplaylist', default=False,
245         help='If the URL refers to a video and a playlist, download only the video.')
246     selection.add_option(
247         '--age-limit',
248         metavar='YEARS', dest='age_limit', default=None, type=int,
249         help='download only videos suitable for the given age')
250     selection.add_option(
251         '--download-archive', metavar='FILE',
252         dest='download_archive',
253         help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it.')
254     selection.add_option(
255         '--include-ads',
256         dest='include_ads', action='store_true',
257         help='Download advertisements as well (experimental)')
258
259     authentication = optparse.OptionGroup(parser, 'Authentication Options')
260     authentication.add_option(
261         '-u', '--username',
262         dest='username', metavar='USERNAME',
263         help='login with this account ID')
264     authentication.add_option(
265         '-p', '--password',
266         dest='password', metavar='PASSWORD',
267         help='account password. If this option is left out, youtube-dl will ask interactively.')
268     authentication.add_option(
269         '-2', '--twofactor',
270         dest='twofactor', metavar='TWOFACTOR',
271         help='two-factor auth code')
272     authentication.add_option(
273         '-n', '--netrc',
274         action='store_true', dest='usenetrc', default=False,
275         help='use .netrc authentication data')
276     authentication.add_option(
277         '--video-password',
278         dest='videopassword', metavar='PASSWORD',
279         help='video password (vimeo, smotri)')
280
281     video_format = optparse.OptionGroup(parser, 'Video Format Options')
282     video_format.add_option(
283         '-f', '--format',
284         action='store', dest='format', metavar='FORMAT', default=None,
285         help=(
286             'video format code, specify the order of preference using'
287             ' slashes, as in -f 22/17/18 . '
288             ' Instead of format codes, you can select by extension for the '
289             'extensions aac, m4a, mp3, mp4, ogg, wav, webm. '
290             'You can also use the special names "best",'
291             ' "bestvideo", "bestaudio", "worst". '
292             ' You can filter the video results by putting a condition in'
293             ' brackets, as in -f "best[height=720]"'
294             ' (or -f "[filesize>10M]"). '
295             ' This works for filesize, height, width, tbr, abr, and vbr'
296             ' and the comparisons <, <=, >, >=, =, != .'
297             ' Formats for which the value is not known are excluded unless you'
298             ' put a question mark (?) after the operator.'
299             ' You can combine format filters, so  '
300             '-f "[height <=? 720][tbr>500]" '
301             'selects up to 720p videos (or videos where the height is not '
302             'known) with a bitrate of at least 500 KBit/s.'
303             ' By default, youtube-dl will pick the best quality.'
304             ' Use commas to download multiple audio formats, such as'
305             ' -f  136/137/mp4/bestvideo,140/m4a/bestaudio.'
306             ' You can merge the video and audio of two formats into a single'
307             ' file using -f <video-format>+<audio-format> (requires ffmpeg or'
308             ' avconv), for example -f bestvideo+bestaudio.'))
309     video_format.add_option(
310         '--all-formats',
311         action='store_const', dest='format', const='all',
312         help='download all available video formats')
313     video_format.add_option(
314         '--prefer-free-formats',
315         action='store_true', dest='prefer_free_formats', default=False,
316         help='prefer free video formats unless a specific one is requested')
317     video_format.add_option(
318         '--max-quality',
319         action='store', dest='format_limit', metavar='FORMAT',
320         help='highest quality format to download')
321     video_format.add_option(
322         '-F', '--list-formats',
323         action='store_true', dest='listformats',
324         help='list all available formats')
325     video_format.add_option(
326         '--youtube-include-dash-manifest',
327         action='store_true', dest='youtube_include_dash_manifest', default=True,
328         help=optparse.SUPPRESS_HELP)
329     video_format.add_option(
330         '--youtube-skip-dash-manifest',
331         action='store_false', dest='youtube_include_dash_manifest',
332         help='Do not download the DASH manifest on YouTube videos')
333     video_format.add_option(
334         '--merge-output-format',
335         action='store', dest='merge_output_format', metavar='FORMAT', default=None,
336         help=(
337             'If a merge is required (e.g. bestvideo+bestaudio), output to given container format. One of mkv, mp4, ogg, webm, flv.'
338             'Ignored if no merge is required'))
339
340     subtitles = optparse.OptionGroup(parser, 'Subtitle Options')
341     subtitles.add_option(
342         '--write-sub', '--write-srt',
343         action='store_true', dest='writesubtitles', default=False,
344         help='write subtitle file')
345     subtitles.add_option(
346         '--write-auto-sub', '--write-automatic-sub',
347         action='store_true', dest='writeautomaticsub', default=False,
348         help='write automatic subtitle file (youtube only)')
349     subtitles.add_option(
350         '--all-subs',
351         action='store_true', dest='allsubtitles', default=False,
352         help='downloads all the available subtitles of the video')
353     subtitles.add_option(
354         '--list-subs',
355         action='store_true', dest='listsubtitles', default=False,
356         help='lists all available subtitles for the video')
357     subtitles.add_option(
358         '--sub-format',
359         action='store', dest='subtitlesformat', metavar='FORMAT', default='srt',
360         help='subtitle format (default=srt) ([sbv/vtt] youtube only)')
361     subtitles.add_option(
362         '--sub-lang', '--sub-langs', '--srt-lang',
363         action='callback', dest='subtitleslangs', metavar='LANGS', type='str',
364         default=[], callback=_comma_separated_values_options_callback,
365         help='languages of the subtitles to download (optional) separated by commas, use IETF language tags like \'en,pt\'')
366
367     downloader = optparse.OptionGroup(parser, 'Download Options')
368     downloader.add_option(
369         '-r', '--rate-limit',
370         dest='ratelimit', metavar='LIMIT',
371         help='maximum download rate in bytes per second (e.g. 50K or 4.2M)')
372     downloader.add_option(
373         '-R', '--retries',
374         dest='retries', metavar='RETRIES', default=10,
375         help='number of retries (default is %default)')
376     downloader.add_option(
377         '--buffer-size',
378         dest='buffersize', metavar='SIZE', default='1024',
379         help='size of download buffer (e.g. 1024 or 16K) (default is %default)')
380     downloader.add_option(
381         '--no-resize-buffer',
382         action='store_true', dest='noresizebuffer', default=False,
383         help='do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.')
384     downloader.add_option(
385         '--test',
386         action='store_true', dest='test', default=False,
387         help=optparse.SUPPRESS_HELP)
388     downloader.add_option(
389         '--playlist-reverse',
390         action='store_true',
391         help='Download playlist videos in reverse order')
392
393     workarounds = optparse.OptionGroup(parser, 'Workarounds')
394     workarounds.add_option(
395         '--encoding',
396         dest='encoding', metavar='ENCODING',
397         help='Force the specified encoding (experimental)')
398     workarounds.add_option(
399         '--no-check-certificate',
400         action='store_true', dest='no_check_certificate', default=False,
401         help='Suppress HTTPS certificate validation.')
402     workarounds.add_option(
403         '--prefer-insecure',
404         '--prefer-unsecure', action='store_true', dest='prefer_insecure',
405         help='Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)')
406     workarounds.add_option(
407         '--user-agent',
408         metavar='UA', dest='user_agent',
409         help='specify a custom user agent')
410     workarounds.add_option(
411         '--referer',
412         metavar='URL', dest='referer', default=None,
413         help='specify a custom referer, use if the video access is restricted to one domain',
414     )
415     workarounds.add_option(
416         '--add-header',
417         metavar='FIELD:VALUE', dest='headers', action='append',
418         help='specify a custom HTTP header and its value, separated by a colon \':\'. You can use this option multiple times',
419     )
420     workarounds.add_option(
421         '--bidi-workaround',
422         dest='bidi_workaround', action='store_true',
423         help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
424     workarounds.add_option(
425         '--sleep-interval', metavar='SECONDS',
426         dest='sleep_interval',
427         help='Number of seconds to sleep before each download.')
428
429     verbosity = optparse.OptionGroup(parser, 'Verbosity / Simulation Options')
430     verbosity.add_option(
431         '-q', '--quiet',
432         action='store_true', dest='quiet', default=False,
433         help='activates quiet mode')
434     verbosity.add_option(
435         '--no-warnings',
436         dest='no_warnings', action='store_true', default=False,
437         help='Ignore warnings')
438     verbosity.add_option(
439         '-s', '--simulate',
440         action='store_true', dest='simulate', default=False,
441         help='do not download the video and do not write anything to disk',)
442     verbosity.add_option(
443         '--skip-download',
444         action='store_true', dest='skip_download', default=False,
445         help='do not download the video',)
446     verbosity.add_option(
447         '-g', '--get-url',
448         action='store_true', dest='geturl', default=False,
449         help='simulate, quiet but print URL')
450     verbosity.add_option(
451         '-e', '--get-title',
452         action='store_true', dest='gettitle', default=False,
453         help='simulate, quiet but print title')
454     verbosity.add_option(
455         '--get-id',
456         action='store_true', dest='getid', default=False,
457         help='simulate, quiet but print id')
458     verbosity.add_option(
459         '--get-thumbnail',
460         action='store_true', dest='getthumbnail', default=False,
461         help='simulate, quiet but print thumbnail URL')
462     verbosity.add_option(
463         '--get-description',
464         action='store_true', dest='getdescription', default=False,
465         help='simulate, quiet but print video description')
466     verbosity.add_option(
467         '--get-duration',
468         action='store_true', dest='getduration', default=False,
469         help='simulate, quiet but print video length')
470     verbosity.add_option(
471         '--get-filename',
472         action='store_true', dest='getfilename', default=False,
473         help='simulate, quiet but print output filename')
474     verbosity.add_option(
475         '--get-format',
476         action='store_true', dest='getformat', default=False,
477         help='simulate, quiet but print output format')
478     verbosity.add_option(
479         '-j', '--dump-json',
480         action='store_true', dest='dumpjson', default=False,
481         help='simulate, quiet but print JSON information. See --output for a description of available keys.')
482     verbosity.add_option(
483         '-J', '--dump-single-json',
484         action='store_true', dest='dump_single_json', default=False,
485         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.')
486     verbosity.add_option(
487         '--print-json',
488         action='store_true', dest='print_json', default=False,
489         help='Be quiet and print the video information as JSON (video is still being downloaded).',
490     )
491     verbosity.add_option(
492         '--newline',
493         action='store_true', dest='progress_with_newline', default=False,
494         help='output progress bar as new lines')
495     verbosity.add_option(
496         '--no-progress',
497         action='store_true', dest='noprogress', default=False,
498         help='do not print progress bar')
499     verbosity.add_option(
500         '--console-title',
501         action='store_true', dest='consoletitle', default=False,
502         help='display progress in console titlebar')
503     verbosity.add_option(
504         '-v', '--verbose',
505         action='store_true', dest='verbose', default=False,
506         help='print various debugging information')
507     verbosity.add_option(
508         '--dump-intermediate-pages',
509         action='store_true', dest='dump_intermediate_pages', default=False,
510         help='print downloaded pages to debug problems (very verbose)')
511     verbosity.add_option(
512         '--write-pages',
513         action='store_true', dest='write_pages', default=False,
514         help='Write downloaded intermediary pages to files in the current directory to debug problems')
515     verbosity.add_option(
516         '--youtube-print-sig-code',
517         action='store_true', dest='youtube_print_sig_code', default=False,
518         help=optparse.SUPPRESS_HELP)
519     verbosity.add_option(
520         '--print-traffic',
521         dest='debug_printtraffic', action='store_true', default=False,
522         help='Display sent and read HTTP traffic')
523     verbosity.add_option(
524         '-C', '--call-home',
525         dest='call_home', action='store_true', default=False,
526         help='Contact the youtube-dl server for debugging.')
527     verbosity.add_option(
528         '--no-call-home',
529         dest='call_home', action='store_false', default=False,
530         help='Do NOT contact the youtube-dl server for debugging.')
531
532     filesystem = optparse.OptionGroup(parser, 'Filesystem Options')
533     filesystem.add_option(
534         '-a', '--batch-file',
535         dest='batchfile', metavar='FILE',
536         help='file containing URLs to download (\'-\' for stdin)')
537     filesystem.add_option(
538         '--id', default=False,
539         action='store_true', dest='useid', help='use only video ID in file name')
540     filesystem.add_option(
541         '-o', '--output',
542         dest='outtmpl', metavar='TEMPLATE',
543         help=('output filename template. Use %(title)s to get the title, '
544               '%(uploader)s for the uploader name, %(uploader_id)s for the uploader nickname if different, '
545               '%(autonumber)s to get an automatically incremented number, '
546               '%(ext)s for the filename extension, '
547               '%(format)s for the format description (like "22 - 1280x720" or "HD"), '
548               '%(format_id)s for the unique id of the format (like Youtube\'s itags: "137"), '
549               '%(upload_date)s for the upload date (YYYYMMDD), '
550               '%(extractor)s for the provider (youtube, metacafe, etc), '
551               '%(id)s for the video id, '
552               '%(playlist_title)s, %(playlist_id)s, or %(playlist)s (=title if present, ID otherwise) for the playlist the video is in, '
553               '%(playlist_index)s for the position in the playlist. '
554               '%(height)s and %(width)s for the width and height of the video format. '
555               '%(resolution)s for a textual description of the resolution of the video format. '
556               '%% for a literal percent. '
557               'Use - to output to stdout. Can also be used to download to a different directory, '
558               'for example with -o \'/my/downloads/%(uploader)s/%(title)s-%(id)s.%(ext)s\' .'))
559     filesystem.add_option(
560         '--autonumber-size',
561         dest='autonumber_size', metavar='NUMBER',
562         help='Specifies the number of digits in %(autonumber)s when it is present in output filename template or --auto-number option is given')
563     filesystem.add_option(
564         '--restrict-filenames',
565         action='store_true', dest='restrictfilenames', default=False,
566         help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
567     filesystem.add_option(
568         '-A', '--auto-number',
569         action='store_true', dest='autonumber', default=False,
570         help='[deprecated; use  -o "%(autonumber)s-%(title)s.%(ext)s" ] number downloaded files starting from 00000')
571     filesystem.add_option(
572         '-t', '--title',
573         action='store_true', dest='usetitle', default=False,
574         help='[deprecated] use title in file name (default)')
575     filesystem.add_option(
576         '-l', '--literal', default=False,
577         action='store_true', dest='usetitle',
578         help='[deprecated] alias of --title')
579     filesystem.add_option(
580         '-w', '--no-overwrites',
581         action='store_true', dest='nooverwrites', default=False,
582         help='do not overwrite files')
583     filesystem.add_option(
584         '-c', '--continue',
585         action='store_true', dest='continue_dl', default=True,
586         help='force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.')
587     filesystem.add_option(
588         '--no-continue',
589         action='store_false', dest='continue_dl',
590         help='do not resume partially downloaded files (restart from beginning)')
591     filesystem.add_option(
592         '--no-part',
593         action='store_true', dest='nopart', default=False,
594         help='do not use .part files - write directly into output file')
595     filesystem.add_option(
596         '--no-mtime',
597         action='store_false', dest='updatetime', default=True,
598         help='do not use the Last-modified header to set the file modification time')
599     filesystem.add_option(
600         '--write-description',
601         action='store_true', dest='writedescription', default=False,
602         help='write video description to a .description file')
603     filesystem.add_option(
604         '--write-info-json',
605         action='store_true', dest='writeinfojson', default=False,
606         help='write video metadata to a .info.json file')
607     filesystem.add_option(
608         '--write-annotations',
609         action='store_true', dest='writeannotations', default=False,
610         help='write video annotations to a .annotation file')
611     filesystem.add_option(
612         '--write-thumbnail',
613         action='store_true', dest='writethumbnail', default=False,
614         help='write thumbnail image to disk')
615     filesystem.add_option(
616         '--load-info',
617         dest='load_info_filename', metavar='FILE',
618         help='json file containing the video information (created with the "--write-json" option)')
619     filesystem.add_option(
620         '--cookies',
621         dest='cookiefile', metavar='FILE',
622         help='file to read cookies from and dump cookie jar in')
623     filesystem.add_option(
624         '--cache-dir', dest='cachedir', default=None, metavar='DIR',
625         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.')
626     filesystem.add_option(
627         '--no-cache-dir', action='store_const', const=False, dest='cachedir',
628         help='Disable filesystem caching')
629     filesystem.add_option(
630         '--rm-cache-dir',
631         action='store_true', dest='rm_cachedir',
632         help='Delete all filesystem cache files')
633
634     postproc = optparse.OptionGroup(parser, 'Post-processing Options')
635     postproc.add_option(
636         '-x', '--extract-audio',
637         action='store_true', dest='extractaudio', default=False,
638         help='convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)')
639     postproc.add_option(
640         '--audio-format', metavar='FORMAT', dest='audioformat', default='best',
641         help='"best", "aac", "vorbis", "mp3", "m4a", "opus", or "wav"; "%default" by default')
642     postproc.add_option(
643         '--audio-quality', metavar='QUALITY',
644         dest='audioquality', default='5',
645         help='ffmpeg/avconv audio quality specification, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default %default)')
646     postproc.add_option(
647         '--recode-video',
648         metavar='FORMAT', dest='recodevideo', default=None,
649         help='Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm|mkv)')
650     postproc.add_option(
651         '-k', '--keep-video',
652         action='store_true', dest='keepvideo', default=False,
653         help='keeps the video file on disk after the post-processing; the video is erased by default')
654     postproc.add_option(
655         '--no-post-overwrites',
656         action='store_true', dest='nopostoverwrites', default=False,
657         help='do not overwrite post-processed files; the post-processed files are overwritten by default')
658     postproc.add_option(
659         '--embed-subs',
660         action='store_true', dest='embedsubtitles', default=False,
661         help='embed subtitles in the video (only for mp4 videos)')
662     postproc.add_option(
663         '--embed-thumbnail',
664         action='store_true', dest='embedthumbnail', default=False,
665         help='embed thumbnail in the audio as cover art')
666     postproc.add_option(
667         '--add-metadata',
668         action='store_true', dest='addmetadata', default=False,
669         help='write metadata to the video file')
670     postproc.add_option(
671         '--xattrs',
672         action='store_true', dest='xattrs', default=False,
673         help='write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
674     postproc.add_option(
675         '--fixup',
676         metavar='POLICY', dest='fixup', default='detect_or_warn',
677         help='(experimental) Automatically correct known faults of the file. '
678              'One of never (do nothing), warn (only emit a warning), '
679              'detect_or_warn(check whether we can do anything about it, warn '
680              'otherwise')
681     postproc.add_option(
682         '--prefer-avconv',
683         action='store_false', dest='prefer_ffmpeg',
684         help='Prefer avconv over ffmpeg for running the postprocessors (default)')
685     postproc.add_option(
686         '--prefer-ffmpeg',
687         action='store_true', dest='prefer_ffmpeg',
688         help='Prefer ffmpeg over avconv for running the postprocessors')
689     postproc.add_option(
690         '--exec',
691         metavar='CMD', dest='exec_cmd',
692         help='Execute a command on the file after downloading, similar to find\'s -exec syntax. Example: --exec \'adb push {} /sdcard/Music/ && rm {}\'')
693
694     parser.add_option_group(general)
695     parser.add_option_group(network)
696     parser.add_option_group(selection)
697     parser.add_option_group(downloader)
698     parser.add_option_group(filesystem)
699     parser.add_option_group(verbosity)
700     parser.add_option_group(workarounds)
701     parser.add_option_group(video_format)
702     parser.add_option_group(subtitles)
703     parser.add_option_group(authentication)
704     parser.add_option_group(postproc)
705
706     if overrideArguments is not None:
707         opts, args = parser.parse_args(overrideArguments)
708         if opts.verbose:
709             write_string('[debug] Override config: ' + repr(overrideArguments) + '\n')
710     else:
711         commandLineConf = sys.argv[1:]
712         if '--ignore-config' in commandLineConf:
713             systemConf = []
714             userConf = []
715         else:
716             systemConf = _readOptions('/etc/youtube-dl.conf')
717             if '--ignore-config' in systemConf:
718                 userConf = []
719             else:
720                 userConf = _readUserConf()
721         argv = systemConf + userConf + commandLineConf
722
723         opts, args = parser.parse_args(argv)
724         if opts.verbose:
725             write_string('[debug] System config: ' + repr(_hide_login_info(systemConf)) + '\n')
726             write_string('[debug] User config: ' + repr(_hide_login_info(userConf)) + '\n')
727             write_string('[debug] Command-line args: ' + repr(_hide_login_info(commandLineConf)) + '\n')
728
729     return parser, opts, args