Merge pull request #4647 from aajanki/hds_metadata
[youtube-dl] / 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         '--proxy', dest='proxy',
153         default=None, metavar='URL',
154         help='Use the specified HTTP/HTTPS proxy. Pass in an empty string (--proxy "") for direct connection')
155     general.add_option(
156         '--socket-timeout',
157         dest='socket_timeout', type=float, default=None,
158         help='Time to wait before giving up, in seconds')
159     general.add_option(
160         '--default-search',
161         dest='default_search', metavar='PREFIX',
162         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.')
163     general.add_option(
164         '--ignore-config',
165         action='store_true',
166         help='Do not read configuration files. '
167         'When given in the global configuration file /etc/youtube-dl.conf: '
168         'Do not read the user configuration in ~/.config/youtube-dl/config '
169         '(%APPDATA%/youtube-dl/config.txt on Windows)')
170     general.add_option(
171         '--flat-playlist',
172         action='store_const', dest='extract_flat', const='in_playlist',
173         default=False,
174         help='Do not extract the videos of a playlist, only list them.')
175
176     selection = optparse.OptionGroup(parser, 'Video Selection')
177     selection.add_option(
178         '--playlist-start',
179         dest='playliststart', metavar='NUMBER', default=1, type=int,
180         help='playlist video to start at (default is %default)')
181     selection.add_option(
182         '--playlist-end',
183         dest='playlistend', metavar='NUMBER', default=None, type=int,
184         help='playlist video to end at (default is last)')
185     selection.add_option(
186         '--match-title',
187         dest='matchtitle', metavar='REGEX',
188         help='download only matching titles (regex or caseless sub-string)')
189     selection.add_option(
190         '--reject-title',
191         dest='rejecttitle', metavar='REGEX',
192         help='skip download for matching titles (regex or caseless sub-string)')
193     selection.add_option(
194         '--max-downloads',
195         dest='max_downloads', metavar='NUMBER', type=int, default=None,
196         help='Abort after downloading NUMBER files')
197     selection.add_option(
198         '--min-filesize',
199         metavar='SIZE', dest='min_filesize', default=None,
200         help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
201     selection.add_option(
202         '--max-filesize',
203         metavar='SIZE', dest='max_filesize', default=None,
204         help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
205     selection.add_option(
206         '--date',
207         metavar='DATE', dest='date', default=None,
208         help='download only videos uploaded in this date')
209     selection.add_option(
210         '--datebefore',
211         metavar='DATE', dest='datebefore', default=None,
212         help='download only videos uploaded on or before this date (i.e. inclusive)')
213     selection.add_option(
214         '--dateafter',
215         metavar='DATE', dest='dateafter', default=None,
216         help='download only videos uploaded on or after this date (i.e. inclusive)')
217     selection.add_option(
218         '--min-views',
219         metavar='COUNT', dest='min_views', default=None, type=int,
220         help='Do not download any videos with less than COUNT views',)
221     selection.add_option(
222         '--max-views',
223         metavar='COUNT', dest='max_views', default=None, type=int,
224         help='Do not download any videos with more than COUNT views')
225     selection.add_option(
226         '--no-playlist',
227         action='store_true', dest='noplaylist', default=False,
228         help='If the URL refers to a video and a playlist, download only the video.')
229     selection.add_option(
230         '--age-limit',
231         metavar='YEARS', dest='age_limit', default=None, type=int,
232         help='download only videos suitable for the given age')
233     selection.add_option(
234         '--download-archive', metavar='FILE',
235         dest='download_archive',
236         help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it.')
237     selection.add_option(
238         '--include-ads',
239         dest='include_ads', action='store_true',
240         help='Download advertisements as well (experimental)')
241
242     authentication = optparse.OptionGroup(parser, 'Authentication Options')
243     authentication.add_option(
244         '-u', '--username',
245         dest='username', metavar='USERNAME',
246         help='login with this account ID')
247     authentication.add_option(
248         '-p', '--password',
249         dest='password', metavar='PASSWORD',
250         help='account password')
251     authentication.add_option(
252         '-2', '--twofactor',
253         dest='twofactor', metavar='TWOFACTOR',
254         help='two-factor auth code')
255     authentication.add_option(
256         '-n', '--netrc',
257         action='store_true', dest='usenetrc', default=False,
258         help='use .netrc authentication data')
259     authentication.add_option(
260         '--video-password',
261         dest='videopassword', metavar='PASSWORD',
262         help='video password (vimeo, smotri)')
263
264     video_format = optparse.OptionGroup(parser, 'Video Format Options')
265     video_format.add_option(
266         '-f', '--format',
267         action='store', dest='format', metavar='FORMAT', default=None,
268         help=(
269             'video format code, specify the order of preference using'
270             ' slashes, as in -f 22/17/18 . '
271             ' Instead of format codes, you can select by extension for the '
272             'extensions aac, m4a, mp3, mp4, ogg, wav, webm. '
273             'You can also use the special names "best",'
274             ' "bestvideo", "bestaudio", "worst". '
275             ' By default, youtube-dl will pick the best quality.'
276             ' Use commas to download multiple audio formats, such as'
277             ' -f  136/137/mp4/bestvideo,140/m4a/bestaudio.'
278             ' You can merge the video and audio of two formats into a single'
279             ' file using -f <video-format>+<audio-format> (requires ffmpeg or'
280             ' avconv), for example -f bestvideo+bestaudio.'))
281     video_format.add_option(
282         '--all-formats',
283         action='store_const', dest='format', const='all',
284         help='download all available video formats')
285     video_format.add_option(
286         '--prefer-free-formats',
287         action='store_true', dest='prefer_free_formats', default=False,
288         help='prefer free video formats unless a specific one is requested')
289     video_format.add_option(
290         '--max-quality',
291         action='store', dest='format_limit', metavar='FORMAT',
292         help='highest quality format to download')
293     video_format.add_option(
294         '-F', '--list-formats',
295         action='store_true', dest='listformats',
296         help='list all available formats')
297     video_format.add_option(
298         '--youtube-include-dash-manifest',
299         action='store_true', dest='youtube_include_dash_manifest', default=True,
300         help=optparse.SUPPRESS_HELP)
301     video_format.add_option(
302         '--youtube-skip-dash-manifest',
303         action='store_false', dest='youtube_include_dash_manifest',
304         help='Do not download the DASH manifest on YouTube videos')
305
306     subtitles = optparse.OptionGroup(parser, 'Subtitle Options')
307     subtitles.add_option(
308         '--write-sub', '--write-srt',
309         action='store_true', dest='writesubtitles', default=False,
310         help='write subtitle file')
311     subtitles.add_option(
312         '--write-auto-sub', '--write-automatic-sub',
313         action='store_true', dest='writeautomaticsub', default=False,
314         help='write automatic subtitle file (youtube only)')
315     subtitles.add_option(
316         '--all-subs',
317         action='store_true', dest='allsubtitles', default=False,
318         help='downloads all the available subtitles of the video')
319     subtitles.add_option(
320         '--list-subs',
321         action='store_true', dest='listsubtitles', default=False,
322         help='lists all available subtitles for the video')
323     subtitles.add_option(
324         '--sub-format',
325         action='store', dest='subtitlesformat', metavar='FORMAT', default='srt',
326         help='subtitle format (default=srt) ([sbv/vtt] youtube only)')
327     subtitles.add_option(
328         '--sub-lang', '--sub-langs', '--srt-lang',
329         action='callback', dest='subtitleslangs', metavar='LANGS', type='str',
330         default=[], callback=_comma_separated_values_options_callback,
331         help='languages of the subtitles to download (optional) separated by commas, use IETF language tags like \'en,pt\'')
332
333     downloader = optparse.OptionGroup(parser, 'Download Options')
334     downloader.add_option(
335         '-r', '--rate-limit',
336         dest='ratelimit', metavar='LIMIT',
337         help='maximum download rate in bytes per second (e.g. 50K or 4.2M)')
338     downloader.add_option(
339         '-R', '--retries',
340         dest='retries', metavar='RETRIES', default=10,
341         help='number of retries (default is %default)')
342     downloader.add_option(
343         '--buffer-size',
344         dest='buffersize', metavar='SIZE', default='1024',
345         help='size of download buffer (e.g. 1024 or 16K) (default is %default)')
346     downloader.add_option(
347         '--no-resize-buffer',
348         action='store_true', dest='noresizebuffer', default=False,
349         help='do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.')
350     downloader.add_option(
351         '--test',
352         action='store_true', dest='test', default=False,
353         help=optparse.SUPPRESS_HELP)
354     downloader.add_option(
355         '--playlist-reverse',
356         action='store_true',
357         help='Download playlist videos in reverse order')
358
359     workarounds = optparse.OptionGroup(parser, 'Workarounds')
360     workarounds.add_option(
361         '--encoding',
362         dest='encoding', metavar='ENCODING',
363         help='Force the specified encoding (experimental)')
364     workarounds.add_option(
365         '--no-check-certificate',
366         action='store_true', dest='no_check_certificate', default=False,
367         help='Suppress HTTPS certificate validation.')
368     workarounds.add_option(
369         '--prefer-insecure',
370         '--prefer-unsecure', action='store_true', dest='prefer_insecure',
371         help='Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)')
372     workarounds.add_option(
373         '--user-agent',
374         metavar='UA', dest='user_agent',
375         help='specify a custom user agent')
376     workarounds.add_option(
377         '--referer',
378         metavar='URL', dest='referer', default=None,
379         help='specify a custom referer, use if the video access is restricted to one domain',
380     )
381     workarounds.add_option(
382         '--add-header',
383         metavar='FIELD:VALUE', dest='headers', action='append',
384         help='specify a custom HTTP header and its value, separated by a colon \':\'. You can use this option multiple times',
385     )
386     workarounds.add_option(
387         '--bidi-workaround',
388         dest='bidi_workaround', action='store_true',
389         help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
390
391     verbosity = optparse.OptionGroup(parser, 'Verbosity / Simulation Options')
392     verbosity.add_option(
393         '-q', '--quiet',
394         action='store_true', dest='quiet', default=False,
395         help='activates quiet mode')
396     verbosity.add_option(
397         '--no-warnings',
398         dest='no_warnings', action='store_true', default=False,
399         help='Ignore warnings')
400     verbosity.add_option(
401         '-s', '--simulate',
402         action='store_true', dest='simulate', default=False,
403         help='do not download the video and do not write anything to disk',)
404     verbosity.add_option(
405         '--skip-download',
406         action='store_true', dest='skip_download', default=False,
407         help='do not download the video',)
408     verbosity.add_option(
409         '-g', '--get-url',
410         action='store_true', dest='geturl', default=False,
411         help='simulate, quiet but print URL')
412     verbosity.add_option(
413         '-e', '--get-title',
414         action='store_true', dest='gettitle', default=False,
415         help='simulate, quiet but print title')
416     verbosity.add_option(
417         '--get-id',
418         action='store_true', dest='getid', default=False,
419         help='simulate, quiet but print id')
420     verbosity.add_option(
421         '--get-thumbnail',
422         action='store_true', dest='getthumbnail', default=False,
423         help='simulate, quiet but print thumbnail URL')
424     verbosity.add_option(
425         '--get-description',
426         action='store_true', dest='getdescription', default=False,
427         help='simulate, quiet but print video description')
428     verbosity.add_option(
429         '--get-duration',
430         action='store_true', dest='getduration', default=False,
431         help='simulate, quiet but print video length')
432     verbosity.add_option(
433         '--get-filename',
434         action='store_true', dest='getfilename', default=False,
435         help='simulate, quiet but print output filename')
436     verbosity.add_option(
437         '--get-format',
438         action='store_true', dest='getformat', default=False,
439         help='simulate, quiet but print output format')
440     verbosity.add_option(
441         '-j', '--dump-json',
442         action='store_true', dest='dumpjson', default=False,
443         help='simulate, quiet but print JSON information. See --output for a description of available keys.')
444     verbosity.add_option(
445         '-J', '--dump-single-json',
446         action='store_true', dest='dump_single_json', default=False,
447         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.')
448     verbosity.add_option(
449         '--newline',
450         action='store_true', dest='progress_with_newline', default=False,
451         help='output progress bar as new lines')
452     verbosity.add_option(
453         '--no-progress',
454         action='store_true', dest='noprogress', default=False,
455         help='do not print progress bar')
456     verbosity.add_option(
457         '--console-title',
458         action='store_true', dest='consoletitle', default=False,
459         help='display progress in console titlebar')
460     verbosity.add_option(
461         '-v', '--verbose',
462         action='store_true', dest='verbose', default=False,
463         help='print various debugging information')
464     verbosity.add_option(
465         '--dump-intermediate-pages',
466         action='store_true', dest='dump_intermediate_pages', default=False,
467         help='print downloaded pages to debug problems (very verbose)')
468     verbosity.add_option(
469         '--write-pages',
470         action='store_true', dest='write_pages', default=False,
471         help='Write downloaded intermediary pages to files in the current directory to debug problems')
472     verbosity.add_option(
473         '--youtube-print-sig-code',
474         action='store_true', dest='youtube_print_sig_code', default=False,
475         help=optparse.SUPPRESS_HELP)
476     verbosity.add_option(
477         '--print-traffic',
478         dest='debug_printtraffic', action='store_true', default=False,
479         help='Display sent and read HTTP traffic')
480
481     filesystem = optparse.OptionGroup(parser, 'Filesystem Options')
482     filesystem.add_option(
483         '-a', '--batch-file',
484         dest='batchfile', metavar='FILE',
485         help='file containing URLs to download (\'-\' for stdin)')
486     filesystem.add_option(
487         '--id', default=False,
488         action='store_true', dest='useid', help='use only video ID in file name')
489     filesystem.add_option(
490         '-o', '--output',
491         dest='outtmpl', metavar='TEMPLATE',
492         help=('output filename template. Use %(title)s to get the title, '
493               '%(uploader)s for the uploader name, %(uploader_id)s for the uploader nickname if different, '
494               '%(autonumber)s to get an automatically incremented number, '
495               '%(ext)s for the filename extension, '
496               '%(format)s for the format description (like "22 - 1280x720" or "HD"), '
497               '%(format_id)s for the unique id of the format (like Youtube\'s itags: "137"), '
498               '%(upload_date)s for the upload date (YYYYMMDD), '
499               '%(extractor)s for the provider (youtube, metacafe, etc), '
500               '%(id)s for the video id, '
501               '%(playlist_title)s, %(playlist_id)s, or %(playlist)s (=title if present, ID otherwise) for the playlist the video is in, '
502               '%(playlist_index)s for the position in the playlist. '
503               '%(height)s and %(width)s for the width and height of the video format. '
504               '%(resolution)s for a textual description of the resolution of the video format. '
505               '%% for a literal percent. '
506               'Use - to output to stdout. Can also be used to download to a different directory, '
507               'for example with -o \'/my/downloads/%(uploader)s/%(title)s-%(id)s.%(ext)s\' .'))
508     filesystem.add_option(
509         '--autonumber-size',
510         dest='autonumber_size', metavar='NUMBER',
511         help='Specifies the number of digits in %(autonumber)s when it is present in output filename template or --auto-number option is given')
512     filesystem.add_option(
513         '--restrict-filenames',
514         action='store_true', dest='restrictfilenames', default=False,
515         help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
516     filesystem.add_option(
517         '-A', '--auto-number',
518         action='store_true', dest='autonumber', default=False,
519         help='[deprecated; use  -o "%(autonumber)s-%(title)s.%(ext)s" ] number downloaded files starting from 00000')
520     filesystem.add_option(
521         '-t', '--title',
522         action='store_true', dest='usetitle', default=False,
523         help='[deprecated] use title in file name (default)')
524     filesystem.add_option(
525         '-l', '--literal', default=False,
526         action='store_true', dest='usetitle',
527         help='[deprecated] alias of --title')
528     filesystem.add_option(
529         '-w', '--no-overwrites',
530         action='store_true', dest='nooverwrites', default=False,
531         help='do not overwrite files')
532     filesystem.add_option(
533         '-c', '--continue',
534         action='store_true', dest='continue_dl', default=True,
535         help='force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.')
536     filesystem.add_option(
537         '--no-continue',
538         action='store_false', dest='continue_dl',
539         help='do not resume partially downloaded files (restart from beginning)')
540     filesystem.add_option(
541         '--no-part',
542         action='store_true', dest='nopart', default=False,
543         help='do not use .part files - write directly into output file')
544     filesystem.add_option(
545         '--no-mtime',
546         action='store_false', dest='updatetime', default=True,
547         help='do not use the Last-modified header to set the file modification time')
548     filesystem.add_option(
549         '--write-description',
550         action='store_true', dest='writedescription', default=False,
551         help='write video description to a .description file')
552     filesystem.add_option(
553         '--write-info-json',
554         action='store_true', dest='writeinfojson', default=False,
555         help='write video metadata to a .info.json file')
556     filesystem.add_option(
557         '--write-annotations',
558         action='store_true', dest='writeannotations', default=False,
559         help='write video annotations to a .annotation file')
560     filesystem.add_option(
561         '--write-thumbnail',
562         action='store_true', dest='writethumbnail', default=False,
563         help='write thumbnail image to disk')
564     filesystem.add_option(
565         '--load-info',
566         dest='load_info_filename', metavar='FILE',
567         help='json file containing the video information (created with the "--write-json" option)')
568     filesystem.add_option(
569         '--cookies',
570         dest='cookiefile', metavar='FILE',
571         help='file to read cookies from and dump cookie jar in')
572     filesystem.add_option(
573         '--cache-dir', dest='cachedir', default=None, metavar='DIR',
574         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.')
575     filesystem.add_option(
576         '--no-cache-dir', action='store_const', const=False, dest='cachedir',
577         help='Disable filesystem caching')
578     filesystem.add_option(
579         '--rm-cache-dir',
580         action='store_true', dest='rm_cachedir',
581         help='Delete all filesystem cache files')
582
583     postproc = optparse.OptionGroup(parser, 'Post-processing Options')
584     postproc.add_option(
585         '-x', '--extract-audio',
586         action='store_true', dest='extractaudio', default=False,
587         help='convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)')
588     postproc.add_option(
589         '--audio-format', metavar='FORMAT', dest='audioformat', default='best',
590         help='"best", "aac", "vorbis", "mp3", "m4a", "opus", or "wav"; "%default" by default')
591     postproc.add_option(
592         '--audio-quality', metavar='QUALITY',
593         dest='audioquality', default='5',
594         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)')
595     postproc.add_option(
596         '--recode-video',
597         metavar='FORMAT', dest='recodevideo', default=None,
598         help='Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm|mkv)')
599     postproc.add_option(
600         '-k', '--keep-video',
601         action='store_true', dest='keepvideo', default=False,
602         help='keeps the video file on disk after the post-processing; the video is erased by default')
603     postproc.add_option(
604         '--no-post-overwrites',
605         action='store_true', dest='nopostoverwrites', default=False,
606         help='do not overwrite post-processed files; the post-processed files are overwritten by default')
607     postproc.add_option(
608         '--embed-subs',
609         action='store_true', dest='embedsubtitles', default=False,
610         help='embed subtitles in the video (only for mp4 videos)')
611     postproc.add_option(
612         '--embed-thumbnail',
613         action='store_true', dest='embedthumbnail', default=False,
614         help='embed thumbnail in the audio as cover art')
615     postproc.add_option(
616         '--add-metadata',
617         action='store_true', dest='addmetadata', default=False,
618         help='write metadata to the video file')
619     postproc.add_option(
620         '--xattrs',
621         action='store_true', dest='xattrs', default=False,
622         help='write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
623     postproc.add_option(
624         '--prefer-avconv',
625         action='store_false', dest='prefer_ffmpeg',
626         help='Prefer avconv over ffmpeg for running the postprocessors (default)')
627     postproc.add_option(
628         '--prefer-ffmpeg',
629         action='store_true', dest='prefer_ffmpeg',
630         help='Prefer ffmpeg over avconv for running the postprocessors')
631     postproc.add_option(
632         '--exec',
633         metavar='CMD', dest='exec_cmd',
634         help='Execute a command on the file after downloading, similar to find\'s -exec syntax. Example: --exec \'adb push {} /sdcard/Music/ && rm {}\'')
635
636     parser.add_option_group(general)
637     parser.add_option_group(selection)
638     parser.add_option_group(downloader)
639     parser.add_option_group(filesystem)
640     parser.add_option_group(verbosity)
641     parser.add_option_group(workarounds)
642     parser.add_option_group(video_format)
643     parser.add_option_group(subtitles)
644     parser.add_option_group(authentication)
645     parser.add_option_group(postproc)
646
647     if overrideArguments is not None:
648         opts, args = parser.parse_args(overrideArguments)
649         if opts.verbose:
650             write_string('[debug] Override config: ' + repr(overrideArguments) + '\n')
651     else:
652         commandLineConf = sys.argv[1:]
653         if '--ignore-config' in commandLineConf:
654             systemConf = []
655             userConf = []
656         else:
657             systemConf = _readOptions('/etc/youtube-dl.conf')
658             if '--ignore-config' in systemConf:
659                 userConf = []
660             else:
661                 userConf = _readUserConf()
662         argv = systemConf + userConf + commandLineConf
663
664         opts, args = parser.parse_args(argv)
665         if opts.verbose:
666             write_string('[debug] System config: ' + repr(_hide_login_info(systemConf)) + '\n')
667             write_string('[debug] User config: ' + repr(_hide_login_info(userConf)) + '\n')
668             write_string('[debug] Command-line args: ' + repr(_hide_login_info(commandLineConf)) + '\n')
669
670     return parser, opts, args