1ELINKS.CONF(5) ELinks configuration file ELINKS.CONF(5)
2
6 elinks.conf - ELinks configuration file
7
9 set "<option>" = <value>
10 unset "<option>" = <value>
11 bind "<keymap>" "<key>" = "<action>"
12 include "<file>"
13
16 The elinks.conf file contains configuration information for ELinks. It
17 can be used to configure the behaviour of ELinks in a wide variety of
18 ways: protocol behaviour, keybindings, colors used for rendering and
19 for the user interface.
20 It is read at startup and saved only when requested. All options
23 described in this document can be fully configured from within ELinks
24 so no editing of elinks.conf is needed.
25 Note that MIME-related options used for specifying handlers of various
28 MIME types are NOT described in this document. Documentation for these
29 options can be found at the ELinks homepage. Keybindings can also be
30 specified in elinks.conf. This is described in elinkskeys(5).
31
34 The syntax of the configuration file is very simple. The elinks.conf
35 file is a free-form ASCII text file. The file may contain extra tabs
36 and newlines for formatting purposes. Keywords in the file are
37 case-sensitive. Comments may be placed anywhere within the file (except
38 within quotes). Comments begin with the # character and end at the end
39 of the line.
40
43 Some sample settings:
44 # Use asynchronous DNS resolver?
46 set connection.async_dns = 1
47 # horizontal text margin.
48 set document.browse.margin_width = 3
49 # Default document codepage.
50 set document.codepage.assume = "ISO-8859-1"
51 # User defined protocol handlers
52 set protocol.user.mailto.unix = "mutt %h -s \e\*(lq%s\e\*(rq"
53
56 bookmarks
57 Bookmark options.
58 bookmarks.file_format <num> (default: 0)
61 File format for bookmarks (affects both reading and saving):
62 · 0: is the default native ELinks format
65 · 1: is XBEL universal XML bookmarks format (NO NATIONAL CHARS
67 SUPPORT!)
68 bookmarks.folder_state [0|1] (default: 1)
70 When saving bookmarks also store whether folders are expanded or
71 not, so the look of the bookmark dialog is kept across ELinks
72 sessions. If disabled all folders will appear unexpanded next
73 time ELinks is run.
74 config Configuration handling options.
77 config.comments <num> (default: 3)
80 Amount of comments automatically written to the config file:
81 · 0: is no comments are written
84 · 1: is only the "blurb" (name+type) is written
86 · 2: is only the description is written
88 · 3: is full comments are written
90 config.indentation <num> (default: 2)
92 Shift width of one indentation level in the configuration file.
93 Zero means that no indentation is performed at all when saving
94 the configuration.
95 config.saving_style <num> (default: 3)
98 Determines what happens when you tell ELinks to save options:
99 · 0: is only values of current options are altered
102 · 1: is values of current options are altered and missing
104 options are added at the end of the file
105 · 2: is the configuration file is rewritten from scratch
107 · 3: is values of current options are altered and missing
109 options CHANGED during this ELinks session are added at the
110 end of the file
111 config.i18n [0|1] (default: 0)
113 If set to 1, comments in the configuration file will be trans‐
114 lated to the language used by UI. Note that if you have differ‐
115 ent language set in different terminals, the language used in
116 the configuration file MAY be the same as on the terminal where
117 you saved the file, but it should be generally considered unpre‐
118 dictable.
119 config.saving_style_w [0|1] (default: 0)
122 This is internal option used when displaying a warning about
123 obsolete config.saving_style. You shouldn't touch it.
124 config.show_template [0|1] (default: 0)
127 Show template options in autocreated trees in the options man‐
128 ager and save them to the configuration file.
129 connection
132 Connection options.
133 connection.ssl
136 SSL options.
137 connection.ssl.client_cert
140 X509 client certificate options.
141 connection.ssl.client_cert.enable [0|1] (default: 0)
144 Enable or not the sending of X509 client certificates to servers
145 which request them.
146 connection.ssl.client_cert.file <str> (default: "")
149 The location of a file containing the client certificate and
150 unencrypted private key in PEM format. If unset, the file
151 pointed to by the X509_CLIENT_CERT variable is used instead.
152 connection.ssl.cert_verify [0|1] (default: 0)
155 Verify the peer's SSL certificate. Note that this needs exten‐
156 sive configuration of OpenSSL by the user.
157 connection.async_dns [0|1] (default: 1)
160 Whether to use asynchronous DNS resolving.
161 connection.max_connections <num> (default: 10)
164 Maximum number of concurrent connections.
165 connection.max_connections_to_host <num> (default: 2)
168 Maximum number of concurrent connections to a given host.
169 connection.receive_timeout <num> (default: 120)
172 Receive timeout (in seconds).
173 connection.retries <num> (default: 3)
176 Number of tries to establish a connection. Zero means try for‐
177 ever.
178 connection.try_ipv4 [0|1] (default: 1)
181 Whether to try to connect to a host over IPv4. Note that if con‐
182 nection.try_ipv6 is enabled too, it takes precedence. And better
183 do not touch this at all unless you are sure what are you doing.
184 Note that you can also force a given protocol to be used on a
185 per-connection basis by using an URL in the style of i.e.
186 http4://elinks.or.cz/.
187 connection.try_ipv6 [0|1] (default: 1)
190 Whether to try to connect to a host over IPv6. Note that you can
191 also force a given protocol to be used on a per-connection basis
192 by using an URL in the style of i.e. http6://elinks.or.cz/.
193 connection.unrestartable_receive_timeout <num> (default: 600)
196 Timeout for non-restartable connections (in seconds).
197 cookies
200 Cookies options.
201 cookies.accept_policy <num> (default: 2)
204 Cookies accepting policy:
205 · 0: is accept no cookies
208 · 1: is ask for confirmation before accepting cookie
210 · 2: is accept all cookies
212 cookies.max_age <num> (default: -1)
214 Cookie maximum age (in days):
215 · -1: is use cookie's expiration date if any
218 · 0: is force expiration at the end of session, ignoring
220 cookie's expiration date
221 · 1: + is use cookie's expiration date, but limit age to the
223 given number of days
224 cookies.paranoid_security [0|1] (default: 0)
226 When enabled, we'll require three dots in cookies domain for all
227 non-international domains (instead of just two dots). Some coun‐
228 tries have generic second level domains (eg. .com.pl, .co.uk)
229 and allowing sites to set cookies for these generic domains
230 could potentially be very bad. Note, it is off by default as it
231 breaks a lot of sites.
232 cookies.save [0|1] (default: 1)
235 Whether cookies should be loaded from and save to disk.
236 cookies.resave [0|1] (default: 1)
239 Save cookies after each change in cookies list? No effect when
240 cookie saving (cookies.save) is off.
241 document
244 Document options.
245 document.browse
248 Document browsing options (mainly interactivity).
249 document.browse.accesskey
252 Options for handling of link access keys. An HTML document can
253 use the ACCESSKEY attribute to assign an access key to an ele‐
254 ment. When an access key is pressed, the corresponding element
255 will be given focus.
256 document.browse.accesskey.auto_follow [0|1] (default: 0)
259 Automatically follow a link or submit a form if appropriate
260 accesskey is pressed - this is the standard behaviour, but it's
261 considered dangerous.
262 document.browse.accesskey.display [0|1] (default: 0)
265 Display access key in link info.
266 document.browse.accesskey.priority <num> (default: 0)
269 Priority of 'accesskey' HTML attribute:
270 · 0: is first try all normal bindings; if it fails, check
273 accesskey
274 · 1: is first try only frame bindings; if it fails, check
276 accesskey
277 · 2: is first check accesskey (this can be dangerous)
279 document.browse.forms
281 Options for handling of the forms interaction.
282 document.browse.forms.auto_submit [0|1] (default: 1)
285 Automagically submit a form when enter is pressed with a text
286 field selected.
287 document.browse.forms.confirm_submit [0|1] (default: 1)
290 Ask for confirmation when submitting a form.
291 document.browse.forms.input_size <num> (default: 20)
294 Default form input size if none is specified.
295 document.browse.forms.insert_mode [0|1] (default: 1)
298 The setting for this option affects how key presses are handled
299 when one selects a text-input form-field. When enabled, one must
300 explicitly 'enter' a selected text-field to edit it; this pre‐
301 vents text fields from capturing key presses, such as presses of
302 a scroll key, when it is inadvertently selected. When disabled,
303 key presses are always inserted into a selected text field.
304 document.browse.forms.editor <str> (default: "")
307 Path to the executable that ELinks should launch when the user
308 requests to edit a textarea with an external editor. If this is
309 blank, ELinks will use the value of the environmental variable
310 $EDITOR. If $EDITOR is empty or not set, ELinks will then
311 default to "vi".
312 document.browse.forms.show_formhist [0|1] (default: 0)
315 Ask if a login form should be saved to file or not. This option
316 only disables the dialog, already saved login forms are unaf‐
317 fected.
318 document.browse.images
321 Options for handling of images.
322 document.browse.images.display_style <num> (default: 2)
325 Display style for image tags when displayed:
326 · 0: means always display IMG
329 · 1: means always display filename
331 · 2: means display alt/title attribute if possible, IMG if not
333 · 3: means display alt/title attribute if possible, filename if
335 not
336 document.browse.images.filename_maxlen <num> (default: 0)
338 Maximum length of image filename when displayed:
339 · 0: means always display full filename
342 · 1-500: means display filename with this maximal length; if it
344 is longer, the middle is substituted by an asterisk
345 document.browse.images.image_link_tagging <num> (default: 1)
347 When to enclose image links:
348 · 0: means never
351 · 1: means never if alt or title are provided (old behavior)
353 · 2: means always
355 document.browse.images.image_link_prefix <str> (default: "[")
357 Prefix string to use to mark image links.
358 document.browse.images.image_link_suffix <str> (default: "]")
361 Suffix string to use to mark image links.
362 document.browse.images.label_maxlen <num> (default: 0)
365 Maximum length of image label (alt/title):
366 · 0: means always display full label
369 · 1-500: means display label with this maximal length; if it is
371 longer, the middle is substituted by an asterisk
372 document.browse.images.show_as_links [0|1] (default: 0)
374 Display links to images without an alt attribute. If this option
375 is off, these images are completely invisible.
376 document.browse.images.show_any_as_links [0|1] (default: 1)
379 Display links to any images in the document, regardless of them
380 having an alt attribute or not. If this option is off, the alt
381 attribute contents is shown, but as normal text, not selectable
382 as a link.
383 document.browse.links
386 Options for handling of links to other documents.
387 document.browse.links.active_link
390 Options for the active link.
391 document.browse.links.active_link.colors
394 Active link colors.
395 document.browse.links.active_link.colors.background <color|#rrggbb>
398 (default: blue)
399 Default background color.
400 document.browse.links.active_link.colors.text <color|#rrggbb> (default:
403 black)
404 Default text color.
405 document.browse.links.active_link.enable_color [0|1] (default: 0)
408 Enable use of the active link background and text color settings
409 instead of the link colors from the document.
410 document.browse.links.active_link.bold [0|1] (default: 0)
413 Make the active link text bold.
414 document.browse.links.active_link.invert [0|1] (default: 1)
417 Invert the fore- and background color so the link stands out.
418 document.browse.links.active_link.underline [0|1] (default: 0)
421 Underline the active link.
422 document.browse.links.color_dirs [0|1] (default: 1)
425 Highlight links to directories in FTP and local directory list‐
426 ing.
427 document.browse.links.numbering [0|1] (default: 0)
430 Display numbers next to the links.
431 document.browse.links.target_blank <num> (default: 0)
434 Define how to handle links having target=_blank set:
435 · 0: means open link in current tab
438 · 1: means open link in new tab in foreground
440 · 2: means open link in new tab in background
442 · 3: means open link in new window
444 document.browse.links.use_tabindex [0|1] (default: 1)
446 Whether to navigate links using tabindex specified ordering. The
447 TABINDEX attribute in HTML elements specifies the order in which
448 links should receive focus when using the keyboard to navigating
449 the document.
450 document.browse.links.missing_fragment [0|1] (default: 1)
453 Open a message box when document has no tag with given id.
454 document.browse.links.number_keys_select_link <num> (default: 1)
457 Number keys select links rather than specify command prefixes.
458 This is a tristate:
459 · 0: means never
462 · 1: means if document.browse.links.numbering = 1
464 · 2: means always
466 document.browse.links.warn_malicious [0|1] (default: 1)
468 When following a link the user ID part of the URI is checked and
469 if a maliciously crafted URI is detected a warning dialog will
470 ask before following the link.
471 document.browse.links.wraparound [0|1] (default: 0)
474 When pressing 'down' on the last link, jump at the first one,
475 and vice versa.
476 document.browse.scrolling
479 Scrolling options.
480 document.browse.scrolling.horizontal_extended [0|1] (default: 1)
483 Whether to allow horizontal scrolling when the document does not
484 extend off the screen. Useful for copy/paste operations.
485 document.browse.scrolling.horizontal_step <num> (default: 8)
488 Number of columns to scroll when a key bound to scroll-left or
489 scroll- right is pressed and no prefix was given.
490 document.browse.scrolling.margin <num> (default: 3)
493 Size of the virtual margin - when you click inside of that mar‐
494 gin, document scrolls in that direction.
495 document.browse.scrolling.vertical_step <num> (default: 2)
498 Number of lines to scroll when a key bound to scroll-up or
499 scroll- down is pressed and no prefix was given.
500 document.browse.search
503 Options for searching.
504 document.browse.search.case [0|1] (default: 0)
507 Whether the search should match the document text while main‐
508 taining case sensitivity.
509 document.browse.search.regex <num> (default: 0)
512 Enable searching with regular expressions:
513 · 0: for plain text searching
516 · 1: for basic regular expression searches
518 · 2: for extended regular expression searches
520 document.browse.search.show_hit_top_bottom [0|1] (default: 1)
522 Whether to show a dialog when the search hits top or bottom of
523 the document.
524 document.browse.search.wraparound [0|1] (default: 1)
527 Wrap around when searching. Currently only used for typeahead.
528 document.browse.search.show_not_found <num> (default: 2)
531 How to inform the user when nothing is matched:
532 · 0: means do nothing
535 · 1: means beep the terminal
537 · 2: means pop up message box
539 document.browse.search.typeahead <num> (default: 0)
541 Start typeahead searching when an unbound key is pressed without
542 any modifiers. Note that most keys have default bindings, so
543 this feature will not be useful unless you unbind them.
544 when you (when you press a key bound to search-typeahead or similar)
547 1 automatically starts typeahead searching thru link text 2
548 automatically starts typeahead searching thru all document text
549 document.browse.margin_width <num> (default: 3)
552 Horizontal text margin.
553 document.browse.refresh [0|1] (default: 1)
556 Automatically follow document-specified refresh directives
557 (<meta> refresh tags). Web-page authors use these to instruct
558 the browser to reload a document at a given interval or to load
559 another page. Regardless of the value the refresh URI is acces‐
560 sible as a link. Use the document.browse.minimum_refresh_time to
561 control the minimum number of seconds a refresh will wait.
562 document.browse.minimum_refresh_time <num> (default: 1000)
565 The minimum number of milliseconds that should pass before
566 refreshing. If set to zero the document refresh time is used
567 unchanged. It can fix going back in history for some sites that
568 use refreshing with zero values.
569 document.browse.table_move_order [0|1] (default: 0)
572 Move by columns in table, instead of rows.
573 document.cache
576 Cache options.
577 document.cache.format
580 Format cache options.
581 document.cache.format.size <num> (default: 5)
584 Number of cached formatted pages. Do not get too generous here,
585 'formatted' means that all the accompanying structures are kept
586 in memory so that you get the cached document immediatelly, but
587 these structures may take a lot - 2x the size of the HTML source
588 is probably not unusual, but it can be even more if the document
589 consists of a lot of short lines (padded right, if possible) and
590 links and not much other markup. So if you set this to 256 and
591 then you don't like your ELinks eating 90M, don't come complain‐
592 ing to us. ;-) Also note that the format cache itself is not
593 counted to the memory cache size, but the HTML source of the
594 formatted documents is always cached, even if it is over the
595 memory cache size threshold. (Then of course no other documents
596 can be cached.)
597 document.cache.memory
600 Memory cache options.
601 document.cache.memory.size <num> (default: 1048576)
604 Memory cache size (in bytes).
605 document.cache.cache_redirects [0|1] (default: 0)
608 Cache even redirects sent by server (usually thru HTTP by a 302
609 HTTP code and a Location header). This was the original behav‐
610 iour for a quite some time, but it causes problems in a situa‐
611 tion very common to various web login systems - frequently, when
612 accessing certain location, they will redirect you to a login
613 page if they don't receive an auth cookie, the login page then
614 gives you the cookie and redirects you back to the original
615 page, but there you have already cached redirect back to the
616 login page! If this option has value of 0, this malfunction is
617 fixed, but occasionally you may get superfluous (depends on how
618 you take it ;-) requests to the server. If this option has value
619 of 1, experienced users can still workaround it by clever combi‐
620 nation of usage of reload, jumping around in session history and
621 hitting ctrl+enter. Note that this option is checked when
622 retrieving the information from cache, not when saving it to
623 cache - thus if you will enable it, even previous redirects will
624 be taken from cache instead of asking the server.
625 document.cache.ignore_cache_control [0|1] (default: 1)
628 Ignore Cache-Control and Pragma server headers. When set, the
629 document is cached even with 'Cache-Control: no-cache'.
630 document.codepage
633 Charset options.
634 document.codepage.assume <codepage> (default: System)
637 Default document codepage. 'System' stands for a codepage deter‐
638 mined by a selected locale.
639 document.codepage.force_assumed [0|1] (default: 0)
642 Ignore charset info sent by server.
643 document.colors
646 Default document color settings.
647 document.colors.text <color|#rrggbb> (default: gray75)
650 Default text color.
651 document.colors.background <color|#rrggbb> (default: black)
654 Default background color.
655 document.colors.link <color|#rrggbb> (default: blue)
658 Default link color.
659 document.colors.vlink <color|#rrggbb> (default: yellow)
662 Default visited link color.
663 document.colors.image <color|#rrggbb> (default: darkolivegreen)
666 Default image link color.
667 document.colors.bookmark <color|#rrggbb> (default: hotpink)
670 Default bookmarked link color.
671 document.colors.dirs <color|#rrggbb> (default: yellow)
674 Default directory color. See document.browse.links.color_dirs
675 option.
676 document.colors.increase_contrast [0|1] (default: 1)
679 Increase the contrast between the foreground and background col‐
680 ors to ensure readability. For example it disallows dark colors
681 on a black background. Note, this is different from ensuring the
682 contrast with the ensure_contrast option.
683 document.colors.ensure_contrast [0|1] (default: 1)
686 Makes sure that the back- and foreground color are never equal.
687 document.colors.use_document_colors <num> (default: 2)
690 Use colors specified in document:
691 · 0: is use always the default settings
694 · 1: is use document colors if available, except background
696 · 2: is use document colors, including background. This can
698 mostly look very impressive, but some sites will appear
699 really ugly. Note, that obviously if the background is not
700 black, it will break the behaviour of transparency.
701 document.css
703 Options concerning how to use CSS for styling documents.
704 document.css.enable [0|1] (default: 1)
707 Enable adding of CSS style info to documents.
708 document.css.import [0|1] (default: 1)
711 When enabled any external style sheets that are imported from
712 either CSS itself using the @import keyword or from the HTML
713 using <link> tags in the document header will also be down‐
714 loaded.
715 document.css.stylesheet <str> (default: "")
718 The path to the file containing the default user defined Cascad‐
719 ing Style Sheet. It can be used to control the basic layout of
720 HTML documents. The path is assumed to be relative to ELinks'
721 home directory. Leave as "" to use built-in document styling.
722 document.download
725 Options regarding files downloading and handling.
726 document.download.directory <str> (default: "./")
729 Default download directory.
730 document.download.set_original_time [0|1] (default: 0)
733 Set the timestamp of each downloaded file to the timestamp
734 stored on the server.
735 document.download.overwrite <num> (default: 2)
738 Prevent overwriting the local files:
739 · 0: is files will silently be overwritten
742 · 1: is add a suffix .{number} (for example '.1') to the name
744 · 2: is ask the user
746 document.download.notify_bell <num> (default: 0)
748 Audio notification when download is completed:
749 · 0: is never
752 · 1: is when background notification is active
754 · 2: is always
756 document.dump
758 Dump output options.
759 document.dump.codepage <codepage> (default: System)
762 Codepage used in dump output. 'System' stands for a codepage
763 determined by a selected locale.
764 document.dump.footer <str> (default: "")
767 Footer string used in dumps. %u is substituted by URL.
768 document.dump.header <str> (default: "")
771 Header string used in dumps. %u is substituted by URL.
772 document.dump.numbering [0|1] (default: 1)
775 Whether to print link numbers in dump output.
776 document.dump.references [0|1] (default: 1)
779 Whether to print references (URIs) of document links in dump
780 output.
781 document.dump.separator <str> (document.dump.separator <str> (default:
784 "), document.dump.width <num> (default: 80)
785 Width of screen in characters when dumping documents.
786 document.history
789 History options.
790 document.history.global
793 Global history options.
794 document.history.global.enable [0|1] (default: 1)
797 Enable global history ("history of all pages visited").
798 document.history.global.max_items <num> (default: 1024)
801 Maximum number of entries in the global history.
802 document.history.global.display_type <num> (default: 0)
805 What to display in global history dialog:
806 · 0: is URLs
809 · 1: is page titles
811 document.history.keep_unhistory [0|1] (default: 1)
813 Keep unhistory ("forward history").
814 document.html
817 Options concerning the display of HTML pages.
818 document.html.display_frames [0|1] (default: 1)
821 Display frames.
822 document.html.display_tables [0|1] (default: 1)
825 Display tables.
826 document.html.display_subs [0|1] (default: 1)
829 Display subscripts (as [thing]).
830 document.html.display_sups [0|1] (default: 1)
833 Display superscripts (as ^thing).
834 document.html.link_display <num> (default: 2)
837 How to render <link> tags from the HTML header:
838 · 0: is nothing
841 · 1: is title
843 · 2: is name in addition
845 · 3: is hreflang in addition
847 · 4: is type in addition
849 · 5: is everything
851 document.html.underline_links [0|1] (default: 0)
853 Underline links.
854 document.html.wrap_nbsp [0|1] (default: 0)
857 If set do not honour non breaking space (the nbsp entity) but
858 allow to wrap the text. This can help keeping the width of docu‐
859 ments down so no horizontal scrolling is needed.
860 document.plain
863 Options concerning the display of plain text pages.
864 document.plain.display_links [0|1] (default: 0)
867 Display URIs in the document as links.
868 document.plain.compress_empty_lines [0|1] (default: 0)
871 Compress successive empty lines to only one in displayed text.
872 document.uri_passing
875 Rules for passing URIs to external commands.
876 document.uri_passing._template_ <str> (default: "")
879 A rule for passing URI to an external command. The format is: %c
880 in the string means the current URL %% in the string means '%'
881 Do _not_ put single- or double-quotes around %c.
882 ecmascript
885 ECMAScript options.
886 ecmascript.enable [0|1] (default: 1)
889 Whether to run those scripts inside of documents.
890 ecmascript.error_reporting [0|1] (default: 0)
893 Open a message box when a script reports an error.
894 ecmascript.ignore_noscript [0|1] (default: 0)
897 Whether to ignore content enclosed by the <noscript> tag when
898 ECMAScript is enabled.
899 ecmascript.max_exec_time <num> (default: 5)
902 Maximum execution time in seconds for a script.
903 ecmascript.block_window_opening [0|1] (default: 0)
906 Whether to disallow scripts to open new windows or tabs.
907 infofiles
910 Options for information files in ~/.elinks.
911 infofiles.save_interval <num> (default: 300)
914 Interval at which to trigger information files in ~/.elinks to
915 be saved to disk if they has changed (seconds; 0 to disable)
916 infofiles.secure_save [0|1] (default: 1)
919 First write data to unique temporary file, then rename this file
920 upon successfully finishing this. Note that this relates only to
921 config files, not downloaded files. You may want to disable it
922 if you are using some exotic permissions for concerned files.
923 Secure file saving is automagically disabled if file is symlink.
924 Warning: some systems (ie. OS/2, Win32) require that destination
925 file doesn't exist when rename(3) is called, breaking atomicity,
926 and reducing reliability of this feature.
927 infofiles.secure_save_fsync [0|1] (default: 1)
930 When using secure file saving, call fsync(3), if the OS supports
931 it, to force the OS immediately to write the data to permanent
932 storage. This is optional for those who wish to avoid excessive
933 disk I/O.
934 mime MIME-related options (handlers of various MIME types).
937 mime.extension
940 Extension <-> MIME type association.
941 mime.extension._template_ <str> (default: "")
944 MIME-type matching this file extension ('*' is used here in
945 place of '.').
946 mime.handler
949 A file type handler is a set of information about how to use an
950 external program to view a file. It is possible to refer to it
951 for several MIME types -- e.g., you can define an 'image' han‐
952 dler to which mime.type.image.png, mime.type.image.jpeg, and so
953 on will refer; or one might define a handler for a more specific
954 type of file -- e.g., PDF files. Note you must define both a
955 MIME handler and a MIME type association for it to work.
956 mime.handler._template_
959 Description of this handler.
960 mime.handler._template_._template_
963 System-specific handler description (ie. unix, unix-xwin, ...).
964 mime.handler._template_._template_.ask [0|1] (default: 1)
967 Ask before opening.
968 mime.handler._template_._template_.block [0|1] (default: 1)
971 Block the terminal when the handler is running.
972 mime.handler._template_._template_.program <str> (default: "")
975 External viewer for this file type. '%' in this string will be
976 substituted by a file name.
977 mime.mailcap
980 Options for mailcap support.
981 mime.mailcap.enable [0|1] (default: 1)
984 Enable mailcap support.
985 mime.mailcap.path <str> (default: "~/.mailcap:/etc/mail‐
988 cap:/usr/etc/mailcap:/usr/local/etc/mailcap:/usr/share/mail‐
989 cap:/usr/share/misc/mailcap")
990 Mailcap search path. Colon-separated list of files. Leave as ""
991 to use MAILCAP environment variable instead.
992 mime.mailcap.ask [0|1] (default: 1)
995 Ask before using the handlers defined by mailcap.
996 mime.mailcap.description <num> (default: 0)
999 Type of description to show in "what to do with this file" query
1000 dialog:
1001 · 0: is show "mailcap"
1004 · 1: is show program to be run
1006 · 2: is show mailcap description field if any; "mailcap" other‐
1008 wise
1009 mime.mailcap.prioritize [0|1] (default: 1)
1011 Prioritize entries by the order of the files in the mailcap
1012 path. This means that wildcard entries (like: image/*) will also
1013 be checked before deciding the handler.
1014 mime.mimetypes
1017 Options for the support of mime.types files. These files can be
1018 used to find the content type of an URL by looking at the exten‐
1019 sion of the file name.
1020 mime.mimetypes.enable [0|1] (default: 1)
1023 Enable mime.types support.
1024 mime.mimetypes.path <str> (default:
1027 "~/.mime.types:/etc/mime.types:/usr/etc/mime.types:/usr/local/etc/mime.types:/usr/share/mime.types:/usr/share/misc/mime.types")
1028 The search path for mime.types files. Colon-separated list of
1029 files.
1030 mime.type
1033 Handler <-> MIME type association. The first sub-tree is the
1034 MIME class while the second sub-tree is the MIME type (ie.
1035 image/gif handler will reside at mime.type.image.gif). Each MIME
1036 type option should contain (case-sensitive) name of the MIME
1037 handler (its properties are stored at mime.handler.<name>).
1038 mime.type._template_
1041 Handler matching this MIME-type class ('*' is used here in place
1042 of '.').
1043 mime.type._template_._template_ <str> (default: "")
1046 Handler matching this MIME-type name ('*' is used here in place
1047 of '.').
1048 mime.default_type <str> (default: "application/octet-stream")
1051 Document MIME-type to assume by default (when we are unable to
1052 guess it properly from known information about the document).
1053 protocol
1056 Protocol specific options.
1057 protocol.bittorrent
1060 BitTorrent specific options.
1061 protocol.bittorrent.ports
1064 Port range allowed to be used for listening on.
1065 protocol.bittorrent.ports.min <num> (default: 6881)
1068 The minimum port to try and listen on.
1069 protocol.bittorrent.ports.max <num> (default: 6999)
1072 The maximum port to try and listen on.
1073 protocol.bittorrent.tracker
1076 Tracker options.
1077 protocol.bittorrent.tracker.compact [0|1] (default: 0)
1080 Whether to request that the tracker returns peer info in compact
1081 format. Note, the compact format only supports IPv4 addresses.
1082 protocol.bittorrent.tracker.interval <num> (default: 0)
1085 The number of seconds to wait between periodically contacting
1086 the tracker for announcing progress and requesting more peers.
1087 Set to zero to use the interval requested by the tracker.
1088 protocol.bittorrent.tracker.ip_address <str> (default: "")
1091 What IP address to report to the tracker. If set to "" no IP
1092 address will be sent and the tracker will automatically deter‐
1093 mine an appropriate IP address.
1094 protocol.bittorrent.tracker.key <str> (default: "")
1097 An additional identification that is not shared with any users.
1098 It is intended to allow a client to prove their identity should
1099 their IP address change. It is an optional parameter, but some
1100 trackers require this parameter. If set to "" no user key will
1101 be sent to the tracker.
1102 protocol.bittorrent.tracker.numwant <num> (default: 50)
1105 The maximum number of peers to request from the tracker. Set to
1106 0 to use the server default.
1107 protocol.bittorrent.tracker.min_skip_size <num> (default: 20)
1110 The minimum number of peers to have in the current peer info
1111 pool before skipping requesting of more peers. I.e. setting
1112 numwant to zero. Set to 0 to not have any limit.
1113 protocol.bittorrent.peerwire
1116 Lowlevel peer-wire options.
1117 protocol.bittorrent.peerwire.connections <num> (default: 55)
1120 The maximum number of allowed connections to both active and
1121 non-active peers. By increasing the number of allowed connec‐
1122 tions, the chance of finding good peers to download from is
1123 increased. However, too many connections can lead to TCP conges‐
1124 tion. If the maximum is reached all new incoming connections
1125 will be closed.
1126 protocol.bittorrent.peerwire.max_message_length <num> (default:
1129 8388608)
1130 The maximum length of messages to accept over the wire. Larger
1131 values will cause the connection to be dropped.
1132 protocol.bittorrent.peerwire.max_request_length <num> (default:
1135 8388608)
1136 The maximum length to allow for incoming requests. Larger
1137 requests will cause the connection to be dropped.
1138 protocol.bittorrent.peerwire.request_length <num> (default: 16384)
1141 How many bytes to query for per request. This is complementary
1142 to the max_request_length option. If the configured length is
1143 bigger than the piece length it will be truncated.
1144 protocol.bittorrent.peerwire.timeout <num> (default: 300)
1147 The number of seconds to wait before closing a socket on which
1148 nothing has been received or sent.
1149 protocol.bittorrent.peerwire.pool_size <num> (default: 55)
1152 Maximum number of items in the peer pool. The peer pool contains
1153 information used for establishing connections to new peers. Set
1154 to 0 to have unlimited size.
1155 protocol.bittorrent.piece_cache_size <num> (default: 1048576)
1158 The maximum amount of memory used to hold recently downloaded
1159 pieces. Set to 0 to have unlimited size.
1160 protocol.bittorrent.max_uploads <num> (default: 7)
1163 The maximum number of uploads to allow at once.
1164 protocol.bittorrent.min_uploads <num> (default: 2)
1167 The minimum number of uploads which should at least be used for
1168 new connections.
1169 protocol.bittorrent.request_queue_size <num> (default: 5)
1172 How many piece requests to continuously keep in queue. Pipelin‐
1173 ing of requests is essential to saturate connections and get a
1174 good connection performance and thus a faster download. However,
1175 a very big queue size can lead to wasting bandwidth near the end
1176 of the connection since remaining piece blocks will be requested
1177 from multiple peers.
1178 protocol.bittorrent.choke_interval <num> (default: 10)
1181 The number of seconds between updating the connection state and
1182 most importantly choke and unchoke peer connections. The choke
1183 period should be big enough for newly unchoked connections to
1184 get started but small enough to not allow freeriders too much
1185 room for stealing bandwidth.
1186 protocol.bittorrent.rarest_first_cutoff <num> (default: 4)
1189 The number of pieces to obtain before switching piece selection
1190 strategy from random to rarest first.
1191 protocol.bittorrent.allow_blacklist [0|1] (default: 1)
1194 Allow blacklisting of buggy peers.
1195 protocol.file
1198 Options specific to local browsing.
1199 protocol.file.cgi
1202 Local CGI specific options.
1203 protocol.file.cgi.path <str> (default: "")
1206 Colon separated list of directories, where CGI scripts are
1207 stored.
1208 protocol.file.cgi.policy [0|1] (default: 0)
1211 Whether to execute local CGI scripts.
1212 protocol.file.allow_special_files [0|1] (default: 0)
1215 Whether to allow reading from non-regular files. Note this can
1216 be dangerous; reading /dev/urandom or /dev/zero can ruin your
1217 day!
1218 protocol.file.show_hidden_files [0|1] (default: 1)
1221 When set to false, files with name starting with a dot will be
1222 hidden in local directories listing.
1223 protocol.file.try_encoding_extensions [0|1] (default: 1)
1226 When set, if we can't open a file named 'filename', we'll try to
1227 open 'filename' with some encoding extension appended (ie.
1228 'filename.gz'); it depends on the supported encodings.
1229 protocol.fsp
1232 FSP specific options.
1233 protocol.fsp.sort [0|1] (default: 1)
1236 Whether to sort entries in directory listings.
1237 protocol.ftp
1240 FTP specific options.
1241 protocol.ftp.proxy
1244 FTP proxy configuration.
1245 protocol.ftp.proxy.host <str> (default: "")
1248 Host and port-number (host:port) of the FTP proxy, or blank. If
1249 it's blank, FTP_PROXY environment variable is checked as well.
1250 protocol.ftp.anon_passwd <str> (default: "some@host.domain")
1253 FTP anonymous password to be sent.
1254 protocol.ftp.use_pasv [0|1] (default: 1)
1257 Use PASV instead of PORT (passive vs active mode, IPv4 only).
1258 protocol.ftp.use_epsv [0|1] (default: 0)
1261 Use EPSV instead of EPRT (passive vs active mode, IPv6 only).
1262 protocol.http
1265 HTTP-specific options.
1266 protocol.http.bugs
1269 Server-side HTTP bugs workarounds.
1270 protocol.http.bugs.accept_charset [0|1] (default: 1)
1273 The Accept-Charset header is quite long and sending it can trig‐
1274 ger bugs in some rarely found servers.
1275 protocol.http.bugs.allow_blacklist [0|1] (default: 1)
1278 Allow blacklisting of buggy servers.
1279 protocol.http.bugs.broken_302_redirect [0|1] (default: 1)
1282 Broken 302 redirect (violates RFC but compatible with Netscape).
1283 This is a problem for a lot of web discussion boards and the
1284 like. If they will do strange things to you, try to play with
1285 this.
1286 protocol.http.bugs.post_no_keepalive [0|1] (default: 0)
1289 Disable keepalive connection after POST request.
1290 protocol.http.bugs.http10 [0|1] (default: 0)
1293 Use HTTP/1.0 protocol instead of HTTP/1.1.
1294 protocol.http.proxy
1297 HTTP proxy configuration.
1298 protocol.http.proxy.host <str> (default: "")
1301 Host and port-number (host:port) of the HTTP proxy, or blank. If
1302 it's blank, HTTP_PROXY environment variable is checked as well.
1303 protocol.http.proxy.user <str> (default: "")
1306 Proxy authentication username.
1307 protocol.http.proxy.passwd <str> (default: "")
1310 Proxy authentication password.
1311 protocol.http.referer
1314 HTTP referer sending options. HTTP referer is a special header
1315 sent in the HTTP requests, which is supposed to contain the pre‐
1316 vious page visited by the browser. This way, the server can know
1317 what link did you follow when accessing that page. However, this
1318 behaviour can unfortunately considerably affect privacy and can
1319 lead even to a security problem on some badly designed web
1320 pages.
1321 protocol.http.referer.policy <num> (default: 3)
1324 Mode of sending HTTP referer:
1325 · 0: is send no referer
1328 · 1: is send current URL as referer
1330 · 2: is send fixed fake referer
1332 · 3: is send previous URL as referer (correct, but insecure)
1334 protocol.http.referer.fake <str> (default: "")
1336 Fake referer to be sent when policy is 2.
1337 protocol.http.accept_language <str> (default: "")
1340 Send Accept-Language header.
1341 protocol.http.accept_ui_language [0|1] (default: 1)
1344 Request localised versions of documents from web-servers (using
1345 the Accept-Language header) using the language you have config‐
1346 ured for ELinks' user-interface (this also affects naviga‐
1347 tor.language ECMAScript value available to scripts). Note that
1348 some see this as a potential security risk because it tells
1349 web-masters and the FBI sniffers about your language preference.
1350 protocol.http.trace [0|1] (default: 0)
1353 If active, all HTTP requests are sent with TRACE as their method
1354 rather than GET or POST. This is useful for debugging of both
1355 ELinks and various server-side scripts --- the server only
1356 returns the client's request back to the client verbatim. Note
1357 that this type of request may not be enabled on all servers.
1358 protocol.http.user_agent <str> (default: "ELinks/%v (textmode; %s;
1361 %t-%b)")
1362 Change the User Agent ID. That means identification string,
1363 which is sent to HTTP server when a document is requested. The
1364 'textmode' token in the first field is our silent attempt to
1365 establish this as a standard for new textmode user agents, so
1366 that the webmasters can have just a single uniform test for
1367 these if they are ie. pushing some lite version to them automag‐
1368 ically. %v in the string means ELinks version %s in the string
1369 means system identification %t in the string means size of the
1370 terminal %b in the string means number of bars displayed by
1371 ELinks Use " " if you don't want any User-Agent header to be
1372 sent at all.
1373 protocol.https
1376 HTTPS-specific options.
1377 protocol.https.proxy
1380 HTTPS proxy configuration.
1381 protocol.https.proxy.host <str> (default: "")
1384 Host and port-number (host:port) of the HTTPS CONNECT proxy, or
1385 blank. If it's blank, HTTPS_PROXY environment variable is
1386 checked as well.
1387 protocol.nntp
1390 NNTP and news specific options.
1391 protocol.nntp.server <str> (default: "")
1394 Used when resolving news: URIs. If set to the empty string the
1395 value of the NNTPSERVER environment variable will be used.
1396 protocol.nntp.header_entries <str> (default: "Subject,From,Date,Mes‐
1399 sage-ID,Newsgroups")
1400 Comma separated list of which entries in the article header to
1401 show. E.g. 'Subject' and From. All header entries can be read in
1402 the header info dialog.
1403 protocol.rewrite
1406 Rules for rewriting URIs entered in the goto dialog. It makes it
1407 possible to define a set of prefixes that will be expanded if
1408 they match a string entered in the goto dialog. The prefixes can
1409 be dumb, meaning that they work only like URI abbreviations, or
1410 smart ones, making it possible to pass arguments to them like
1411 search engine keywords.
1412 protocol.rewrite.dumb
1415 Dumb prefixes, see enable-dumb description for details.
1416 protocol.rewrite.dumb._template_ <str> (default: "")
1419 Replacement URI for this dumbprefix: %c in the string means the
1420 current URL %% in the string means '%'
1421 protocol.rewrite.smart
1424 Smart prefixes, see enable-smart description for details.
1425 protocol.rewrite.smart._template_ <str> (default: "")
1428 Replacement URI for this smartprefix: %c in the string means the
1429 current URL %s in the string means the whole argument to smart‐
1430 prefix %0,%1,...,%9 means argument 0, 1, ..., 9 %% in the string
1431 means '%'
1432 protocol.rewrite.default_template <str> (default: "")
1435 Default URI template used when the string entered in the goto
1436 dialog does not appear to be a URI or a filename (i.e. contains
1437 no '.', : or / characters), and does not match any defined pre‐
1438 fixes. Set the value to "" to disable use of the default tem‐
1439 plate rewrite rule.
1440 protocol.rewrite.enable-dumb [0|1] (default: 1)
1443 Enable dumb prefixes - simple URI abbreviations which can be
1444 written to the Goto URL dialog instead of actual URIs - i.e. if
1445 you write 'elinks' there, you are directed to http://elinks.cz/.
1446 protocol.rewrite.enable-smart [0|1] (default: 1)
1449 Enable smart prefixes - URI templates triggered by writing given
1450 abbreviation to the Goto URL dialog followed by a list of argu‐
1451 ments from which the actual URI is composed - i.e. 'gg:search
1452 keywords' or gn search keywords for news.
1453 protocol.smb
1456 SAMBA specific options.
1457 protocol.smb.credentials <str> (default: "")
1460 Credentials file passed to smbclient via -A option.
1461 protocol.user
1464 User protocols. Options in this tree specify external handlers
1465 for the appropriate protocols. Ie. protocol.user.mailto.unix.
1466 protocol.user._template_
1469 Handler (external program) for this protocol. Name the options
1470 in this tree after your system (ie. unix, unix-xwin).
1471 protocol.user._template_._template_ <str> (default: "")
1474 Handler (external program) for this protocol and system. %f in
1475 the string means file name to include form data from %h in the
1476 string means hostname (or email address) %p in the string means
1477 port %d in the string means path (everything after the port) %s
1478 in the string means subject (?subject=<this>) %u in the string
1479 means the whole URL
1480 protocol.no_proxy <str> (default: "")
1483 Comma separated list of domains for which the proxy (HTTP/FTP)
1484 should be disabled. Optionally, a port can be specified for some
1485 domains as well. If it's blank, NO_PROXY environment variable is
1486 checked as well.
1487 terminal
1490 Terminal options.
1491 terminal._template_
1494 Options specific to this terminal type (according to $TERM
1495 value).
1496 terminal._template_.type <num> (default: 0)
1499 Terminal type; matters mostly only when drawing frames and dia‐
1500 log box borders:
1501 · 0: is dumb terminal type, ASCII art
1504 · 1: is VT100, simple but portable
1506 · 2: is Linux, you get double frames and other goodies
1508 · 3: is KOI-8
1510 · 4: is FreeBSD
1512 terminal._template_.m11_hack [0|1] (default: 0)
1514 Switch fonts when drawing lines, enabling both local characters
1515 and lines working at the same time. Makes sense only with linux
1516 terminal.
1517 terminal._template_.utf_8_io [0|1] (default: 0)
1520 Enable I/O in UTF8 for Unicode terminals. Note that currently,
1521 only the subset of UTF8 according to terminal codepage is used.
1522 terminal._template_.restrict_852 [0|1] (default: 0)
1525 Restrict the characters used when drawing lines. Makes sense
1526 only with linux terminals using the cp850/852 character sets.
1527 terminal._template_.block_cursor [0|1] (default: 0)
1530 Move cursor to bottom right corner when done drawing. This is
1531 particularly useful when we have a block cursor, so that
1532 inversed text is displayed correctly.
1533 terminal._template_.colors <num> (default: 0)
1536 The color mode controls what colors are used and how they are
1537 output to the terminal. The color modes are:
1538 · 0: is mono mode, only 2 colors are used
1541 · 1: is 16 color mode, uses the common ANSI colors
1543 · 2: is 256 color mode, uses XTerm RGB codes
1545 terminal._template_.transparency [0|1] (default: 1)
1547 If we should not set the background to black. This is particu‐
1548 larly useful when we have a terminal (typically in some window‐
1549 ing environment) with a background image or a transparent back‐
1550 ground - it will be visible in ELinks as well. Note that this
1551 option makes sense only when colors are enabled.
1552 terminal._template_.underline [0|1] (default: 0)
1555 If we should use underline or enhance the color instead.
1556 terminal._template_.charset <codepage> (default: System)
1559 Codepage of charset used for displaying content on terminal.
1560 'System' stands for a codepage determined by a selected locale.
1561 ui User interface options.
1564 ui.clock
1567 Digital clock in the status bar.
1568 ui.clock.enable [0|1] (default: 0)
1571 Whether to display a digital clock in the status bar.
1572 ui.clock.format <str> (default: "[%H:%M]")
1575 Format string for the digital clock. See the strftime(3) manpage
1576 for details.
1577 ui.colors
1580 Default user interface color settings.
1581 ui.colors.color
1584 Color settings for color terminal.
1585 ui.colors.color.mainmenu
1588 Main menu bar colors.
1589 ui.colors.color.mainmenu.normal
1592 Unselected main menu bar item colors.
1593 ui.colors.color.mainmenu.normal.text <color|#rrggbb> (default: black)
1596 Default text color.
1597 ui.colors.color.mainmenu.normal.background <color|#rrggbb> (default:
1600 white)
1601 Default background color.
1602 ui.colors.color.mainmenu.selected
1605 Selected main menu bar item colors.
1606 ui.colors.color.mainmenu.selected.text <color|#rrggbb> (default: green)
1609 Default text color.
1610 ui.colors.color.mainmenu.selected.background <color|#rrggbb> (default:
1613 black)
1614 Default background color.
1615 ui.colors.color.mainmenu.hotkey
1618 Main menu hotkey colors.
1619 ui.colors.color.mainmenu.hotkey.normal
1622 Main menu unselected hotkey colors.
1623 ui.colors.color.mainmenu.hotkey.normal.text <color|#rrggbb> (default:
1626 darkred)
1627 Default text color.
1628 ui.colors.color.mainmenu.hotkey.normal.background <color|#rrggbb>
1631 (default: white)
1632 Default background color.
1633 ui.colors.color.mainmenu.hotkey.selected
1636 Main menu selected hotkey colors.
1637 ui.colors.color.mainmenu.hotkey.selected.text <color|#rrggbb> (default:
1640 darkred)
1641 Default text color.
1642 ui.colors.color.mainmenu.hotkey.selected.background <color|#rrggbb>
1645 (default: green)
1646 Default background color.
1647 ui.colors.color.menu
1650 Menu bar colors.
1651 ui.colors.color.menu.normal
1654 Unselected menu item colors.
1655 ui.colors.color.menu.normal.text <color|#rrggbb> (default: black)
1658 Default text color.
1659 ui.colors.color.menu.normal.background <color|#rrggbb> (default: white)
1662 Default background color.
1663 ui.colors.color.menu.selected
1666 Selected menu item colors.
1667 ui.colors.color.menu.selected.text <color|#rrggbb> (default: black)
1670 Default text color.
1671 ui.colors.color.menu.selected.background <color|#rrggbb> (default:
1674 green)
1675 Default background color.
1676 ui.colors.color.menu.marked
1679 Marked menu item colors.
1680 ui.colors.color.menu.marked.text <color|#rrggbb> (default: red)
1683 Default text color.
1684 ui.colors.color.menu.marked.background <color|#rrggbb> (default: white)
1687 Default background color.
1688 ui.colors.color.menu.hotkey
1691 Menu item hotkey colors.
1692 ui.colors.color.menu.hotkey.normal
1695 Menu item unselected hotkey colors.
1696 ui.colors.color.menu.hotkey.normal.text <color|#rrggbb> (default: dark‐
1699 red)
1700 Default text color.
1701 ui.colors.color.menu.hotkey.normal.background <color|#rrggbb> (default:
1704 white)
1705 Default background color.
1706 ui.colors.color.menu.hotkey.selected
1709 Menu item selected hotkey colors.
1710 ui.colors.color.menu.hotkey.selected.text <color|#rrggbb> (default:
1713 darkred)
1714 Default text color.
1715 ui.colors.color.menu.hotkey.selected.background <color|#rrggbb>
1718 (default: green)
1719 Default background color.
1720 ui.colors.color.menu.frame
1723 Menu frame colors.
1724 ui.colors.color.menu.frame.text <color|#rrggbb> (default: black)
1727 Default text color.
1728 ui.colors.color.menu.frame.background <color|#rrggbb> (default: white)
1731 Default background color.
1732 ui.colors.color.dialog
1735 Dialog colors.
1736 ui.colors.color.dialog.generic
1739 Generic dialog colors.
1740 ui.colors.color.dialog.generic.text <color|#rrggbb> (default: black)
1743 Default text color.
1744 ui.colors.color.dialog.generic.background <color|#rrggbb> (default:
1747 white)
1748 Default background color.
1749 ui.colors.color.dialog.frame
1752 Dialog frame colors.
1753 ui.colors.color.dialog.frame.text <color|#rrggbb> (default: black)
1756 Default text color.
1757 ui.colors.color.dialog.frame.background <color|#rrggbb> (default:
1760 white)
1761 Default background color.
1762 ui.colors.color.dialog.scrollbar
1765 Scrollbar colors.
1766 ui.colors.color.dialog.scrollbar.text <color|#rrggbb> (default: black)
1769 Default text color.
1770 ui.colors.color.dialog.scrollbar.background <color|#rrggbb> (default:
1773 blue)
1774 Default background color.
1775 ui.colors.color.dialog.scrollbar-selected
1778 Scrollbar selected colors.
1779 ui.colors.color.dialog.scrollbar-selected.text <color|#rrggbb>
1782 (default: black)
1783 Default text color.
1784 ui.colors.color.dialog.scrollbar-selected.background <color|#rrggbb>
1787 (default: green)
1788 Default background color.
1789 ui.colors.color.dialog.title
1792 Dialog title colors.
1793 ui.colors.color.dialog.title.text <color|#rrggbb> (default: darkred)
1796 Default text color.
1797 ui.colors.color.dialog.title.background <color|#rrggbb> (default:
1800 white)
1801 Default background color.
1802 ui.colors.color.dialog.text
1805 Dialog text colors.
1806 ui.colors.color.dialog.text.text <color|#rrggbb> (default: black)
1809 Default text color.
1810 ui.colors.color.dialog.text.background <color|#rrggbb> (default: white)
1813 Default background color.
1814 ui.colors.color.dialog.checkbox
1817 Dialog checkbox colors.
1818 ui.colors.color.dialog.checkbox.text <color|#rrggbb> (default: darkred)
1821 Default text color.
1822 ui.colors.color.dialog.checkbox.background <color|#rrggbb> (default:
1825 white)
1826 Default background color.
1827 ui.colors.color.dialog.checkbox-selected
1830 Dialog selected checkbox colors.
1831 ui.colors.color.dialog.checkbox-selected.text <color|#rrggbb> (default:
1834 yellow)
1835 Default text color.
1836 ui.colors.color.dialog.checkbox-selected.background <color|#rrggbb>
1839 (default: green)
1840 Default background color.
1841 ui.colors.color.dialog.checkbox-label
1844 Dialog checkbox label colors.
1845 ui.colors.color.dialog.checkbox-label.text <color|#rrggbb> (default:
1848 black)
1849 Default text color.
1850 ui.colors.color.dialog.checkbox-label.background <color|#rrggbb>
1853 (default: white)
1854 Default background color.
1855 ui.colors.color.dialog.button
1858 Dialog button colors.
1859 ui.colors.color.dialog.button.text <color|#rrggbb> (default: white)
1862 Default text color.
1863 ui.colors.color.dialog.button.background <color|#rrggbb> (default:
1866 blue)
1867 Default background color.
1868 ui.colors.color.dialog.button-selected
1871 Dialog selected button colors.
1872 ui.colors.color.dialog.button-selected.text <color|#rrggbb> (default:
1875 yellow)
1876 Default text color.
1877 ui.colors.color.dialog.button-selected.background <color|#rrggbb>
1880 (default: green)
1881 Default background color.
1882 ui.colors.color.dialog.button-shortcut
1885 Dialog button colors.
1886 ui.colors.color.dialog.button-shortcut.text <color|#rrggbb> (default:
1889 yellow)
1890 Default text color.
1891 ui.colors.color.dialog.button-shortcut.background <color|#rrggbb>
1894 (default: blue)
1895 Default background color.
1896 ui.colors.color.dialog.button-shortcut-selected
1899 Dialog selected button colors.
1900 ui.colors.color.dialog.button-shortcut-selected.text <color|#rrggbb>
1903 (default: white)
1904 Default text color.
1905 ui.colors.color.dialog.button-shortcut-selected.background
1908 <color|#rrggbb> (default: blue)
1909 Default background color.
1910 ui.colors.color.dialog.field
1913 Dialog text field colors.
1914 ui.colors.color.dialog.field.text <color|#rrggbb> (default: white)
1917 Default text color.
1918 ui.colors.color.dialog.field.background <color|#rrggbb> (default: blue)
1921 Default background color.
1922 ui.colors.color.dialog.field-text
1925 Dialog field text colors.
1926 ui.colors.color.dialog.field-text.text <color|#rrggbb> (default: yel‐
1929 low)
1930 Default text color.
1931 ui.colors.color.dialog.field-text.background <color|#rrggbb> (default:
1934 blue)
1935 Default background color.
1936 ui.colors.color.dialog.meter
1939 Dialog meter colors.
1940 ui.colors.color.dialog.meter.text <color|#rrggbb> (default: white)
1943 Default text color.
1944 ui.colors.color.dialog.meter.background <color|#rrggbb> (default: blue)
1947 Default background color.
1948 ui.colors.color.dialog.shadow
1951 Dialog shadow colors (see ui.shadows option).
1952 ui.colors.color.dialog.shadow.text <color|#rrggbb> (default: black)
1955 Default text color.
1956 ui.colors.color.dialog.shadow.background <color|#rrggbb> (default:
1959 black)
1960 Default background color.
1961 ui.colors.color.title
1964 Title bar colors.
1965 ui.colors.color.title.title-bar
1968 Generic title bar colors.
1969 ui.colors.color.title.title-bar.text <color|#rrggbb> (default: black)
1972 Default text color.
1973 ui.colors.color.title.title-bar.background <color|#rrggbb> (default:
1976 white)
1977 Default background color.
1978 ui.colors.color.title.title-text
1981 Title bar text colors.
1982 ui.colors.color.title.title-text.text <color|#rrggbb> (default: black)
1985 Default text color.
1986 ui.colors.color.title.title-text.background <color|#rrggbb> (default:
1989 white)
1990 Default background color.
1991 ui.colors.color.status
1994 Status bar colors.
1995 ui.colors.color.status.status-bar
1998 Generic status bar colors.
1999 ui.colors.color.status.status-bar.text <color|#rrggbb> (default: black)
2002 Default text color.
2003 ui.colors.color.status.status-bar.background <color|#rrggbb> (default:
2006 white)
2007 Default background color.
2008 ui.colors.color.status.status-text
2011 Status bar text colors.
2012 ui.colors.color.status.status-text.text <color|#rrggbb> (default:
2015 black)
2016 Default text color.
2017 ui.colors.color.status.status-text.background <color|#rrggbb> (default:
2020 white)
2021 Default background color.
2022 ui.colors.color.tabs
2025 Tabs bar colors.
2026 ui.colors.color.tabs.unvisited
2029 Tab colors for tabs that have not been selected since they com‐
2030 pleted loading.
2031 ui.colors.color.tabs.unvisited.text <color|#rrggbb> (default: darkblue)
2034 Default text color.
2035 ui.colors.color.tabs.unvisited.background <color|#rrggbb> (default:
2038 white)
2039 Default background color.
2040 ui.colors.color.tabs.normal
2043 Unselected tab colors.
2044 ui.colors.color.tabs.normal.text <color|#rrggbb> (default: black)
2047 Default text color.
2048 ui.colors.color.tabs.normal.background <color|#rrggbb> (default: white)
2051 Default background color.
2052 ui.colors.color.tabs.loading
2055 Tab colors for tabs that are loading in the background.
2056 ui.colors.color.tabs.loading.text <color|#rrggbb> (default: darkred)
2059 Default text color.
2060 ui.colors.color.tabs.loading.background <color|#rrggbb> (default:
2063 white)
2064 Default background color.
2065 ui.colors.color.tabs.selected
2068 Selected tab colors.
2069 ui.colors.color.tabs.selected.text <color|#rrggbb> (default: black)
2072 Default text color.
2073 ui.colors.color.tabs.selected.background <color|#rrggbb> (default:
2076 green)
2077 Default background color.
2078 ui.colors.color.tabs.separator
2081 Tab separator colors.
2082 ui.colors.color.tabs.separator.text <color|#rrggbb> (default: brown)
2085 Default text color.
2086 ui.colors.color.tabs.separator.background <color|#rrggbb> (default:
2089 white)
2090 Default background color.
2091 ui.colors.color.searched
2094 Searched string highlight colors.
2095 ui.colors.color.searched.text <color|#rrggbb> (default: black)
2098 Default text color.
2099 ui.colors.color.searched.background <color|#rrggbb> (default: lime)
2102 Default background color.
2103 ui.colors.mono
2106 Color settings for non-color terminal.
2107 ui.colors.mono.mainmenu
2110 Main menu bar colors.
2111 ui.colors.mono.mainmenu.normal
2114 Unselected main menu bar item colors.
2115 ui.colors.mono.mainmenu.normal.text <color|#rrggbb> (default: black)
2118 Default text color.
2119 ui.colors.mono.mainmenu.normal.background <color|#rrggbb> (default:
2122 white)
2123 Default background color.
2124 ui.colors.mono.mainmenu.selected
2127 Selected main menu bar item colors.
2128 ui.colors.mono.mainmenu.selected.text <color|#rrggbb> (default: gray)
2131 Default text color.
2132 ui.colors.mono.mainmenu.selected.background <color|#rrggbb> (default:
2135 black)
2136 Default background color.
2137 ui.colors.mono.mainmenu.hotkey
2140 Main menu hotkey colors.
2141 ui.colors.mono.mainmenu.hotkey.normal
2144 Main menu unselected hotkey colors.
2145 ui.colors.mono.mainmenu.hotkey.normal.text <color|#rrggbb> (default:
2148 black)
2149 Default text color.
2150 ui.colors.mono.mainmenu.hotkey.normal.background <color|#rrggbb>
2153 (default: white)
2154 Default background color.
2155 ui.colors.mono.mainmenu.hotkey.selected
2158 Main menu selected hotkey colors.
2159 ui.colors.mono.mainmenu.hotkey.selected.text <color|#rrggbb> (default:
2162 black)
2163 Default text color.
2164 ui.colors.mono.mainmenu.hotkey.selected.background <color|#rrggbb>
2167 (default: white)
2168 Default background color.
2169 ui.colors.mono.menu
2172 Menu bar colors.
2173 ui.colors.mono.menu.normal
2176 Unselected menu item colors.
2177 ui.colors.mono.menu.normal.text <color|#rrggbb> (default: black)
2180 Default text color.
2181 ui.colors.mono.menu.normal.background <color|#rrggbb> (default: white)
2184 Default background color.
2185 ui.colors.mono.menu.selected
2188 Selected menu item colors.
2189 ui.colors.mono.menu.selected.text <color|#rrggbb> (default: gray)
2192 Default text color.
2193 ui.colors.mono.menu.selected.background <color|#rrggbb> (default:
2196 black)
2197 Default background color.
2198 ui.colors.mono.menu.marked
2201 Marked menu item colors.
2202 ui.colors.mono.menu.marked.text <color|#rrggbb> (default: gray)
2205 Default text color.
2206 ui.colors.mono.menu.marked.background <color|#rrggbb> (default: white)
2209 Default background color.
2210 ui.colors.mono.menu.hotkey
2213 Menu item hotkey colors.
2214 ui.colors.mono.menu.hotkey.normal
2217 Menu item unselected hotkey colors.
2218 ui.colors.mono.menu.hotkey.normal.text <color|#rrggbb> (default: gray)
2221 Default text color.
2222 ui.colors.mono.menu.hotkey.normal.background <color|#rrggbb> (default:
2225 black)
2226 Default background color.
2227 ui.colors.mono.menu.hotkey.selected
2230 Menu item selected hotkey colors.
2231 ui.colors.mono.menu.hotkey.selected.text <color|#rrggbb> (default:
2234 gray)
2235 Default text color.
2236 ui.colors.mono.menu.hotkey.selected.background <color|#rrggbb>
2239 (default: black)
2240 Default background color.
2241 ui.colors.mono.menu.frame
2244 Menu frame colors.
2245 ui.colors.mono.menu.frame.text <color|#rrggbb> (default: black)
2248 Default text color.
2249 ui.colors.mono.menu.frame.background <color|#rrggbb> (default: white)
2252 Default background color.
2253 ui.colors.mono.dialog
2256 Dialog colors.
2257 ui.colors.mono.dialog.generic
2260 Generic dialog colors.
2261 ui.colors.mono.dialog.generic.text <color|#rrggbb> (default: black)
2264 Default text color.
2265 ui.colors.mono.dialog.generic.background <color|#rrggbb> (default:
2268 white)
2269 Default background color.
2270 ui.colors.mono.dialog.frame
2273 Dialog frame colors.
2274 ui.colors.mono.dialog.frame.text <color|#rrggbb> (default: black)
2277 Default text color.
2278 ui.colors.mono.dialog.frame.background <color|#rrggbb> (default: white)
2281 Default background color.
2282 ui.colors.mono.dialog.scrollbar
2285 Scrollbar colors.
2286 ui.colors.mono.dialog.scrollbar.text <color|#rrggbb> (default: white)
2289 Default text color.
2290 ui.colors.mono.dialog.scrollbar.background <color|#rrggbb> (default:
2293 black)
2294 Default background color.
2295 ui.colors.mono.dialog.scrollbar-selected
2298 Scrollbar selected colors.
2299 ui.colors.mono.dialog.scrollbar-selected.text <color|#rrggbb> (default:
2302 black)
2303 Default text color.
2304 ui.colors.mono.dialog.scrollbar-selected.background <color|#rrggbb>
2307 (default: white)
2308 Default background color.
2309 ui.colors.mono.dialog.title
2312 Dialog title colors.
2313 ui.colors.mono.dialog.title.text <color|#rrggbb> (default: gray)
2316 Default text color.
2317 ui.colors.mono.dialog.title.background <color|#rrggbb> (default: black)
2320 Default background color.
2321 ui.colors.mono.dialog.text
2324 Dialog text colors.
2325 ui.colors.mono.dialog.text.text <color|#rrggbb> (default: black)
2328 Default text color.
2329 ui.colors.mono.dialog.text.background <color|#rrggbb> (default: white)
2332 Default background color.
2333 ui.colors.mono.dialog.checkbox
2336 Dialog checkbox colors.
2337 ui.colors.mono.dialog.checkbox.text <color|#rrggbb> (default: black)
2340 Default text color.
2341 ui.colors.mono.dialog.checkbox.background <color|#rrggbb> (default:
2344 white)
2345 Default background color.
2346 ui.colors.mono.dialog.checkbox-selected
2349 Dialog selected checkbox colors.
2350 ui.colors.mono.dialog.checkbox-selected.text <color|#rrggbb> (default:
2353 white)
2354 Default text color.
2355 ui.colors.mono.dialog.checkbox-selected.background <color|#rrggbb>
2358 (default: black)
2359 Default background color.
2360 ui.colors.mono.dialog.checkbox-label
2363 Dialog checkbox label colors.
2364 ui.colors.mono.dialog.checkbox-label.text <color|#rrggbb> (default:
2367 black)
2368 Default text color.
2369 ui.colors.mono.dialog.checkbox-label.background <color|#rrggbb>
2372 (default: white)
2373 Default background color.
2374 ui.colors.mono.dialog.button
2377 Dialog button colors.
2378 ui.colors.mono.dialog.button.text <color|#rrggbb> (default: black)
2381 Default text color.
2382 ui.colors.mono.dialog.button.background <color|#rrggbb> (default:
2385 white)
2386 Default background color.
2387 ui.colors.mono.dialog.button-selected
2390 Dialog selected button colors.
2391 ui.colors.mono.dialog.button-selected.text <color|#rrggbb> (default:
2394 white)
2395 Default text color.
2396 ui.colors.mono.dialog.button-selected.background <color|#rrggbb>
2399 (default: black)
2400 Default background color.
2401 ui.colors.mono.dialog.button-shortcut
2404 Dialog button colors.
2405 ui.colors.mono.dialog.button-shortcut.text <color|#rrggbb> (default:
2408 white)
2409 Default text color.
2410 ui.colors.mono.dialog.button-shortcut.background <color|#rrggbb>
2413 (default: black)
2414 Default background color.
2415 ui.colors.mono.dialog.button-shortcut-selected
2418 Dialog selected button colors.
2419 ui.colors.mono.dialog.button-shortcut-selected.text <color|#rrggbb>
2422 (default: black)
2423 Default text color.
2424 ui.colors.mono.dialog.button-shortcut-selected.background
2427 <color|#rrggbb> (default: white)
2428 Default background color.
2429 ui.colors.mono.dialog.field
2432 Dialog text field colors.
2433 ui.colors.mono.dialog.field.text <color|#rrggbb> (default: gray)
2436 Default text color.
2437 ui.colors.mono.dialog.field.background <color|#rrggbb> (default: black)
2440 Default background color.
2441 ui.colors.mono.dialog.field-text
2444 Dialog field text colors.
2445 ui.colors.mono.dialog.field-text.text <color|#rrggbb> (default: gray)
2448 Default text color.
2449 ui.colors.mono.dialog.field-text.background <color|#rrggbb> (default:
2452 black)
2453 Default background color.
2454 ui.colors.mono.dialog.meter
2457 Dialog meter colors.
2458 ui.colors.mono.dialog.meter.text <color|#rrggbb> (default: gray)
2461 Default text color.
2462 ui.colors.mono.dialog.meter.background <color|#rrggbb> (default: black)
2465 Default background color.
2466 ui.colors.mono.dialog.shadow
2469 Dialog shadow colors (see ui.shadows option).
2470 ui.colors.mono.dialog.shadow.text <color|#rrggbb> (default: black)
2473 Default text color.
2474 ui.colors.mono.dialog.shadow.background <color|#rrggbb> (default:
2477 black)
2478 Default background color.
2479 ui.colors.mono.title
2482 Title bar colors.
2483 ui.colors.mono.title.title-bar
2486 Generic title bar colors.
2487 ui.colors.mono.title.title-bar.text <color|#rrggbb> (default: gray)
2490 Default text color.
2491 ui.colors.mono.title.title-bar.background <color|#rrggbb> (default:
2494 black)
2495 Default background color.
2496 ui.colors.mono.title.title-text
2499 Title bar text colors.
2500 ui.colors.mono.title.title-text.text <color|#rrggbb> (default: gray)
2503 Default text color.
2504 ui.colors.mono.title.title-text.background <color|#rrggbb> (default:
2507 black)
2508 Default background color.
2509 ui.colors.mono.status
2512 Status bar colors.
2513 ui.colors.mono.status.status-bar
2516 Generic status bar colors.
2517 ui.colors.mono.status.status-bar.text <color|#rrggbb> (default: black)
2520 Default text color.
2521 ui.colors.mono.status.status-bar.background <color|#rrggbb> (default:
2524 white)
2525 Default background color.
2526 ui.colors.mono.status.status-text
2529 Status bar text colors.
2530 ui.colors.mono.status.status-text.text <color|#rrggbb> (default: black)
2533 Default text color.
2534 ui.colors.mono.status.status-text.background <color|#rrggbb> (default:
2537 white)
2538 Default background color.
2539 ui.colors.mono.tabs
2542 Tabs bar colors.
2543 ui.colors.mono.tabs.unvisited
2546 Tab colors for tabs that have not been selected since they com‐
2547 pleted loading.
2548 ui.colors.mono.tabs.unvisited.text <color|#rrggbb> (default: gray)
2551 Default text color.
2552 ui.colors.mono.tabs.unvisited.background <color|#rrggbb> (default:
2555 white)
2556 Default background color.
2557 ui.colors.mono.tabs.normal
2560 Unselected tab colors.
2561 ui.colors.mono.tabs.normal.text <color|#rrggbb> (default: black)
2564 Default text color.
2565 ui.colors.mono.tabs.normal.background <color|#rrggbb> (default: white)
2568 Default background color.
2569 ui.colors.mono.tabs.loading
2572 Tab colors for tabs that are loading in the background.
2573 ui.colors.mono.tabs.loading.text <color|#rrggbb> (default: gray)
2576 Default text color.
2577 ui.colors.mono.tabs.loading.background <color|#rrggbb> (default: white)
2580 Default background color.
2581 ui.colors.mono.tabs.selected
2584 Selected tab colors.
2585 ui.colors.mono.tabs.selected.text <color|#rrggbb> (default: gray)
2588 Default text color.
2589 ui.colors.mono.tabs.selected.background <color|#rrggbb> (default:
2592 black)
2593 Default background color.
2594 ui.colors.mono.tabs.separator
2597 Tab separator colors.
2598 ui.colors.mono.tabs.separator.text <color|#rrggbb> (default: gray)
2601 Default text color.
2602 ui.colors.mono.tabs.separator.background <color|#rrggbb> (default:
2605 white)
2606 Default background color.
2607 ui.colors.mono.searched
2610 Searched string highlight colors.
2611 ui.colors.mono.searched.text <color|#rrggbb> (default: black)
2614 Default text color.
2615 ui.colors.mono.searched.background <color|#rrggbb> (default: white)
2618 Default background color.
2619 ui.dialogs
2622 Dialogs-specific appearance and behaviour settings.
2623 ui.dialogs.listbox_min_height <num> (default: 10)
2626 Minimal height of the listbox widget (used e.g. for bookmarks or
2627 global history).
2628 ui.dialogs.shadows [0|1] (default: 0)
2631 Make dialogs drop shadows (the shadows are solid, you can adjust
2632 their color by ui.colors.*.dialog.shadow). You may also want to
2633 eliminate the wide borders by adjusting setup.h.
2634 ui.dialogs.underline_hotkeys [0|1] (default: 0)
2637 Whether to underline hotkeys in menus to make them more visible.
2638 Requires the underlining is enabled for the terminal.
2639 ui.dialogs.underline_button_shortcuts [0|1] (default: 0)
2642 Whether to underline button shortcuts to make them more visible.
2643 Requires the underlining is enabled for the terminal.
2644 ui.leds
2647 LEDs (visual indicators) options.
2648 ui.leds.enable [0|1] (default: 1)
2651 Enable LEDs. These visual indicators will inform you about vari‐
2652 ous states.
2653 ui.sessions
2656 Sessions settings.
2657 ui.sessions.auto_restore [0|1] (default: 0)
2660 Automatically restore the session at start. This feature
2661 requires bookmark support.
2662 ui.sessions.auto_save [0|1] (default: 0)
2665 Automatically save the session when quitting. This feature
2666 requires bookmark support.
2667 ui.sessions.auto_save_foldername <str> (default: "Auto saved session")
2670 Name of the bookmarks folder used for auto saving and restoring
2671 session. The name has to be unique. Any folders with the same
2672 name will be deleted. This only makes sense with bookmark sup‐
2673 port.
2674 ui.sessions.homepage <str> (default: "")
2677 The URI to load either at startup time when no URI was given on
2678 the command line or when requested by the goto-url-home action.
2679 Set to "" if the environment variable WWW_'HOME' should be used
2680 as homepage URI instead.
2681 ui.sessions.keep_session_active [0|1] (default: 0)
2684 Keep the session active even if the last terminal exits.
2685 ui.sessions.snapshot [0|1] (default: 0)
2688 Automatically save a snapshot of all tabs periodically. This
2689 will periodically bookmark the tabs of each terminal in a sepa‐
2690 rate folder for recovery after a crash.
2691 ui.tabs
2694 Window tabs settings.
2695 ui.tabs.show_bar <num> (default: 1)
2698 Show tabs bar on the screen:
2699 · 0: means never
2702 · 1: means only if two or more tabs are open
2704 · 2: means always
2706 ui.tabs.wraparound [0|1] (default: 1)
2708 When moving right from the last tab, jump at the first one, and
2709 vice versa.
2710 ui.tabs.confirm_close [0|1] (default: 0)
2713 When closing a tab show confirmation dialog.
2714 ui.timer
2717 Timed action after certain interval of user inactivity. Someone
2718 can even find this useful, although you may not believe that.
2719 ui.timer.enable <num> (default: 0)
2722 Whether to enable the timer or not:
2723 · 0: is don't count down anything
2726 · 1: is count down, but don't show the timer
2728 · 2: is count down and show the timer near LEDs
2730 ui.timer.duration <num> (default: 86400)
2732 Inactivity timeout in seconds. The maximum of one day should be
2733 enough for just everyone ™.
2734 ui.timer.action <str> (default: "")
2737 Keybinding action to be triggered when timer reaches zero.
2738 ui.date_format <str> (default: "%b %e %H:%M")
2741 Date format to use in dialogs. See strftime(3).
2742 ui.language <language> (default: "System")
2745 Language of user interface. 'System' means that the language
2746 will be extracted from the environment dynamically.
2747 ui.show_status_bar [0|1] (default: 1)
2750 Show status bar on the screen.
2751 ui.show_title_bar [0|1] (default: 1)
2754 Show title bar on the screen.
2755 ui.startup_goto_dialog [0|1] (default: 1)
2758 Pop up goto dialog in newly created tabs when there's no home‐
2759 page set. This means also showing goto dialog on startup.
2760 ui.success_msgbox [0|1] (default: 1)
2763 When you pressed a [ Save ] button in some manager, this option
2764 will make sure that a box confirming success of the operation
2765 will pop up.
2766 ui.window_title [0|1] (default: 1)
2769 Set the window title when running in a windowing environment in
2770 an xterm-like terminal. This way the document's title is shown
2771 on the window titlebar.
2772 Generated using output from ELinks version 0.11.0.GIT.
2775
2778 elinks(1), elinkskeys(5)
27792006-01-29 ELinks configuration file ELINKS.CONF(5)