]> jfr.im git - yt-dlp.git/blame - youtube_dl/options.py
release 2015.01.09
[yt-dlp.git] / youtube_dl / options.py
CommitLineData
2daabe49
PH
1from __future__ import unicode_literals
2
34a741a8
PH
3import os.path
4import optparse
5import shlex
6import sys
7
8c25f81b 8from .compat import (
4644ac55
S
9 compat_expanduser,
10 compat_getenv,
c7b0add8 11 compat_kwargs,
8c25f81b
PH
12)
13from .utils import (
34a741a8
PH
14 get_term_width,
15 write_string,
16)
17from .version import __version__
18
19
20def 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():
4644ac55 35 xdg_config_home = compat_getenv('XDG_CONFIG_HOME')
34a741a8
PH
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:
4644ac55 41 userConfFile = os.path.join(compat_expanduser('~'), '.config', 'youtube-dl', 'config')
34a741a8 42 if not os.path.isfile(userConfFile):
4644ac55 43 userConfFile = os.path.join(compat_expanduser('~'), '.config', 'youtube-dl.conf')
34a741a8
PH
44 userConf = _readOptions(userConfFile, None)
45
46 if userConf is None:
4644ac55 47 appdata_dir = compat_getenv('appdata')
34a741a8
PH
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(
4644ac55 59 os.path.join(compat_expanduser('~'), 'youtube-dl.conf'),
34a741a8
PH
60 default=None)
61 if userConf is None:
62 userConf = _readOptions(
4644ac55 63 os.path.join(compat_expanduser('~'), 'youtube-dl.conf.txt'),
34a741a8
PH
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
8450c15c
PH
83 if option.takes_value():
84 opts.append(' %s' % option.metavar)
34a741a8
PH
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)
8450c15c 96 opts[i + 1] = 'PRIVATE'
34a741a8
PH
97 except ValueError:
98 pass
99 return opts
100
34a741a8
PH
101 # No need to wrap help messages if we're on a wide console
102 columns = get_term_width()
8450c15c
PH
103 max_width = columns if columns else 80
104 max_help_position = 80
34a741a8
PH
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 = {
8450c15c
PH
110 'version': __version__,
111 'formatter': fmt,
a42419da 112 'usage': '%prog [OPTIONS] URL [URL...]',
8450c15c 113 'conflict_handler': 'resolve',
34a741a8
PH
114 }
115
c7b0add8 116 parser = optparse.OptionParser(**compat_kwargs(kw))
34a741a8 117
8450c15c
PH
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')
34a741a8 143 general.add_option(
8450c15c
PH
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',
34a741a8
PH
154 help='Use the specified HTTP/HTTPS proxy. Pass in an empty string (--proxy "") for direct connection')
155 general.add_option(
8450c15c
PH
156 '--socket-timeout',
157 dest='socket_timeout', type=float, default=None,
158 help='Time to wait before giving up, in seconds')
34a741a8
PH
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',
d4e06d4a
PH
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)')
057a5206
PH
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.')
34a741a8 175
8450c15c 176 selection = optparse.OptionGroup(parser, 'Video Selection')
34a741a8
PH
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)')
34a741a8 185 selection.add_option(
8450c15c
PH
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,
34a741a8
PH
212 help='download only videos uploaded on or before this date (i.e. inclusive)')
213 selection.add_option(
8450c15c
PH
214 '--dateafter',
215 metavar='DATE', dest='dateafter', default=None,
34a741a8
PH
216 help='download only videos uploaded on or after this date (i.e. inclusive)')
217 selection.add_option(
8450c15c
PH
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',)
34a741a8 221 selection.add_option(
8450c15c
PH
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')
34a741a8 225 selection.add_option(
8450c15c
PH
226 '--no-playlist',
227 action='store_true', dest='noplaylist', default=False,
acda92f6 228 help='If the URL refers to a video and a playlist, download only the video.')
8450c15c
PH
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',
34a741a8 240 help='Download advertisements as well (experimental)')
34a741a8 241
8450c15c
PH
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,
b74e86f4
PH
268 help=(
269 'video format code, specify the order of preference using'
0217c783
PH
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.'
c2b61af5
JMF
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'
b74e86f4 280 ' avconv), for example -f bestvideo+bestaudio.'))
8450c15c
PH
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')
203fb43f
PH
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')
8450c15c
PH
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)
ff815fe6
MS
354 downloader.add_option(
355 '--playlist-reverse',
356 action='store_true',
357 help='Download playlist videos in reverse order')
8450c15c
PH
358
359 workarounds = optparse.OptionGroup(parser, 'Workarounds')
34a741a8 360 workarounds.add_option(
8450c15c
PH
361 '--encoding',
362 dest='encoding', metavar='ENCODING',
34a741a8
PH
363 help='Force the specified encoding (experimental)')
364 workarounds.add_option(
8450c15c
PH
365 '--no-check-certificate',
366 action='store_true', dest='no_check_certificate', default=False,
34a741a8
PH
367 help='Suppress HTTPS certificate validation.')
368 workarounds.add_option(
8450c15c
PH
369 '--prefer-insecure',
370 '--prefer-unsecure', action='store_true', dest='prefer_insecure',
34a741a8
PH
371 help='Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)')
372 workarounds.add_option(
8450c15c
PH
373 '--user-agent',
374 metavar='UA', dest='user_agent',
375 help='specify a custom user agent')
34a741a8 376 workarounds.add_option(
8450c15c
PH
377 '--referer',
378 metavar='URL', dest='referer', default=None,
34a741a8
PH
379 help='specify a custom referer, use if the video access is restricted to one domain',
380 )
381 workarounds.add_option(
8450c15c
PH
382 '--add-header',
383 metavar='FIELD:VALUE', dest='headers', action='append',
34a741a8
PH
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(
8450c15c
PH
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')
34a741a8 390
8450c15c
PH
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')
34a741a8
PH
396 verbosity.add_option(
397 '--no-warnings',
398 dest='no_warnings', action='store_true', default=False,
399 help='Ignore warnings')
8450c15c
PH
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.')
63e0be34
PH
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.')
c0bdf32a
PH
448 verbosity.add_option(
449 '--print-json',
450 action='store_true', dest='print_json', default=False,
451 help='Be quiet and print the video information as JSON (video is still being downloaded).',
452 )
8450c15c
PH
453 verbosity.add_option(
454 '--newline',
455 action='store_true', dest='progress_with_newline', default=False,
456 help='output progress bar as new lines')
457 verbosity.add_option(
458 '--no-progress',
459 action='store_true', dest='noprogress', default=False,
460 help='do not print progress bar')
461 verbosity.add_option(
462 '--console-title',
463 action='store_true', dest='consoletitle', default=False,
464 help='display progress in console titlebar')
465 verbosity.add_option(
466 '-v', '--verbose',
467 action='store_true', dest='verbose', default=False,
468 help='print various debugging information')
469 verbosity.add_option(
470 '--dump-intermediate-pages',
471 action='store_true', dest='dump_intermediate_pages', default=False,
472 help='print downloaded pages to debug problems (very verbose)')
473 verbosity.add_option(
474 '--write-pages',
475 action='store_true', dest='write_pages', default=False,
476 help='Write downloaded intermediary pages to files in the current directory to debug problems')
477 verbosity.add_option(
478 '--youtube-print-sig-code',
479 action='store_true', dest='youtube_print_sig_code', default=False,
480 help=optparse.SUPPRESS_HELP)
481 verbosity.add_option(
482 '--print-traffic',
483 dest='debug_printtraffic', action='store_true', default=False,
484 help='Display sent and read HTTP traffic')
485
486 filesystem = optparse.OptionGroup(parser, 'Filesystem Options')
487 filesystem.add_option(
488 '-a', '--batch-file',
489 dest='batchfile', metavar='FILE',
490 help='file containing URLs to download (\'-\' for stdin)')
491 filesystem.add_option(
492 '--id', default=False,
493 action='store_true', dest='useid', help='use only video ID in file name')
8450c15c
PH
494 filesystem.add_option(
495 '-o', '--output',
496 dest='outtmpl', metavar='TEMPLATE',
497 help=('output filename template. Use %(title)s to get the title, '
498 '%(uploader)s for the uploader name, %(uploader_id)s for the uploader nickname if different, '
499 '%(autonumber)s to get an automatically incremented number, '
500 '%(ext)s for the filename extension, '
501 '%(format)s for the format description (like "22 - 1280x720" or "HD"), '
502 '%(format_id)s for the unique id of the format (like Youtube\'s itags: "137"), '
503 '%(upload_date)s for the upload date (YYYYMMDD), '
504 '%(extractor)s for the provider (youtube, metacafe, etc), '
a1cf99d0
PH
505 '%(id)s for the video id, '
506 '%(playlist_title)s, %(playlist_id)s, or %(playlist)s (=title if present, ID otherwise) for the playlist the video is in, '
507 '%(playlist_index)s for the position in the playlist. '
8450c15c
PH
508 '%(height)s and %(width)s for the width and height of the video format. '
509 '%(resolution)s for a textual description of the resolution of the video format. '
a1cf99d0 510 '%% for a literal percent. '
8450c15c
PH
511 'Use - to output to stdout. Can also be used to download to a different directory, '
512 'for example with -o \'/my/downloads/%(uploader)s/%(title)s-%(id)s.%(ext)s\' .'))
513 filesystem.add_option(
514 '--autonumber-size',
515 dest='autonumber_size', metavar='NUMBER',
516 help='Specifies the number of digits in %(autonumber)s when it is present in output filename template or --auto-number option is given')
517 filesystem.add_option(
518 '--restrict-filenames',
519 action='store_true', dest='restrictfilenames', default=False,
520 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
2865cf04
PH
521 filesystem.add_option(
522 '-A', '--auto-number',
523 action='store_true', dest='autonumber', default=False,
524 help='[deprecated; use -o "%(autonumber)s-%(title)s.%(ext)s" ] number downloaded files starting from 00000')
8450c15c
PH
525 filesystem.add_option(
526 '-t', '--title',
527 action='store_true', dest='usetitle', default=False,
528 help='[deprecated] use title in file name (default)')
529 filesystem.add_option(
530 '-l', '--literal', default=False,
531 action='store_true', dest='usetitle',
532 help='[deprecated] alias of --title')
533 filesystem.add_option(
534 '-w', '--no-overwrites',
535 action='store_true', dest='nooverwrites', default=False,
536 help='do not overwrite files')
537 filesystem.add_option(
538 '-c', '--continue',
539 action='store_true', dest='continue_dl', default=True,
540 help='force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.')
541 filesystem.add_option(
542 '--no-continue',
543 action='store_false', dest='continue_dl',
544 help='do not resume partially downloaded files (restart from beginning)')
545 filesystem.add_option(
546 '--no-part',
547 action='store_true', dest='nopart', default=False,
548 help='do not use .part files - write directly into output file')
549 filesystem.add_option(
550 '--no-mtime',
551 action='store_false', dest='updatetime', default=True,
552 help='do not use the Last-modified header to set the file modification time')
553 filesystem.add_option(
554 '--write-description',
555 action='store_true', dest='writedescription', default=False,
556 help='write video description to a .description file')
557 filesystem.add_option(
558 '--write-info-json',
559 action='store_true', dest='writeinfojson', default=False,
560 help='write video metadata to a .info.json file')
561 filesystem.add_option(
562 '--write-annotations',
563 action='store_true', dest='writeannotations', default=False,
564 help='write video annotations to a .annotation file')
565 filesystem.add_option(
566 '--write-thumbnail',
567 action='store_true', dest='writethumbnail', default=False,
568 help='write thumbnail image to disk')
569 filesystem.add_option(
570 '--load-info',
571 dest='load_info_filename', metavar='FILE',
572 help='json file containing the video information (created with the "--write-json" option)')
573 filesystem.add_option(
574 '--cookies',
575 dest='cookiefile', metavar='FILE',
576 help='file to read cookies from and dump cookie jar in')
34a741a8
PH
577 filesystem.add_option(
578 '--cache-dir', dest='cachedir', default=None, metavar='DIR',
579 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.')
580 filesystem.add_option(
581 '--no-cache-dir', action='store_const', const=False, dest='cachedir',
582 help='Disable filesystem caching')
583 filesystem.add_option(
8450c15c
PH
584 '--rm-cache-dir',
585 action='store_true', dest='rm_cachedir',
34a741a8
PH
586 help='Delete all filesystem cache files')
587
8450c15c
PH
588 postproc = optparse.OptionGroup(parser, 'Post-processing Options')
589 postproc.add_option(
590 '-x', '--extract-audio',
591 action='store_true', dest='extractaudio', default=False,
592 help='convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)')
593 postproc.add_option(
594 '--audio-format', metavar='FORMAT', dest='audioformat', default='best',
595 help='"best", "aac", "vorbis", "mp3", "m4a", "opus", or "wav"; "%default" by default')
596 postproc.add_option(
597 '--audio-quality', metavar='QUALITY',
598 dest='audioquality', default='5',
599 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)')
600 postproc.add_option(
601 '--recode-video',
602 metavar='FORMAT', dest='recodevideo', default=None,
603 help='Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm|mkv)')
604 postproc.add_option(
605 '-k', '--keep-video',
606 action='store_true', dest='keepvideo', default=False,
607 help='keeps the video file on disk after the post-processing; the video is erased by default')
608 postproc.add_option(
609 '--no-post-overwrites',
610 action='store_true', dest='nopostoverwrites', default=False,
611 help='do not overwrite post-processed files; the post-processed files are overwritten by default')
612 postproc.add_option(
613 '--embed-subs',
614 action='store_true', dest='embedsubtitles', default=False,
615 help='embed subtitles in the video (only for mp4 videos)')
616 postproc.add_option(
617 '--embed-thumbnail',
618 action='store_true', dest='embedthumbnail', default=False,
619 help='embed thumbnail in the audio as cover art')
620 postproc.add_option(
621 '--add-metadata',
622 action='store_true', dest='addmetadata', default=False,
623 help='write metadata to the video file')
624 postproc.add_option(
625 '--xattrs',
626 action='store_true', dest='xattrs', default=False,
627 help='write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
628 postproc.add_option(
629 '--prefer-avconv',
630 action='store_false', dest='prefer_ffmpeg',
34a741a8 631 help='Prefer avconv over ffmpeg for running the postprocessors (default)')
8450c15c
PH
632 postproc.add_option(
633 '--prefer-ffmpeg',
634 action='store_true', dest='prefer_ffmpeg',
34a741a8
PH
635 help='Prefer ffmpeg over avconv for running the postprocessors')
636 postproc.add_option(
8450c15c
PH
637 '--exec',
638 metavar='CMD', dest='exec_cmd',
5f6a1245 639 help='Execute a command on the file after downloading, similar to find\'s -exec syntax. Example: --exec \'adb push {} /sdcard/Music/ && rm {}\'')
34a741a8
PH
640
641 parser.add_option_group(general)
642 parser.add_option_group(selection)
643 parser.add_option_group(downloader)
644 parser.add_option_group(filesystem)
645 parser.add_option_group(verbosity)
646 parser.add_option_group(workarounds)
647 parser.add_option_group(video_format)
648 parser.add_option_group(subtitles)
649 parser.add_option_group(authentication)
650 parser.add_option_group(postproc)
651
652 if overrideArguments is not None:
653 opts, args = parser.parse_args(overrideArguments)
654 if opts.verbose:
8450c15c 655 write_string('[debug] Override config: ' + repr(overrideArguments) + '\n')
34a741a8
PH
656 else:
657 commandLineConf = sys.argv[1:]
658 if '--ignore-config' in commandLineConf:
659 systemConf = []
660 userConf = []
661 else:
662 systemConf = _readOptions('/etc/youtube-dl.conf')
663 if '--ignore-config' in systemConf:
664 userConf = []
665 else:
666 userConf = _readUserConf()
667 argv = systemConf + userConf + commandLineConf
668
669 opts, args = parser.parse_args(argv)
670 if opts.verbose:
8450c15c
PH
671 write_string('[debug] System config: ' + repr(_hide_login_info(systemConf)) + '\n')
672 write_string('[debug] User config: ' + repr(_hide_login_info(userConf)) + '\n')
673 write_string('[debug] Command-line args: ' + repr(_hide_login_info(commandLineConf)) + '\n')
34a741a8
PH
674
675 return parser, opts, args