]> gitweb @ CieloNegro.org - youtube-dl.git/blob - youtube_dl/options.py
[bbc] Fix _VALID_URL
[youtube-dl.git] / youtube_dl / options.py
1 from __future__ import unicode_literals
2
3 import os.path
4 import optparse
5 import sys
6
7 from .downloader.external import list_external_downloaders
8 from .compat import (
9     compat_expanduser,
10     compat_get_terminal_size,
11     compat_getenv,
12     compat_kwargs,
13     compat_shlex_split,
14 )
15 from .utils import (
16     preferredencoding,
17     write_string,
18 )
19 from .version import __version__
20
21
22 def parseOpts(overrideArguments=None):
23     def _readOptions(filename_bytes, default=[]):
24         try:
25             optionf = open(filename_bytes)
26         except IOError:
27             return default  # silently skip if file is not present
28         try:
29             res = []
30             for l in optionf:
31                 res += compat_shlex_split(l, comments=True)
32         finally:
33             optionf.close()
34         return res
35
36     def _readUserConf():
37         xdg_config_home = compat_getenv('XDG_CONFIG_HOME')
38         if 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')
42         else:
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)
47
48         if userConf is None:
49             appdata_dir = compat_getenv('appdata')
50             if appdata_dir:
51                 userConf = _readOptions(
52                     os.path.join(appdata_dir, 'youtube-dl', 'config'),
53                     default=None)
54                 if userConf is None:
55                     userConf = _readOptions(
56                         os.path.join(appdata_dir, 'youtube-dl', 'config.txt'),
57                         default=None)
58
59         if userConf is None:
60             userConf = _readOptions(
61                 os.path.join(compat_expanduser('~'), 'youtube-dl.conf'),
62                 default=None)
63         if userConf is None:
64             userConf = _readOptions(
65                 os.path.join(compat_expanduser('~'), 'youtube-dl.conf.txt'),
66                 default=None)
67
68         if userConf is None:
69             userConf = []
70
71         return userConf
72
73     def _format_option_string(option):
74         ''' ('-o', '--option') -> -o, --format METAVAR'''
75
76         opts = []
77
78         if option._short_opts:
79             opts.append(option._short_opts[0])
80         if option._long_opts:
81             opts.append(option._long_opts[0])
82         if len(opts) > 1:
83             opts.insert(1, ', ')
84
85         if option.takes_value():
86             opts.append(' %s' % option.metavar)
87
88         return "".join(opts)
89
90     def _comma_separated_values_options_callback(option, opt_str, value, parser):
91         setattr(parser.values, option.dest, value.split(','))
92
93     def _hide_login_info(opts):
94         opts = list(opts)
95         for private_opt in ['-p', '--password', '-u', '--username', '--video-password']:
96             try:
97                 i = opts.index(private_opt)
98                 opts[i + 1] = 'PRIVATE'
99             except ValueError:
100                 pass
101         return opts
102
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
107
108     fmt = optparse.IndentedHelpFormatter(width=max_width, max_help_position=max_help_position)
109     fmt.format_option_strings = _format_option_string
110
111     kw = {
112         'version': __version__,
113         'formatter': fmt,
114         'usage': '%prog [OPTIONS] URL [URL...]',
115         'conflict_handler': 'resolve',
116     }
117
118     parser = optparse.OptionParser(**compat_kwargs(kw))
119
120     general = optparse.OptionGroup(parser, 'General Options')
121     general.add_option(
122         '-h', '--help',
123         action='help',
124         help='Print this help text and exit')
125     general.add_option(
126         '-v', '--version',
127         action='version',
128         help='Print program version and exit')
129     general.add_option(
130         '-U', '--update',
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)')
133     general.add_option(
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')
137     general.add_option(
138         '--abort-on-error',
139         action='store_false', dest='ignoreerrors',
140         help='Abort downloading of further videos (in the playlist or the command line) if an error occurs')
141     general.add_option(
142         '--dump-user-agent',
143         action='store_true', dest='dump_user_agent', default=False,
144         help='Display the current browser identification')
145     general.add_option(
146         '--list-extractors',
147         action='store_true', dest='list_extractors', default=False,
148         help='List all supported extractors')
149     general.add_option(
150         '--extractor-descriptions',
151         action='store_true', dest='list_extractor_descriptions', default=False,
152         help='Output descriptions of all supported extractors')
153     general.add_option(
154         '--force-generic-extractor',
155         action='store_true', dest='force_generic_extractor', default=False,
156         help='Force extraction to use the generic extractor')
157     general.add_option(
158         '--default-search',
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.')
161     general.add_option(
162         '--ignore-config',
163         action='store_true',
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)')
168     general.add_option(
169         '--flat-playlist',
170         action='store_const', dest='extract_flat', const='in_playlist',
171         default=False,
172         help='Do not extract the videos of a playlist, only list them.')
173     general.add_option(
174         '--no-color', '--no-colors',
175         action='store_true', dest='no_color',
176         default=False,
177         help='Do not emit color codes in output')
178
179     network = optparse.OptionGroup(parser, 'Network Options')
180     network.add_option(
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')
184     network.add_option(
185         '--socket-timeout',
186         dest='socket_timeout', type=float, default=None, metavar='SECONDS',
187         help='Time to wait before giving up, in seconds')
188     network.add_option(
189         '--source-address',
190         metavar='IP', dest='source_address', default=None,
191         help='Client-side IP address to bind to (experimental)',
192     )
193     network.add_option(
194         '-4', '--force-ipv4',
195         action='store_const', const='0.0.0.0', dest='source_address',
196         help='Make all connections via IPv4 (experimental)',
197     )
198     network.add_option(
199         '-6', '--force-ipv6',
200         action='store_const', const='::', dest='source_address',
201         help='Make all connections via IPv6 (experimental)',
202     )
203     network.add_option(
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)'
208     )
209
210     selection = optparse.OptionGroup(parser, 'Video Selection')
211     selection.add_option(
212         '--playlist-start',
213         dest='playliststart', metavar='NUMBER', default=1, type=int,
214         help='Playlist video to start at (default is %default)')
215     selection.add_option(
216         '--playlist-end',
217         dest='playlistend', metavar='NUMBER', default=None, type=int,
218         help='Playlist video to end at (default is last)')
219     selection.add_option(
220         '--playlist-items',
221         dest='playlist_items', metavar='ITEM_SPEC', default=None,
222         help='Playlist video items to download. Specify indices of the videos in the playlist separated by commas like: "--playlist-items 1,2,5,8" if you want to download videos indexed 1, 2, 5, 8 in the playlist. You can specify range: "--playlist-items 1-3,7,10-13", it will download the videos at index 1, 2, 3, 7, 10, 11, 12 and 13.')
223     selection.add_option(
224         '--match-title',
225         dest='matchtitle', metavar='REGEX',
226         help='Download only matching titles (regex or caseless sub-string)')
227     selection.add_option(
228         '--reject-title',
229         dest='rejecttitle', metavar='REGEX',
230         help='Skip download for matching titles (regex or caseless sub-string)')
231     selection.add_option(
232         '--max-downloads',
233         dest='max_downloads', metavar='NUMBER', type=int, default=None,
234         help='Abort after downloading NUMBER files')
235     selection.add_option(
236         '--min-filesize',
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(
240         '--max-filesize',
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(
244         '--date',
245         metavar='DATE', dest='date', default=None,
246         help='Download only videos uploaded in this date')
247     selection.add_option(
248         '--datebefore',
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(
252         '--dateafter',
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(
256         '--min-views',
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(
260         '--max-views',
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(
264         '--match-filter',
265         metavar='FILTER', dest='match_filter', default=None,
266         help=(
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" .'
281         ))
282     selection.add_option(
283         '--no-playlist',
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(
287         '--yes-playlist',
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(
291         '--age-limit',
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(
299         '--include-ads',
300         dest='include_ads', action='store_true',
301         help='Download advertisements as well (experimental)')
302
303     authentication = optparse.OptionGroup(parser, 'Authentication Options')
304     authentication.add_option(
305         '-u', '--username',
306         dest='username', metavar='USERNAME',
307         help='Login with this account ID')
308     authentication.add_option(
309         '-p', '--password',
310         dest='password', metavar='PASSWORD',
311         help='Account password. If this option is left out, youtube-dl will ask interactively.')
312     authentication.add_option(
313         '-2', '--twofactor',
314         dest='twofactor', metavar='TWOFACTOR',
315         help='Two-factor auth code')
316     authentication.add_option(
317         '-n', '--netrc',
318         action='store_true', dest='usenetrc', default=False,
319         help='Use .netrc authentication data')
320     authentication.add_option(
321         '--video-password',
322         dest='videopassword', metavar='PASSWORD',
323         help='Video password (vimeo, smotri, youku)')
324
325     video_format = optparse.OptionGroup(parser, 'Video Format Options')
326     video_format.add_option(
327         '-f', '--format',
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(
331         '--all-formats',
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 of requested videos')
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 manifests and related data on YouTube videos')
350     video_format.add_option(
351         '--merge-output-format',
352         action='store', dest='merge_output_format', metavar='FORMAT', default=None,
353         help=(
354             'If a merge is required (e.g. bestvideo+bestaudio), '
355             'output to given container format. One of mkv, mp4, ogg, webm, flv. '
356             'Ignored if no merge is required'))
357
358     subtitles = optparse.OptionGroup(parser, 'Subtitle Options')
359     subtitles.add_option(
360         '--write-sub', '--write-srt',
361         action='store_true', dest='writesubtitles', default=False,
362         help='Write subtitle file')
363     subtitles.add_option(
364         '--write-auto-sub', '--write-automatic-sub',
365         action='store_true', dest='writeautomaticsub', default=False,
366         help='Write automatically generated subtitle file (YouTube only)')
367     subtitles.add_option(
368         '--all-subs',
369         action='store_true', dest='allsubtitles', default=False,
370         help='Download all the available subtitles of the video')
371     subtitles.add_option(
372         '--list-subs',
373         action='store_true', dest='listsubtitles', default=False,
374         help='List all available subtitles for the video')
375     subtitles.add_option(
376         '--sub-format',
377         action='store', dest='subtitlesformat', metavar='FORMAT', default='best',
378         help='Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"')
379     subtitles.add_option(
380         '--sub-lang', '--sub-langs', '--srt-lang',
381         action='callback', dest='subtitleslangs', metavar='LANGS', type='str',
382         default=[], callback=_comma_separated_values_options_callback,
383         help='Languages of the subtitles to download (optional) separated by commas, use IETF language tags like \'en,pt\'')
384
385     downloader = optparse.OptionGroup(parser, 'Download Options')
386     downloader.add_option(
387         '-r', '--rate-limit',
388         dest='ratelimit', metavar='LIMIT',
389         help='Maximum download rate in bytes per second (e.g. 50K or 4.2M)')
390     downloader.add_option(
391         '-R', '--retries',
392         dest='retries', metavar='RETRIES', default=10,
393         help='Number of retries (default is %default), or "infinite".')
394     downloader.add_option(
395         '--buffer-size',
396         dest='buffersize', metavar='SIZE', default='1024',
397         help='Size of download buffer (e.g. 1024 or 16K) (default is %default)')
398     downloader.add_option(
399         '--no-resize-buffer',
400         action='store_true', dest='noresizebuffer', default=False,
401         help='Do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.')
402     downloader.add_option(
403         '--test',
404         action='store_true', dest='test', default=False,
405         help=optparse.SUPPRESS_HELP)
406     downloader.add_option(
407         '--playlist-reverse',
408         action='store_true',
409         help='Download playlist videos in reverse order')
410     downloader.add_option(
411         '--xattr-set-filesize',
412         dest='xattr_set_filesize', action='store_true',
413         help='Set file xattribute ytdl.filesize with expected filesize (experimental)')
414     downloader.add_option(
415         '--hls-prefer-native',
416         dest='hls_prefer_native', action='store_true',
417         help='Use the native HLS downloader instead of ffmpeg (experimental)')
418     downloader.add_option(
419         '--external-downloader',
420         dest='external_downloader', metavar='COMMAND',
421         help='Use the specified external downloader. '
422              'Currently supports %s' % ','.join(list_external_downloaders()))
423     downloader.add_option(
424         '--external-downloader-args',
425         dest='external_downloader_args', metavar='ARGS',
426         help='Give these arguments to the external downloader')
427
428     workarounds = optparse.OptionGroup(parser, 'Workarounds')
429     workarounds.add_option(
430         '--encoding',
431         dest='encoding', metavar='ENCODING',
432         help='Force the specified encoding (experimental)')
433     workarounds.add_option(
434         '--no-check-certificate',
435         action='store_true', dest='no_check_certificate', default=False,
436         help='Suppress HTTPS certificate validation')
437     workarounds.add_option(
438         '--prefer-insecure',
439         '--prefer-unsecure', action='store_true', dest='prefer_insecure',
440         help='Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)')
441     workarounds.add_option(
442         '--user-agent',
443         metavar='UA', dest='user_agent',
444         help='Specify a custom user agent')
445     workarounds.add_option(
446         '--referer',
447         metavar='URL', dest='referer', default=None,
448         help='Specify a custom referer, use if the video access is restricted to one domain',
449     )
450     workarounds.add_option(
451         '--add-header',
452         metavar='FIELD:VALUE', dest='headers', action='append',
453         help='Specify a custom HTTP header and its value, separated by a colon \':\'. You can use this option multiple times',
454     )
455     workarounds.add_option(
456         '--bidi-workaround',
457         dest='bidi_workaround', action='store_true',
458         help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
459     workarounds.add_option(
460         '--sleep-interval', metavar='SECONDS',
461         dest='sleep_interval', type=float,
462         help='Number of seconds to sleep before each download.')
463
464     verbosity = optparse.OptionGroup(parser, 'Verbosity / Simulation Options')
465     verbosity.add_option(
466         '-q', '--quiet',
467         action='store_true', dest='quiet', default=False,
468         help='Activate quiet mode')
469     verbosity.add_option(
470         '--no-warnings',
471         dest='no_warnings', action='store_true', default=False,
472         help='Ignore warnings')
473     verbosity.add_option(
474         '-s', '--simulate',
475         action='store_true', dest='simulate', default=False,
476         help='Do not download the video and do not write anything to disk')
477     verbosity.add_option(
478         '--skip-download',
479         action='store_true', dest='skip_download', default=False,
480         help='Do not download the video')
481     verbosity.add_option(
482         '-g', '--get-url',
483         action='store_true', dest='geturl', default=False,
484         help='Simulate, quiet but print URL')
485     verbosity.add_option(
486         '-e', '--get-title',
487         action='store_true', dest='gettitle', default=False,
488         help='Simulate, quiet but print title')
489     verbosity.add_option(
490         '--get-id',
491         action='store_true', dest='getid', default=False,
492         help='Simulate, quiet but print id')
493     verbosity.add_option(
494         '--get-thumbnail',
495         action='store_true', dest='getthumbnail', default=False,
496         help='Simulate, quiet but print thumbnail URL')
497     verbosity.add_option(
498         '--get-description',
499         action='store_true', dest='getdescription', default=False,
500         help='Simulate, quiet but print video description')
501     verbosity.add_option(
502         '--get-duration',
503         action='store_true', dest='getduration', default=False,
504         help='Simulate, quiet but print video length')
505     verbosity.add_option(
506         '--get-filename',
507         action='store_true', dest='getfilename', default=False,
508         help='Simulate, quiet but print output filename')
509     verbosity.add_option(
510         '--get-format',
511         action='store_true', dest='getformat', default=False,
512         help='Simulate, quiet but print output format')
513     verbosity.add_option(
514         '-j', '--dump-json',
515         action='store_true', dest='dumpjson', default=False,
516         help='Simulate, quiet but print JSON information. See --output for a description of available keys.')
517     verbosity.add_option(
518         '-J', '--dump-single-json',
519         action='store_true', dest='dump_single_json', default=False,
520         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.')
521     verbosity.add_option(
522         '--print-json',
523         action='store_true', dest='print_json', default=False,
524         help='Be quiet and print the video information as JSON (video is still being downloaded).',
525     )
526     verbosity.add_option(
527         '--newline',
528         action='store_true', dest='progress_with_newline', default=False,
529         help='Output progress bar as new lines')
530     verbosity.add_option(
531         '--no-progress',
532         action='store_true', dest='noprogress', default=False,
533         help='Do not print progress bar')
534     verbosity.add_option(
535         '--console-title',
536         action='store_true', dest='consoletitle', default=False,
537         help='Display progress in console titlebar')
538     verbosity.add_option(
539         '-v', '--verbose',
540         action='store_true', dest='verbose', default=False,
541         help='Print various debugging information')
542     verbosity.add_option(
543         '--dump-pages', '--dump-intermediate-pages',
544         action='store_true', dest='dump_intermediate_pages', default=False,
545         help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
546     verbosity.add_option(
547         '--write-pages',
548         action='store_true', dest='write_pages', default=False,
549         help='Write downloaded intermediary pages to files in the current directory to debug problems')
550     verbosity.add_option(
551         '--youtube-print-sig-code',
552         action='store_true', dest='youtube_print_sig_code', default=False,
553         help=optparse.SUPPRESS_HELP)
554     verbosity.add_option(
555         '--print-traffic', '--dump-headers',
556         dest='debug_printtraffic', action='store_true', default=False,
557         help='Display sent and read HTTP traffic')
558     verbosity.add_option(
559         '-C', '--call-home',
560         dest='call_home', action='store_true', default=False,
561         help='Contact the youtube-dl server for debugging')
562     verbosity.add_option(
563         '--no-call-home',
564         dest='call_home', action='store_false', default=False,
565         help='Do NOT contact the youtube-dl server for debugging')
566
567     filesystem = optparse.OptionGroup(parser, 'Filesystem Options')
568     filesystem.add_option(
569         '-a', '--batch-file',
570         dest='batchfile', metavar='FILE',
571         help='File containing URLs to download (\'-\' for stdin)')
572     filesystem.add_option(
573         '--id', default=False,
574         action='store_true', dest='useid', help='Use only video ID in file name')
575     filesystem.add_option(
576         '-o', '--output',
577         dest='outtmpl', metavar='TEMPLATE',
578         help=('Output filename template. Use %(title)s to get the title, '
579               '%(uploader)s for the uploader name, %(uploader_id)s for the uploader nickname if different, '
580               '%(autonumber)s to get an automatically incremented number, '
581               '%(ext)s for the filename extension, '
582               '%(format)s for the format description (like "22 - 1280x720" or "HD"), '
583               '%(format_id)s for the unique id of the format (like YouTube\'s itags: "137"), '
584               '%(upload_date)s for the upload date (YYYYMMDD), '
585               '%(extractor)s for the provider (youtube, metacafe, etc), '
586               '%(id)s for the video id, '
587               '%(playlist_title)s, %(playlist_id)s, or %(playlist)s (=title if present, ID otherwise) for the playlist the video is in, '
588               '%(playlist_index)s for the position in the playlist. '
589               '%(height)s and %(width)s for the width and height of the video format. '
590               '%(resolution)s for a textual description of the resolution of the video format. '
591               '%% for a literal percent. '
592               'Use - to output to stdout. Can also be used to download to a different directory, '
593               'for example with -o \'/my/downloads/%(uploader)s/%(title)s-%(id)s.%(ext)s\' .'))
594     filesystem.add_option(
595         '--autonumber-size',
596         dest='autonumber_size', metavar='NUMBER',
597         help='Specify the number of digits in %(autonumber)s when it is present in output filename template or --auto-number option is given')
598     filesystem.add_option(
599         '--restrict-filenames',
600         action='store_true', dest='restrictfilenames', default=False,
601         help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
602     filesystem.add_option(
603         '-A', '--auto-number',
604         action='store_true', dest='autonumber', default=False,
605         help='[deprecated; use -o "%(autonumber)s-%(title)s.%(ext)s" ] Number downloaded files starting from 00000')
606     filesystem.add_option(
607         '-t', '--title',
608         action='store_true', dest='usetitle', default=False,
609         help='[deprecated] Use title in file name (default)')
610     filesystem.add_option(
611         '-l', '--literal', default=False,
612         action='store_true', dest='usetitle',
613         help='[deprecated] Alias of --title')
614     filesystem.add_option(
615         '-w', '--no-overwrites',
616         action='store_true', dest='nooverwrites', default=False,
617         help='Do not overwrite files')
618     filesystem.add_option(
619         '-c', '--continue',
620         action='store_true', dest='continue_dl', default=True,
621         help='Force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.')
622     filesystem.add_option(
623         '--no-continue',
624         action='store_false', dest='continue_dl',
625         help='Do not resume partially downloaded files (restart from beginning)')
626     filesystem.add_option(
627         '--no-part',
628         action='store_true', dest='nopart', default=False,
629         help='Do not use .part files - write directly into output file')
630     filesystem.add_option(
631         '--no-mtime',
632         action='store_false', dest='updatetime', default=True,
633         help='Do not use the Last-modified header to set the file modification time')
634     filesystem.add_option(
635         '--write-description',
636         action='store_true', dest='writedescription', default=False,
637         help='Write video description to a .description file')
638     filesystem.add_option(
639         '--write-info-json',
640         action='store_true', dest='writeinfojson', default=False,
641         help='Write video metadata to a .info.json file')
642     filesystem.add_option(
643         '--write-annotations',
644         action='store_true', dest='writeannotations', default=False,
645         help='Write video annotations to a .annotations.xml file')
646     filesystem.add_option(
647         '--load-info',
648         dest='load_info_filename', metavar='FILE',
649         help='JSON file containing the video information (created with the "--write-info-json" option)')
650     filesystem.add_option(
651         '--cookies',
652         dest='cookiefile', metavar='FILE',
653         help='File to read cookies from and dump cookie jar in')
654     filesystem.add_option(
655         '--cache-dir', dest='cachedir', default=None, metavar='DIR',
656         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.')
657     filesystem.add_option(
658         '--no-cache-dir', action='store_const', const=False, dest='cachedir',
659         help='Disable filesystem caching')
660     filesystem.add_option(
661         '--rm-cache-dir',
662         action='store_true', dest='rm_cachedir',
663         help='Delete all filesystem cache files')
664
665     thumbnail = optparse.OptionGroup(parser, 'Thumbnail images')
666     thumbnail.add_option(
667         '--write-thumbnail',
668         action='store_true', dest='writethumbnail', default=False,
669         help='Write thumbnail image to disk')
670     thumbnail.add_option(
671         '--write-all-thumbnails',
672         action='store_true', dest='write_all_thumbnails', default=False,
673         help='Write all thumbnail image formats to disk')
674     thumbnail.add_option(
675         '--list-thumbnails',
676         action='store_true', dest='list_thumbnails', default=False,
677         help='Simulate and list all available thumbnail formats')
678
679     postproc = optparse.OptionGroup(parser, 'Post-processing Options')
680     postproc.add_option(
681         '-x', '--extract-audio',
682         action='store_true', dest='extractaudio', default=False,
683         help='Convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)')
684     postproc.add_option(
685         '--audio-format', metavar='FORMAT', dest='audioformat', default='best',
686         help='Specify audio format: "best", "aac", "vorbis", "mp3", "m4a", "opus", or "wav"; "%default" by default')
687     postproc.add_option(
688         '--audio-quality', metavar='QUALITY',
689         dest='audioquality', default='5',
690         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)')
691     postproc.add_option(
692         '--recode-video',
693         metavar='FORMAT', dest='recodevideo', default=None,
694         help='Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm|mkv|avi)')
695     postproc.add_option(
696         '--postprocessor-args',
697         dest='postprocessor_args', metavar='ARGS',
698         help='Give these arguments to the postprocessor')
699     postproc.add_option(
700         '-k', '--keep-video',
701         action='store_true', dest='keepvideo', default=False,
702         help='Keep the video file on disk after the post-processing; the video is erased by default')
703     postproc.add_option(
704         '--no-post-overwrites',
705         action='store_true', dest='nopostoverwrites', default=False,
706         help='Do not overwrite post-processed files; the post-processed files are overwritten by default')
707     postproc.add_option(
708         '--embed-subs',
709         action='store_true', dest='embedsubtitles', default=False,
710         help='Embed subtitles in the video (only for mkv and mp4 videos)')
711     postproc.add_option(
712         '--embed-thumbnail',
713         action='store_true', dest='embedthumbnail', default=False,
714         help='Embed thumbnail in the audio as cover art')
715     postproc.add_option(
716         '--add-metadata',
717         action='store_true', dest='addmetadata', default=False,
718         help='Write metadata to the video file')
719     postproc.add_option(
720         '--metadata-from-title',
721         metavar='FORMAT', dest='metafromtitle',
722         help='Parse additional metadata like song title / artist from the video title. '
723              'The format syntax is the same as --output, '
724              'the parsed parameters replace existing values. '
725              'Additional templates: %(album)s, %(artist)s. '
726              'Example: --metadata-from-title "%(artist)s - %(title)s" matches a title like '
727              '"Coldplay - Paradise"')
728     postproc.add_option(
729         '--xattrs',
730         action='store_true', dest='xattrs', default=False,
731         help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
732     postproc.add_option(
733         '--fixup',
734         metavar='POLICY', dest='fixup', default='detect_or_warn',
735         help='Automatically correct known faults of the file. '
736              'One of never (do nothing), warn (only emit a warning), '
737              'detect_or_warn (the default; fix file if we can, warn otherwise)')
738     postproc.add_option(
739         '--prefer-avconv',
740         action='store_false', dest='prefer_ffmpeg',
741         help='Prefer avconv over ffmpeg for running the postprocessors (default)')
742     postproc.add_option(
743         '--prefer-ffmpeg',
744         action='store_true', dest='prefer_ffmpeg',
745         help='Prefer ffmpeg over avconv for running the postprocessors')
746     postproc.add_option(
747         '--ffmpeg-location', '--avconv-location', metavar='PATH',
748         dest='ffmpeg_location',
749         help='Location of the ffmpeg/avconv binary; either the path to the binary or its containing directory.')
750     postproc.add_option(
751         '--exec',
752         metavar='CMD', dest='exec_cmd',
753         help='Execute a command on the file after downloading, similar to find\'s -exec syntax. Example: --exec \'adb push {} /sdcard/Music/ && rm {}\'')
754     postproc.add_option(
755         '--convert-subtitles', '--convert-subs',
756         metavar='FORMAT', dest='convertsubtitles', default=None,
757         help='Convert the subtitles to other format (currently supported: srt|ass|vtt)')
758
759     parser.add_option_group(general)
760     parser.add_option_group(network)
761     parser.add_option_group(selection)
762     parser.add_option_group(downloader)
763     parser.add_option_group(filesystem)
764     parser.add_option_group(thumbnail)
765     parser.add_option_group(verbosity)
766     parser.add_option_group(workarounds)
767     parser.add_option_group(video_format)
768     parser.add_option_group(subtitles)
769     parser.add_option_group(authentication)
770     parser.add_option_group(postproc)
771
772     if overrideArguments is not None:
773         opts, args = parser.parse_args(overrideArguments)
774         if opts.verbose:
775             write_string('[debug] Override config: ' + repr(overrideArguments) + '\n')
776     else:
777         def compat_conf(conf):
778             if sys.version_info < (3,):
779                 return [a.decode(preferredencoding(), 'replace') for a in conf]
780             return conf
781
782         command_line_conf = compat_conf(sys.argv[1:])
783
784         if '--ignore-config' in command_line_conf:
785             system_conf = []
786             user_conf = []
787         else:
788             system_conf = compat_conf(_readOptions('/etc/youtube-dl.conf'))
789             if '--ignore-config' in system_conf:
790                 user_conf = []
791             else:
792                 user_conf = compat_conf(_readUserConf())
793         argv = system_conf + user_conf + command_line_conf
794
795         opts, args = parser.parse_args(argv)
796         if opts.verbose:
797             write_string('[debug] System config: ' + repr(_hide_login_info(system_conf)) + '\n')
798             write_string('[debug] User config: ' + repr(_hide_login_info(user_conf)) + '\n')
799             write_string('[debug] Command-line args: ' + repr(_hide_login_info(command_line_conf)) + '\n')
800
801     return parser, opts, args