mirror of
https://github.com/rkd77/elinks.git
synced 2024-11-04 08:17:17 -05:00
2234 lines
74 KiB
Groff
2234 lines
74 KiB
Groff
|
.\" elinks.conf.5
|
||
|
.\"
|
||
|
.\" Generated by help2doc (Revision: 1.19) on 09 August 05 using output from ELinks version 0.11.CVS.
|
||
|
.\"
|
||
|
.\" Copyleft (c) 2002-2004 The ELinks project
|
||
|
.\"
|
||
|
.\" This file may be distributed under the terms of the GNU
|
||
|
.\" General Public License. <www.gnu.org/licenses/gpl.html>
|
||
|
.\"
|
||
|
.\" Process this file with groff -man -Tascii elinks.conf.5
|
||
|
.TH ELINKS.CONF 5 \"09 August 05\"
|
||
|
|
||
|
.SH NAME
|
||
|
elinks.conf \- ELinks configuration file
|
||
|
|
||
|
.SH DESCRIPTION
|
||
|
.PP
|
||
|
The
|
||
|
.B elinks.conf
|
||
|
file contains configuration information for ELinks. It can be used to configure
|
||
|
the behaviour of ELinks in a wide variety of ways: protocol behaviour,
|
||
|
keybindings, colors used for rendering and for the user interface.
|
||
|
.PP
|
||
|
It is read at startup and saved only when requested. All options described in
|
||
|
this document can be fully configured from within ELinks so no editing of
|
||
|
elinks.conf is needed.
|
||
|
.PP
|
||
|
Note that MIME-related options used for specifying handlers of various MIME
|
||
|
types are NOT described in this document. Documentation for these options can be
|
||
|
found at the ELinks homepage. Keybindings can also be specified in elinks.conf.
|
||
|
This is described in the elinkskeys(5) man page.
|
||
|
|
||
|
.SH SYNTAX
|
||
|
.PP
|
||
|
The syntax of the configuration file is very simple. The elinks.conf file is a
|
||
|
free-form ASCII text file. The file may contain extra tabs and newlines for
|
||
|
formatting purposes. Keywords in the file are case-sensitive. Comments may be
|
||
|
placed anywhere within the file (except within quotes). Comments begin with the
|
||
|
# character and end at the end of the line.
|
||
|
|
||
|
.SH EXAMPLES
|
||
|
.PP
|
||
|
Some sample settings:
|
||
|
.IP
|
||
|
.nf
|
||
|
# Use asynchronous DNS resolver?
|
||
|
set connection.async_dns = 1
|
||
|
# horizontal text margin.
|
||
|
set document.browse.margin_width = 3
|
||
|
# Default document codepage.
|
||
|
set document.codepage.assume = "ISO-8859-1"
|
||
|
# User defined protocol handlers
|
||
|
set protocol.user.mailto.unix = "mutt %h -s \"%s\""
|
||
|
|
||
|
.SH OPTIONS
|
||
|
.SS Bookmarks (bookmarks)
|
||
|
Bookmark options.
|
||
|
.TP
|
||
|
\f3bookmarks.file_format\f2 <num>\f1 (default: 0)
|
||
|
File format for bookmarks (affects both reading and saving):
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
is the default native ELinks format
|
||
|
.TP
|
||
|
.B 1
|
||
|
is XBEL universal XML bookmarks format (NO NATIONAL CHARS SUPPORT!)
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3bookmarks.folder_state\f2 [0|1]\f1 (default: 1)
|
||
|
When saving bookmarks also store whether folders are
|
||
|
expanded or not, so the look of the bookmark dialog is
|
||
|
kept across ELinks sessions. If disabled all folders will
|
||
|
appear unexpanded next time ELinks is run.
|
||
|
.SS Configuration system (config)
|
||
|
Configuration handling options.
|
||
|
.TP
|
||
|
\f3config.comments\f2 <num>\f1 (default: 3)
|
||
|
Amount of comments automatically written to the config file:
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
is no comments are written
|
||
|
.TP
|
||
|
.B 1
|
||
|
is only the "blurb" (name+type) is written
|
||
|
.TP
|
||
|
.B 2
|
||
|
is only the description is written
|
||
|
.TP
|
||
|
.B 3
|
||
|
is full comments are written
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3config.indentation\f2 <num>\f1 (default: 2)
|
||
|
Shift width of one indentation level in the configuration
|
||
|
file. Zero means that no indentation is performed at all
|
||
|
when saving the configuration.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3config.saving_style\f2 <num>\f1 (default: 3)
|
||
|
Determines what happens when you tell ELinks to save options:
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
is only values of current options are altered
|
||
|
.TP
|
||
|
.B 1
|
||
|
is values of current options are altered and missing options
|
||
|
are added at the end of the file
|
||
|
.TP
|
||
|
.B 2
|
||
|
is the configuration file is rewritten from scratch
|
||
|
.TP
|
||
|
.B 3
|
||
|
is values of current options are altered and missing options
|
||
|
CHANGED during this ELinks session are added at the end of
|
||
|
the file
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3config.i18n\f2 [0|1]\f1 (default: 0)
|
||
|
If set to 1, comments in the configuration file will be
|
||
|
translated to the language used by UI. Note that if you have
|
||
|
different language set in different terminals, the language
|
||
|
used in the configuration file MAY be the same as on the
|
||
|
terminal where you saved the file, but it should be generally
|
||
|
considered unpredictable.
|
||
|
.TP
|
||
|
\f3config.saving_style_w\f2 [0|1]\f1 (default: 0)
|
||
|
This is internal option used when displaying a warning about
|
||
|
obsolete config.saving_style. You shouldn't touch it.
|
||
|
.TP
|
||
|
\f3config.show_template\f2 [0|1]\f1 (default: 0)
|
||
|
Show template options in autocreated trees in the options
|
||
|
manager and save them to the configuration file.
|
||
|
.SS Connections (connection)
|
||
|
Connection options.
|
||
|
.SS SSL (connection.ssl)
|
||
|
SSL options.
|
||
|
.SS Client Certificates (connection.ssl.client_cert)
|
||
|
X509 client certificate options.
|
||
|
.TP
|
||
|
\f3connection.ssl.client_cert.enable\f2 [0|1]\f1 (default: 0)
|
||
|
Enable or not the sending of X509 client certificates
|
||
|
to servers which request them.
|
||
|
.TP
|
||
|
\f3connection.ssl.client_cert.file\f2 <str>\f1 (default: "")
|
||
|
The location of a file containing the client certificate
|
||
|
and unencrypted private key in PEM format. If unset, the
|
||
|
file pointed to by the X509_CLIENT_CERT variable is used
|
||
|
instead.
|
||
|
.TP
|
||
|
\f3connection.ssl.cert_verify\f2 [0|1]\f1 (default: 0)
|
||
|
Verify the peer's SSL certificate. Note that this
|
||
|
needs extensive configuration of OpenSSL by the user.
|
||
|
.TP
|
||
|
\f3connection.async_dns\f2 [0|1]\f1 (default: 1)
|
||
|
Whether to use asynchronous DNS resolving.
|
||
|
.TP
|
||
|
\f3connection.max_connections\f2 <num>\f1 (default: 10)
|
||
|
Maximum number of concurrent connections.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3connection.max_connections_to_host\f2 <num>\f1 (default: 2)
|
||
|
Maximum number of concurrent connections to a given host.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3connection.receive_timeout\f2 <num>\f1 (default: 120)
|
||
|
Receive timeout (in seconds).
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3connection.retries\f2 <num>\f1 (default: 3)
|
||
|
Number of tries to establish a connection.
|
||
|
Zero means try forever.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3connection.try_ipv4\f2 [0|1]\f1 (default: 1)
|
||
|
Whether to try to connect to a host over IPv4.
|
||
|
Note that if connection.try_ipv6 is enabled too,
|
||
|
it takes precedence. And better do not touch this
|
||
|
at all unless you are sure what are you doing.
|
||
|
Note that you can also force a given protocol
|
||
|
to be used on a per-connection basis by using an URL
|
||
|
in the style of i.e. http4://elinks.or.cz/.
|
||
|
.TP
|
||
|
\f3connection.try_ipv6\f2 [0|1]\f1 (default: 1)
|
||
|
Whether to try to connect to a host over IPv6.
|
||
|
Note that you can also force a given protocol
|
||
|
to be used on a per-connection basis by using an URL
|
||
|
in the style of i.e. http6://elinks.or.cz/.
|
||
|
.TP
|
||
|
\f3connection.unrestartable_receive_timeout\f2 <num>\f1 (default: 600)
|
||
|
Timeout for non-restartable connections (in seconds).
|
||
|
.PD
|
||
|
.RE
|
||
|
.SS Cookies (cookies)
|
||
|
Cookies options.
|
||
|
.TP
|
||
|
\f3cookies.accept_policy\f2 <num>\f1 (default: 2)
|
||
|
Cookies accepting policy:
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
is accept no cookies
|
||
|
.TP
|
||
|
.B 1
|
||
|
is ask for confirmation before accepting cookie
|
||
|
.TP
|
||
|
.B 2
|
||
|
is accept all cookies
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3cookies.max_age\f2 <num>\f1 (default: -1)
|
||
|
Cookie maximum age (in days):
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B -1
|
||
|
is use cookie's expiration date if any
|
||
|
.TP
|
||
|
.B 0
|
||
|
is force expiration at the end of session, ignoring cookie's
|
||
|
expiration date
|
||
|
.TP
|
||
|
.B 1
|
||
|
+ is use cookie's expiration date, but limit age to the given
|
||
|
number of days
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3cookies.paranoid_security\f2 [0|1]\f1 (default: 0)
|
||
|
When enabled, we'll require three dots in cookies domain for all
|
||
|
non-international domains (instead of just two dots). Some countries
|
||
|
have generic second level domains (eg. .com.pl, .co.uk) and allowing
|
||
|
sites to set cookies for these generic domains could potentially be
|
||
|
very bad. Note, it is off by default as it breaks a lot of sites.
|
||
|
.TP
|
||
|
\f3cookies.save\f2 [0|1]\f1 (default: 1)
|
||
|
Whether cookies should be loaded from and save to disk.
|
||
|
.TP
|
||
|
\f3cookies.resave\f2 [0|1]\f1 (default: 1)
|
||
|
Save cookies after each change in cookies list? No effect when
|
||
|
cookie saving (cookies.save) is off.
|
||
|
.SS Document (document)
|
||
|
Document options.
|
||
|
.SS Browsing (document.browse)
|
||
|
Document browsing options (mainly interactivity).
|
||
|
.SS Access keys (document.browse.accesskey)
|
||
|
Options for handling of link access keys.
|
||
|
An HTML document can use the ACCESSKEY attribute to assign
|
||
|
an access key to an element. When an access key is pressed,
|
||
|
the corresponding element will be given focus.
|
||
|
.TP
|
||
|
\f3document.browse.accesskey.auto_follow\f2 [0|1]\f1 (default: 0)
|
||
|
Automatically follow a link or submit a form if appropriate
|
||
|
accesskey is pressed - this is the standard behaviour, but it's
|
||
|
considered dangerous.
|
||
|
.TP
|
||
|
\f3document.browse.accesskey.display\f2 [0|1]\f1 (default: 0)
|
||
|
Display access key in link info.
|
||
|
.TP
|
||
|
\f3document.browse.accesskey.priority\f2 <num>\f1 (default: 0)
|
||
|
Priority of 'accesskey' HTML attribute:
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
is first try all normal bindings; if it fails, check accesskey
|
||
|
.TP
|
||
|
.B 1
|
||
|
is first try only frame bindings; if it fails, check accesskey
|
||
|
.TP
|
||
|
.B 2
|
||
|
is first check accesskey (this can be dangerous)
|
||
|
.PD
|
||
|
.RE
|
||
|
.SS Forms (document.browse.forms)
|
||
|
Options for handling of the forms interaction.
|
||
|
.TP
|
||
|
\f3document.browse.forms.auto_submit\f2 [0|1]\f1 (default: 1)
|
||
|
Automagically submit a form when enter is pressed with a text
|
||
|
field selected.
|
||
|
.TP
|
||
|
\f3document.browse.forms.confirm_submit\f2 [0|1]\f1 (default: 1)
|
||
|
Ask for confirmation when submitting a form.
|
||
|
.TP
|
||
|
\f3document.browse.forms.input_size\f2 <num>\f1 (default: 20)
|
||
|
Default form input size if none is specified.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3document.browse.forms.insert_mode\f2 [0|1]\f1 (default: 1)
|
||
|
The setting for this option affects how key presses are handled
|
||
|
when one selects a text-input form-field. When enabled, one must
|
||
|
explicitly 'enter' a selected text-field to edit it; this prevents
|
||
|
text fields from capturing key presses, such as presses of a scroll
|
||
|
key, when it is inadvertently selected. When disabled, key presses
|
||
|
are always inserted into a selected text field.
|
||
|
.TP
|
||
|
\f3document.browse.forms.editor\f2 <str>\f1 (default: "")
|
||
|
Path to the executable that ELinks should launch when the user
|
||
|
requests to edit a textarea with an external editor.
|
||
|
.TP
|
||
|
\f3variable\f2 $EDITOR.\f1 (variable $EDITOR. If $EDITOR is empty or not set, ELinks will then)
|
||
|
default to "vi".
|
||
|
.TP
|
||
|
\f3document.browse.forms.show_formhist\f2 [0|1]\f1 (default: 0)
|
||
|
Ask if a login form should be saved to file or not.
|
||
|
This option only disables the dialog, already saved login
|
||
|
forms are unaffected.
|
||
|
.SS Images (document.browse.images)
|
||
|
Options for handling of images.
|
||
|
.TP
|
||
|
\f3document.browse.images.display_style\f2 <num>\f1 (default: 2)
|
||
|
Display style for image tags when displayed:
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
means always display IMG
|
||
|
.TP
|
||
|
.B 1
|
||
|
means always display filename
|
||
|
.TP
|
||
|
.B 2
|
||
|
means display alt/title attribute if possible, IMG if not
|
||
|
.TP
|
||
|
.B 3
|
||
|
means display alt/title attribute if possible, filename if not
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3document.browse.images.filename_maxlen\f2 <num>\f1 (default: 0)
|
||
|
Maximum length of image filename when displayed:
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
means always display full filename
|
||
|
.TP
|
||
|
.B 1-500
|
||
|
means display filename with this maximal length;
|
||
|
if it is longer, the middle is substituted by an asterisk
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3document.browse.images.image_link_tagging\f2 <num>\f1 (default: 1)
|
||
|
When to enclose image links:
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
means never
|
||
|
.TP
|
||
|
.B 1
|
||
|
means never if alt or title are provided (old behavior)
|
||
|
.TP
|
||
|
.B 2
|
||
|
means always
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3document.browse.images.image_link_prefix\f2 <str>\f1 (default: "[")
|
||
|
Prefix string to use to mark image links.
|
||
|
.TP
|
||
|
\f3document.browse.images.image_link_suffix\f2 <str>\f1 (default: "]")
|
||
|
Suffix string to use to mark image links.
|
||
|
.TP
|
||
|
\f3document.browse.images.label_maxlen\f2 <num>\f1 (default: 0)
|
||
|
Maximum length of image label (alt/title):
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
means always display full label
|
||
|
.TP
|
||
|
.B 1-500
|
||
|
means display label with this maximal length;
|
||
|
if it is longer, the middle is substituted by an asterisk
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3document.browse.images.show_as_links\f2 [0|1]\f1 (default: 0)
|
||
|
Display links to images without an alt attribute. If this option
|
||
|
is off, these images are completely invisible.
|
||
|
.TP
|
||
|
\f3document.browse.images.show_any_as_links\f2 [0|1]\f1 (default: 1)
|
||
|
Display links to any images in the document, regardless of them
|
||
|
having an alt attribute or not. If this option is off, the alt
|
||
|
attribute contents is shown, but as normal text, not selectable
|
||
|
as a link.
|
||
|
.SS Links (document.browse.links)
|
||
|
Options for handling of links to other documents.
|
||
|
.SS Active link (document.browse.links.active_link)
|
||
|
Options for the active link.
|
||
|
.SS Colors (document.browse.links.active_link.colors)
|
||
|
Active link colors.
|
||
|
.TP
|
||
|
\f3document.browse.links.active_link.colors.background\f2 <color|#rrggbb>\f1 (default: blue)
|
||
|
Default background color.
|
||
|
.TP
|
||
|
\f3document.browse.links.active_link.colors.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3document.browse.links.active_link.enable_color\f2 [0|1]\f1 (default: 0)
|
||
|
Enable use of the active link background and text color
|
||
|
settings instead of the link colors from the document.
|
||
|
.TP
|
||
|
\f3document.browse.links.active_link.bold\f2 [0|1]\f1 (default: 0)
|
||
|
Make the active link text bold.
|
||
|
.TP
|
||
|
\f3document.browse.links.active_link.invert\f2 [0|1]\f1 (default: 1)
|
||
|
Invert the fore- and background color so the link stands out.
|
||
|
.TP
|
||
|
\f3document.browse.links.active_link.underline\f2 [0|1]\f1 (default: 0)
|
||
|
Underline the active link.
|
||
|
.TP
|
||
|
\f3document.browse.links.color_dirs\f2 [0|1]\f1 (default: 1)
|
||
|
Highlight links to directories in FTP and local directory listing.
|
||
|
.TP
|
||
|
\f3document.browse.links.numbering\f2 [0|1]\f1 (default: 0)
|
||
|
Display numbers next to the links.
|
||
|
.TP
|
||
|
\f3document.browse.links.target_blank\f2 <num>\f1 (default: 0)
|
||
|
Define how to handle links having target=_blank set:
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
means open link in current tab
|
||
|
.TP
|
||
|
.B 1
|
||
|
means open link in new tab in foreground
|
||
|
.TP
|
||
|
.B 2
|
||
|
means open link in new tab in background
|
||
|
.TP
|
||
|
.B 3
|
||
|
means open link in new window
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3document.browse.links.use_tabindex\f2 [0|1]\f1 (default: 1)
|
||
|
Whether to navigate links using tabindex specified ordering.
|
||
|
The TABINDEX attribute in HTML elements specifies the order
|
||
|
in which links should receive focus when using the keyboard
|
||
|
to navigating the document.
|
||
|
.TP
|
||
|
\f3document.browse.links.number_keys_select_link\f2 <num>\f1 (default: 1)
|
||
|
Number keys select links rather than specify command prefixes. This
|
||
|
is a tristate:
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
means never
|
||
|
.TP
|
||
|
.B 1
|
||
|
means if document.browse.links.numbering = 1
|
||
|
.TP
|
||
|
.B 2
|
||
|
means always
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3document.browse.links.warn_malicious\f2 [0|1]\f1 (default: 1)
|
||
|
When following a link the user ID part of the URI is
|
||
|
checked and if a maliciously crafted URI is detected a
|
||
|
warning dialog will ask before following the link.
|
||
|
.TP
|
||
|
\f3document.browse.links.wraparound\f2 [0|1]\f1 (default: 0)
|
||
|
When pressing 'down' on the last link, jump at the first one, and
|
||
|
vice versa.
|
||
|
.SS Scrolling (document.browse.scrolling)
|
||
|
Scrolling options.
|
||
|
.TP
|
||
|
\f3document.browse.scrolling.horizontal_extended\f2 [0|1]\f1 (default: 1)
|
||
|
Whether to allow horizontal scrolling when the document
|
||
|
does not extend off the screen. Useful for copy/paste
|
||
|
operations.
|
||
|
.TP
|
||
|
\f3document.browse.scrolling.horizontal_step\f2 <num>\f1 (default: 8)
|
||
|
Number of columns to scroll when a key bound to scroll-left or scroll-
|
||
|
right is pressed and no prefix was given.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3document.browse.scrolling.margin\f2 <num>\f1 (default: 3)
|
||
|
Size of the virtual margin - when you click inside of that margin,
|
||
|
document scrolls in that direction.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3document.browse.scrolling.vertical_step\f2 <num>\f1 (default: 2)
|
||
|
Number of lines to scroll when a key bound to scroll-up or scroll-
|
||
|
down is pressed and no prefix was given.
|
||
|
.PD
|
||
|
.RE
|
||
|
.SS Searching (document.browse.search)
|
||
|
Options for searching.
|
||
|
.TP
|
||
|
\f3document.browse.search.case\f2 [0|1]\f1 (default: 0)
|
||
|
Whether the search should match the document text while maintaining
|
||
|
case sensitivity.
|
||
|
.TP
|
||
|
\f3document.browse.search.regex\f2 <num>\f1 (default: 0)
|
||
|
Enable searching with regular expressions:
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
for plain text searching
|
||
|
.TP
|
||
|
.B 1
|
||
|
for basic regular expression searches
|
||
|
.TP
|
||
|
.B 2
|
||
|
for extended regular expression searches
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3document.browse.search.show_hit_top_bottom\f2 [0|1]\f1 (default: 1)
|
||
|
Whether to show a dialog when the search hits top or bottom of the
|
||
|
document.
|
||
|
.TP
|
||
|
\f3document.browse.search.wraparound\f2 [0|1]\f1 (default: 1)
|
||
|
Wrap around when searching. Currently only used for typeahead.
|
||
|
.TP
|
||
|
\f3document.browse.search.show_not_found\f2 <num>\f1 (default: 2)
|
||
|
How to inform the user when nothing is matched:
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
means do nothing
|
||
|
.TP
|
||
|
.B 1
|
||
|
means beep the terminal
|
||
|
.TP
|
||
|
.B 2
|
||
|
means pop up message box
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3document.browse.search.typeahead\f2 <num>\f1 (default: 0)
|
||
|
Start typeahead searching when an unbound key is pressed without
|
||
|
any modifiers. Note that most keys have default bindings, so this
|
||
|
feature will not be useful unless you unbind them.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3when\f2 you\f1 (when you press a key bound to search-typeahead or similar)
|
||
|
1 automatically starts typeahead searching thru link text
|
||
|
2 automatically starts typeahead searching thru all document text
|
||
|
.TP
|
||
|
\f3document.browse.margin_width\f2 <num>\f1 (default: 3)
|
||
|
Horizontal text margin.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3document.browse.refresh\f2 [0|1]\f1 (default: 1)
|
||
|
Automatically follow document-specified refresh directives ('<meta>
|
||
|
refresh' tags). Web-page authors use these to instruct the browser
|
||
|
to reload a document at a given interval or to load another page.
|
||
|
Regardless of the value the refresh URI is accessible as a link.
|
||
|
Use the document.browse.minimum_refresh_time to control the minimum
|
||
|
number of seconds a refresh will wait.
|
||
|
.TP
|
||
|
\f3document.browse.minimum_refresh_time\f2 <num>\f1 (default: 1000)
|
||
|
The minimum number of milliseconds that should pass before
|
||
|
refreshing. If set to zero the document refresh time is used
|
||
|
unchanged. It can fix going back in history for some sites that
|
||
|
use refreshing with zero values.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3document.browse.table_move_order\f2 [0|1]\f1 (default: 0)
|
||
|
Move by columns in table, instead of rows.
|
||
|
.SS Cache (document.cache)
|
||
|
Cache options.
|
||
|
.SS Formatted documents (document.cache.format)
|
||
|
Format cache options.
|
||
|
.TP
|
||
|
\f3document.cache.format.size\f2 <num>\f1 (default: 5)
|
||
|
Number of cached formatted pages. Do not get too generous
|
||
|
here, 'formatted' means that all the accompanying structures
|
||
|
are kept in memory so that you get the cached document
|
||
|
immediatelly, but these structures may take a lot - 2x the
|
||
|
size of the HTML source is probably not unusual, but it can
|
||
|
be even more if the document consists of a lot of short lines
|
||
|
(padded right, if possible) and links and not much other markup.
|
||
|
So if you set this to 256 and then you don't like your ELinks
|
||
|
eating 90M, don't come complaining to us. ;-)
|
||
|
Also note that the format cache itself is not counted to the
|
||
|
memory cache size, but the HTML source of the formatted documents
|
||
|
is always cached, even if it is over the memory cache size
|
||
|
threshold. (Then of course no other documents can be cached.)
|
||
|
.PD
|
||
|
.RE
|
||
|
.SS Memory cache (document.cache.memory)
|
||
|
Memory cache options.
|
||
|
.TP
|
||
|
\f3document.cache.memory.size\f2 <num>\f1 (default: 1048576)
|
||
|
Memory cache size (in bytes).
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3document.cache.cache_redirects\f2 [0|1]\f1 (default: 0)
|
||
|
Cache even redirects sent by server (usually thru HTTP by a 302
|
||
|
HTTP code and a Location header). This was the original behaviour
|
||
|
for a quite some time, but it causes problems in a situation very
|
||
|
common to various web login systems - frequently, when accessing
|
||
|
certain location, they will redirect you to a login page if they
|
||
|
don't receive an auth cookie, the login page then gives you the
|
||
|
cookie and redirects you back to the original page, but there you
|
||
|
have already cached redirect back to the login page! If this
|
||
|
option has value of 0, this malfunction is fixed, but occasionally
|
||
|
you may get superfluous (depends on how you take it ;-) requests to
|
||
|
the server. If this option has value of 1, experienced users can
|
||
|
still workaround it by clever combination of usage of reload,
|
||
|
jumping around in session history and hitting ctrl+enter.
|
||
|
Note that this option is checked when retrieving the information
|
||
|
from cache, not when saving it to cache - thus if you will enable
|
||
|
it, even previous redirects will be taken from cache instead of
|
||
|
asking the server.
|
||
|
.TP
|
||
|
\f3document.cache.ignore_cache_control\f2 [0|1]\f1 (default: 1)
|
||
|
Ignore Cache-Control and Pragma server headers.
|
||
|
When set, the document is cached even with 'Cache-Control: no-cache'.
|
||
|
.SS Charset (document.codepage)
|
||
|
Charset options.
|
||
|
.TP
|
||
|
\f3document.codepage.assume\f2 <codepage>\f1 (default: System)
|
||
|
Default document codepage. 'System' stands for
|
||
|
a codepage determined by a selected locale.
|
||
|
.TP
|
||
|
\f3document.codepage.force_assumed\f2 [0|1]\f1 (default: 0)
|
||
|
Ignore charset info sent by server.
|
||
|
.SS Default color settings (document.colors)
|
||
|
Default document color settings.
|
||
|
.TP
|
||
|
\f3document.colors.text\f2 <color|#rrggbb>\f1 (default: gray75)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3document.colors.background\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default background color.
|
||
|
.TP
|
||
|
\f3document.colors.link\f2 <color|#rrggbb>\f1 (default: blue)
|
||
|
Default link color.
|
||
|
.TP
|
||
|
\f3document.colors.vlink\f2 <color|#rrggbb>\f1 (default: yellow)
|
||
|
Default visited link color.
|
||
|
.TP
|
||
|
\f3document.colors.image\f2 <color|#rrggbb>\f1 (default: darkolivegreen)
|
||
|
Default image link color.
|
||
|
.TP
|
||
|
\f3document.colors.bookmark\f2 <color|#rrggbb>\f1 (default: hotpink)
|
||
|
Default bookmarked link color.
|
||
|
.TP
|
||
|
\f3document.colors.dirs\f2 <color|#rrggbb>\f1 (default: yellow)
|
||
|
Default directory color.
|
||
|
See document.browse.links.color_dirs option.
|
||
|
.TP
|
||
|
\f3document.colors.increase_contrast\f2 [0|1]\f1 (default: 1)
|
||
|
Setting this option to 0 will increase the contrast
|
||
|
between the foreground and background colors to ensure
|
||
|
readability. For example it disallows dark colors on a
|
||
|
black background. Note, this is different from ensuring
|
||
|
the contrast with the ensure_contrast option.
|
||
|
.TP
|
||
|
\f3document.colors.ensure_contrast\f2 [0|1]\f1 (default: 1)
|
||
|
Makes sure that the back- and foreground color are never equal.
|
||
|
.TP
|
||
|
\f3document.colors.use_document_colors\f2 <num>\f1 (default: 2)
|
||
|
Use colors specified in document:
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
is use always the default settings
|
||
|
.TP
|
||
|
.B 1
|
||
|
is use document colors if available, except background
|
||
|
.TP
|
||
|
.B 2
|
||
|
is use document colors, including background. This can
|
||
|
mostly look very impressive, but some sites will appear
|
||
|
really ugly. Note, that obviously if the background is
|
||
|
not black, it will break the behaviour of transparency.
|
||
|
.PD
|
||
|
.RE
|
||
|
.SS Cascading Style Sheets (document.css)
|
||
|
Options concerning how to use CSS for styling documents.
|
||
|
.TP
|
||
|
\f3document.css.enable\f2 [0|1]\f1 (default: 1)
|
||
|
Enable adding of CSS style info to documents.
|
||
|
.TP
|
||
|
\f3document.css.import\f2 [0|1]\f1 (default: 1)
|
||
|
When enabled any external style sheets that are imported from
|
||
|
either CSS itself using the @import keyword or from the HTML using
|
||
|
<link> tags in the document header will also be downloaded.
|
||
|
.TP
|
||
|
\f3document.css.stylesheet\f2 <str>\f1 (default: "")
|
||
|
The path to the file containing the default user defined
|
||
|
Cascading Style Sheet. It can be used to control the basic
|
||
|
layout of HTML documents. The path is assumed to be relative
|
||
|
to ELinks' home directory.
|
||
|
Leave as "" to use built-in document styling.
|
||
|
.SS Downloading (document.download)
|
||
|
Options regarding files downloading and handling.
|
||
|
.TP
|
||
|
\f3document.download.directory\f2 <str>\f1 (default: "./")
|
||
|
Default download directory.
|
||
|
.TP
|
||
|
\f3document.download.set_original_time\f2 [0|1]\f1 (default: 0)
|
||
|
Set the timestamp of each downloaded file to the timestamp
|
||
|
stored on the server.
|
||
|
.TP
|
||
|
\f3document.download.overwrite\f2 <num>\f1 (default: 2)
|
||
|
Prevent overwriting the local files:
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
is files will silently be overwritten
|
||
|
.TP
|
||
|
.B 1
|
||
|
is add a suffix .{number} (for example '.1') to the name
|
||
|
.TP
|
||
|
.B 2
|
||
|
is ask the user
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3document.download.notify_bell\f2 <num>\f1 (default: 0)
|
||
|
Audio notification when download is completed:
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
is never
|
||
|
.TP
|
||
|
.B 1
|
||
|
is when background notification is active
|
||
|
.TP
|
||
|
.B 2
|
||
|
is always
|
||
|
.PD
|
||
|
.RE
|
||
|
.SS Dump output (document.dump)
|
||
|
Dump output options.
|
||
|
.TP
|
||
|
\f3document.dump.codepage\f2 <codepage>\f1 (default: System)
|
||
|
Codepage used in dump output. 'System' stands for
|
||
|
a codepage determined by a selected locale.
|
||
|
.TP
|
||
|
\f3document.dump.footer\f2 <str>\f1 (default: "")
|
||
|
Footer string used in dumps. %u is substituted by URL.
|
||
|
.TP
|
||
|
\f3document.dump.header\f2 <str>\f1 (default: "")
|
||
|
Header string used in dumps. %u is substituted by URL.
|
||
|
.TP
|
||
|
\f3document.dump.numbering\f2 [0|1]\f1 (default: 1)
|
||
|
Whether to print link numbers in dump output.
|
||
|
.TP
|
||
|
\f3document.dump.references\f2 [0|1]\f1 (default: 1)
|
||
|
Whether to print references (URIs) of document links
|
||
|
in dump output.
|
||
|
.TP
|
||
|
\f3document.dump.separator\f2 <str>\f1 (document.dump.separator <str> (default: ")
|
||
|
.TP
|
||
|
\f3document.dump.width\f2 <num>\f1 (default: 80)
|
||
|
Width of screen in characters when dumping documents.
|
||
|
.PD
|
||
|
.RE
|
||
|
.SS History (document.history)
|
||
|
History options.
|
||
|
.SS Global history (document.history.global)
|
||
|
Global history options.
|
||
|
.TP
|
||
|
\f3document.history.global.enable\f2 [0|1]\f1 (default: 1)
|
||
|
Enable global history ("history of all pages visited").
|
||
|
.TP
|
||
|
\f3document.history.global.max_items\f2 <num>\f1 (default: 1024)
|
||
|
Maximum number of entries in the global history.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3document.history.global.display_type\f2 <num>\f1 (default: 0)
|
||
|
What to display in global history dialog:
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
is URLs
|
||
|
.TP
|
||
|
.B 1
|
||
|
is page titles
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3document.history.keep_unhistory\f2 [0|1]\f1 (default: 1)
|
||
|
Keep unhistory ("forward history").
|
||
|
.SS HTML rendering (document.html)
|
||
|
Options concerning the display of HTML pages.
|
||
|
.TP
|
||
|
\f3document.html.display_frames\f2 [0|1]\f1 (default: 1)
|
||
|
Display frames.
|
||
|
.TP
|
||
|
\f3document.html.display_tables\f2 [0|1]\f1 (default: 1)
|
||
|
Display tables.
|
||
|
.TP
|
||
|
\f3document.html.display_subs\f2 [0|1]\f1 (default: 1)
|
||
|
Display subscripts (as [thing]).
|
||
|
.TP
|
||
|
\f3document.html.display_sups\f2 [0|1]\f1 (default: 1)
|
||
|
Display superscripts (as ^thing).
|
||
|
.TP
|
||
|
\f3document.html.link_display\f2 <num>\f1 (default: 2)
|
||
|
How to render <link> tags from the HTML header:
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
is nothing
|
||
|
.TP
|
||
|
.B 1
|
||
|
is title
|
||
|
.TP
|
||
|
.B 2
|
||
|
is name in addition
|
||
|
.TP
|
||
|
.B 3
|
||
|
is hreflang in addition
|
||
|
.TP
|
||
|
.B 4
|
||
|
is type in addition
|
||
|
.TP
|
||
|
.B 5
|
||
|
is everything
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3document.html.underline_links\f2 [0|1]\f1 (default: 0)
|
||
|
Underline links.
|
||
|
.TP
|
||
|
\f3document.html.wrap_nbsp\f2 [0|1]\f1 (default: 0)
|
||
|
If set do not honour non breaking space (the nbsp entity)
|
||
|
but allow to wrap the text. This can help keeping the width
|
||
|
of documents down so no horizontal scrolling is needed.
|
||
|
.SS Plain rendering (document.plain)
|
||
|
Options concerning the display of plain text pages.
|
||
|
.TP
|
||
|
\f3document.plain.display_links\f2 [0|1]\f1 (default: 0)
|
||
|
Display URIs in the document as links.
|
||
|
.TP
|
||
|
\f3document.plain.compress_empty_lines\f2 [0|1]\f1 (default: 0)
|
||
|
Compress successive empty lines to only one in displayed text.
|
||
|
.SS URI passing (document.uri_passing)
|
||
|
Rules for passing URIs to external commands.
|
||
|
.TP
|
||
|
\f3document.uri_passing._template_\f2 <str>\f1 (default: "")
|
||
|
A rule for passing URI to an external command.
|
||
|
The format is:
|
||
|
%c in the string means the current URL
|
||
|
%% in the string means '%'
|
||
|
.SS ECMAScript (ecmascript)
|
||
|
ECMAScript options.
|
||
|
.TP
|
||
|
\f3ecmascript.enable\f2 [0|1]\f1 (default: 1)
|
||
|
Whether to run those scripts inside of documents.
|
||
|
.TP
|
||
|
\f3ecmascript.error_reporting\f2 [0|1]\f1 (default: 0)
|
||
|
Open a message box when a script reports an error.
|
||
|
.TP
|
||
|
\f3ecmascript.max_exec_time\f2 <num>\f1 (default: 5)
|
||
|
Maximum execution time in seconds for a script.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3ecmascript.block_window_opening\f2 [0|1]\f1 (default: 0)
|
||
|
Whether to disallow scripts to open new windows or tabs.
|
||
|
.SS Information files (infofiles)
|
||
|
Options for information files in ~/.elinks.
|
||
|
.TP
|
||
|
\f3infofiles.save_interval\f2 <num>\f1 (default: 300)
|
||
|
Interval at which to trigger information files in ~/.elinks
|
||
|
to be saved to disk if they has changed (seconds; 0 to disable)
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3infofiles.secure_save\f2 [0|1]\f1 (default: 1)
|
||
|
First write data to unique temporary file, then rename this file
|
||
|
upon successfully finishing this. Note that this relates only to
|
||
|
config files, not downloaded files. You may want to disable
|
||
|
it if you are using some exotic permissions for concerned files.
|
||
|
Secure file saving is automagically disabled if file is symlink.
|
||
|
Warning: some systems (ie. OS/2, Win32) require that destination
|
||
|
file doesn't exist when rename(3) is called, breaking atomicity,
|
||
|
and reducing reliability of this feature.
|
||
|
.TP
|
||
|
\f3infofiles.secure_save_fsync\f2 [0|1]\f1 (default: 1)
|
||
|
When using secure file saving, call fsync(3), if the OS
|
||
|
supports it, to force the OS immediately to write the data
|
||
|
to permanent storage. This is optional for those who wish
|
||
|
to avoid excessive disk I/O.
|
||
|
.SS MIME (mime)
|
||
|
MIME-related options (handlers of various MIME types).
|
||
|
.SS File extension associations (mime.extension)
|
||
|
Extension <-> MIME type association.
|
||
|
.TP
|
||
|
\f3mime.extension._template_\f2 <str>\f1 (default: "")
|
||
|
MIME-type matching this file extension ('*' is used here in place
|
||
|
of '.').
|
||
|
.SS File type handlers (mime.handler)
|
||
|
A file type handler is a set of information about how to use
|
||
|
an external program to view a file. It is possible to refer to it
|
||
|
for several MIME types -- e.g., you can define an 'image' handler
|
||
|
to which mime.type.image.png, mime.type.image.jpeg, and so on will
|
||
|
refer; or one might define a handler for a more specific type of file
|
||
|
-- e.g., PDF files.
|
||
|
Note you must define both a MIME handler and a MIME type association
|
||
|
for it to work.
|
||
|
.SS Template option folder (mime.handler._template_)
|
||
|
Description of this handler.
|
||
|
.SS Template option folder (mime.handler._template_._template_)
|
||
|
System-specific handler description (ie. unix, unix-xwin, ...).
|
||
|
.TP
|
||
|
\f3mime.handler._template_._template_.ask\f2 [0|1]\f1 (default: 1)
|
||
|
Ask before opening.
|
||
|
.TP
|
||
|
\f3mime.handler._template_._template_.block\f2 [0|1]\f1 (default: 1)
|
||
|
Block the terminal when the handler is running.
|
||
|
.TP
|
||
|
\f3mime.handler._template_._template_.program\f2 <str>\f1 (default: "")
|
||
|
External viewer for this file type. '%' in this string will be
|
||
|
substituted by a file name.
|
||
|
.SS Mailcap (mime.mailcap)
|
||
|
Options for mailcap support.
|
||
|
.TP
|
||
|
\f3mime.mailcap.enable\f2 [0|1]\f1 (default: 1)
|
||
|
Enable mailcap support.
|
||
|
.TP
|
||
|
\f3mime.mailcap.path\f2 <str>\f1 (default: "~/.mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap:/usr/share/mailcap:/usr/share/misc/mailcap")
|
||
|
Mailcap search path. Colon-separated list of files.
|
||
|
Leave as "" to use MAILCAP environment variable instead.
|
||
|
.TP
|
||
|
\f3mime.mailcap.ask\f2 [0|1]\f1 (default: 1)
|
||
|
Ask before using the handlers defined by mailcap.
|
||
|
.TP
|
||
|
\f3mime.mailcap.description\f2 <num>\f1 (default: 0)
|
||
|
Type of description to show in "what to do with this file"
|
||
|
query dialog:
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
is show "mailcap"
|
||
|
.TP
|
||
|
.B 1
|
||
|
is show program to be run
|
||
|
.TP
|
||
|
.B 2
|
||
|
is show mailcap description field if any; "mailcap" otherwise
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3mime.mailcap.prioritize\f2 [0|1]\f1 (default: 1)
|
||
|
Prioritize entries by the order of the files in the mailcap
|
||
|
path. This means that wildcard entries (like: image/*) will
|
||
|
also be checked before deciding the handler.
|
||
|
.SS Mimetypes files (mime.mimetypes)
|
||
|
Options for the support of mime.types files. These files
|
||
|
can be used to find the content type of an URL by looking at
|
||
|
the extension of the file name.
|
||
|
.TP
|
||
|
\f3mime.mimetypes.enable\f2 [0|1]\f1 (default: 1)
|
||
|
Enable mime.types support.
|
||
|
.TP
|
||
|
\f3mime.mimetypes.path\f2 <str>\f1 (default: "~/.mime.types:/etc/mime.types:/usr/etc/mime.types:/usr/local/etc/mime.types:/usr/share/mime.types:/usr/share/misc/mime.types")
|
||
|
The search path for mime.types files. Colon-separated list of files.
|
||
|
.SS MIME type associations (mime.type)
|
||
|
Handler <-> MIME type association. The first sub-tree is the MIME
|
||
|
class while the second sub-tree is the MIME type (ie. image/gif
|
||
|
handler will reside at mime.type.image.gif). Each MIME type option
|
||
|
should contain (case-sensitive) name of the MIME handler (its
|
||
|
properties are stored at mime.handler.<name>).
|
||
|
.SS Template option folder (mime.type._template_)
|
||
|
Handler matching this MIME-type class ('*' is used here in place
|
||
|
of '.').
|
||
|
.TP
|
||
|
\f3mime.type._template_._template_\f2 <str>\f1 (default: "")
|
||
|
Handler matching this MIME-type name ('*' is used here in place
|
||
|
of '.').
|
||
|
.TP
|
||
|
\f3mime.default_type\f2 <str>\f1 (default: "application/octet-stream")
|
||
|
Document MIME-type to assume by default (when we are unable to
|
||
|
guess it properly from known information about the document).
|
||
|
.SS Protocols (protocol)
|
||
|
Protocol specific options.
|
||
|
.SS BitTorrent (protocol.bittorrent)
|
||
|
BitTorrent specific options.
|
||
|
.SS Port range (protocol.bittorrent.ports)
|
||
|
Port range allowed to be used for listening on.
|
||
|
.TP
|
||
|
\f3protocol.bittorrent.ports.min\f2 <num>\f1 (default: 6881)
|
||
|
The minimum port to try and listen on.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3protocol.bittorrent.ports.max\f2 <num>\f1 (default: 6999)
|
||
|
The maximum port to try and listen on.
|
||
|
.PD
|
||
|
.RE
|
||
|
.SS Tracker (protocol.bittorrent.tracker)
|
||
|
Tracker options.
|
||
|
.TP
|
||
|
\f3protocol.bittorrent.tracker.compact\f2 [0|1]\f1 (default: 0)
|
||
|
Whether to request that the tracker returns peer info
|
||
|
in compact format. Note, the compact format only supports
|
||
|
IPv4 addresses.
|
||
|
.TP
|
||
|
\f3protocol.bittorrent.tracker.interval\f2 <num>\f1 (default: 0)
|
||
|
The number of seconds to wait between periodically contacting
|
||
|
the tracker for announcing progress and requesting more peers.
|
||
|
Set to zero to use the interval requested by the tracker.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3protocol.bittorrent.tracker.ip_address\f2 <str>\f1 (default: "")
|
||
|
What IP address to report to the tracker. If set to ""
|
||
|
no IP address will be sent and the tracker will automatically
|
||
|
determine an appropriate IP address.
|
||
|
.TP
|
||
|
\f3protocol.bittorrent.tracker.numwant\f2 <num>\f1 (default: 50)
|
||
|
The maximum number of peers to request from the tracker.
|
||
|
Set to 0 to use the server default.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3protocol.bittorrent.tracker.min_skip_size\f2 <num>\f1 (default: 20)
|
||
|
The minimum number of peers to have in the current peer info
|
||
|
pool before skipping requesting of more peers. I.e. setting
|
||
|
numwant to zero.
|
||
|
Set to 0 to not have any limit.
|
||
|
.PD
|
||
|
.RE
|
||
|
.SS Peer-wire (protocol.bittorrent.peerwire)
|
||
|
Lowlevel peer-wire options.
|
||
|
.TP
|
||
|
\f3protocol.bittorrent.peerwire.connections\f2 <num>\f1 (default: 55)
|
||
|
The maximum number of allowed connections to both active and
|
||
|
non-active peers. By increasing the number of allowed connections,
|
||
|
the chance of finding good peers to download from is increased.
|
||
|
However, too many connections can lead to TCP congestion. If the
|
||
|
maximum is reached all new incoming connections will be closed.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3protocol.bittorrent.peerwire.max_message_length\f2 <num>\f1 (default: 8388608)
|
||
|
The maximum length of messages to accept over the wire.
|
||
|
Larger values will cause the connection to be dropped.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3protocol.bittorrent.peerwire.max_request_length\f2 <num>\f1 (default: 8388608)
|
||
|
The maximum length to allow for incoming requests.
|
||
|
Larger requests will cause the connection to be dropped.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3protocol.bittorrent.peerwire.request_length\f2 <num>\f1 (default: 16384)
|
||
|
How many bytes to query for per request. This is complementary
|
||
|
to the max_request_length option. If the configured length is
|
||
|
bigger than the piece length it will be truncated.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3protocol.bittorrent.peerwire.timeout\f2 <num>\f1 (default: 300)
|
||
|
The number of seconds to wait before closing a socket on
|
||
|
which nothing has been received or sent.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3protocol.bittorrent.peerwire.pool_size\f2 <num>\f1 (default: 55)
|
||
|
Maximum number of items in the peer pool. The peer pool
|
||
|
contains information used for establishing connections to
|
||
|
new peers.
|
||
|
Set to 0 to have unlimited size.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3protocol.bittorrent.piece_cache_size\f2 <num>\f1 (default: 1048576)
|
||
|
The maximum amount of memory used to hold recently
|
||
|
downloaded pieces.
|
||
|
Set to 0 to have unlimited size.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3protocol.bittorrent.max_uploads\f2 <num>\f1 (default: 7)
|
||
|
The maximum number of uploads to allow at once.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3protocol.bittorrent.min_uploads\f2 <num>\f1 (default: 2)
|
||
|
The minimum number of uploads which should at least
|
||
|
be used for new connections.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3protocol.bittorrent.request_queue_size\f2 <num>\f1 (default: 5)
|
||
|
How many piece requests to continuously keep in queue. Pipelining
|
||
|
of requests is essential to saturate connections and get a good
|
||
|
connection performance and thus a faster download. However, a
|
||
|
very big queue size can lead to wasting bandwidth near the end
|
||
|
of the connection since remaining piece blocks will be requested
|
||
|
from multiple peers.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3protocol.bittorrent.choke_interval\f2 <num>\f1 (default: 10)
|
||
|
The number of seconds between updating the connection state
|
||
|
and most importantly choke and unchoke peer connections. The
|
||
|
choke period should be big enough for newly unchoked connections
|
||
|
to get started but small enough to not allow freeriders too much
|
||
|
room for stealing bandwidth.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3protocol.bittorrent.rarest_first_cutoff\f2 <num>\f1 (default: 4)
|
||
|
The number of pieces to obtain before switching piece
|
||
|
selection strategy from random to rarest first.
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3protocol.bittorrent.allow_blacklist\f2 [0|1]\f1 (default: 1)
|
||
|
Allow blacklisting of buggy peers.
|
||
|
.SS Local files (protocol.file)
|
||
|
Options specific to local browsing.
|
||
|
.SS Local CGI (protocol.file.cgi)
|
||
|
Local CGI specific options.
|
||
|
.TP
|
||
|
\f3protocol.file.cgi.path\f2 <str>\f1 (default: "")
|
||
|
Colon separated list of directories, where CGI scripts are stored.
|
||
|
.TP
|
||
|
\f3protocol.file.cgi.policy\f2 [0|1]\f1 (default: 0)
|
||
|
Whether to execute local CGI scripts.
|
||
|
.TP
|
||
|
\f3protocol.file.allow_special_files\f2 [0|1]\f1 (default: 0)
|
||
|
Whether to allow reading from non-regular files.
|
||
|
Note this can be dangerous; reading /dev/urandom or
|
||
|
/dev/zero can ruin your day!
|
||
|
.TP
|
||
|
\f3protocol.file.show_hidden_files\f2 [0|1]\f1 (default: 1)
|
||
|
When set to false, files with name starting with a dot will be
|
||
|
hidden in local directories listing.
|
||
|
.TP
|
||
|
\f3protocol.file.try_encoding_extensions\f2 [0|1]\f1 (default: 1)
|
||
|
When set, if we can't open a file named 'filename', we'll try
|
||
|
to open 'filename' with some encoding extension appended
|
||
|
(ie. 'filename.gz'); it depends on the supported encodings.
|
||
|
.SS FTP (protocol.ftp)
|
||
|
FTP specific options.
|
||
|
.SS Proxy configuration (protocol.ftp.proxy)
|
||
|
FTP proxy configuration.
|
||
|
.TP
|
||
|
\f3protocol.ftp.proxy.host\f2 <str>\f1 (default: "")
|
||
|
Host and port-number (host:port) of the FTP proxy, or blank.
|
||
|
If it's blank, FTP_PROXY environment variable is checked as well.
|
||
|
.TP
|
||
|
\f3protocol.ftp.anon_passwd\f2 <str>\f1 (default: "some@host.domain")
|
||
|
FTP anonymous password to be sent.
|
||
|
.TP
|
||
|
\f3protocol.ftp.use_pasv\f2 [0|1]\f1 (default: 1)
|
||
|
Use PASV instead of PORT (passive vs active mode, IPv4 only).
|
||
|
.TP
|
||
|
\f3protocol.ftp.use_epsv\f2 [0|1]\f1 (default: 0)
|
||
|
Use EPSV instead of EPRT (passive vs active mode, IPv6 only).
|
||
|
.SS HTTP (protocol.http)
|
||
|
HTTP-specific options.
|
||
|
.SS Server bug workarounds (protocol.http.bugs)
|
||
|
Server-side HTTP bugs workarounds.
|
||
|
.TP
|
||
|
\f3protocol.http.bugs.accept_charset\f2 [0|1]\f1 (default: 1)
|
||
|
The Accept-Charset header is quite long and sending it can trigger
|
||
|
bugs in some rarely found servers.
|
||
|
.TP
|
||
|
\f3protocol.http.bugs.allow_blacklist\f2 [0|1]\f1 (default: 1)
|
||
|
Allow blacklisting of buggy servers.
|
||
|
.TP
|
||
|
\f3protocol.http.bugs.broken_302_redirect\f2 [0|1]\f1 (default: 1)
|
||
|
Broken 302 redirect (violates RFC but compatible with Netscape).
|
||
|
This is a problem for a lot of web discussion boards and the like.
|
||
|
If they will do strange things to you, try to play with this.
|
||
|
.TP
|
||
|
\f3protocol.http.bugs.post_no_keepalive\f2 [0|1]\f1 (default: 0)
|
||
|
Disable keepalive connection after POST request.
|
||
|
.TP
|
||
|
\f3protocol.http.bugs.http10\f2 [0|1]\f1 (default: 0)
|
||
|
Use HTTP/1.0 protocol instead of HTTP/1.1.
|
||
|
.SS Proxy configuration (protocol.http.proxy)
|
||
|
HTTP proxy configuration.
|
||
|
.TP
|
||
|
\f3protocol.http.proxy.host\f2 <str>\f1 (default: "")
|
||
|
Host and port-number (host:port) of the HTTP proxy, or blank.
|
||
|
If it's blank, HTTP_PROXY environment variable is checked as well.
|
||
|
.TP
|
||
|
\f3protocol.http.proxy.user\f2 <str>\f1 (default: "")
|
||
|
Proxy authentication username.
|
||
|
.TP
|
||
|
\f3protocol.http.proxy.passwd\f2 <str>\f1 (default: "")
|
||
|
Proxy authentication password.
|
||
|
.SS Referer sending (protocol.http.referer)
|
||
|
HTTP referer sending options. HTTP referer is a special header
|
||
|
sent in the HTTP requests, which is supposed to contain the previous
|
||
|
page visited by the browser. This way, the server can know what link
|
||
|
did you follow when accessing that page. However, this behaviour
|
||
|
can unfortunately considerably affect privacy and can lead even to a
|
||
|
security problem on some badly designed web pages.
|
||
|
.TP
|
||
|
\f3protocol.http.referer.policy\f2 <num>\f1 (default: 3)
|
||
|
Mode of sending HTTP referer:
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
is send no referer
|
||
|
.TP
|
||
|
.B 1
|
||
|
is send current URL as referer
|
||
|
.TP
|
||
|
.B 2
|
||
|
is send fixed fake referer
|
||
|
.TP
|
||
|
.B 3
|
||
|
is send previous URL as referer (correct, but insecure)
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3protocol.http.referer.fake\f2 <str>\f1 (default: "")
|
||
|
Fake referer to be sent when policy is 2.
|
||
|
.TP
|
||
|
\f3protocol.http.accept_language\f2 <str>\f1 (default: "")
|
||
|
Send Accept-Language header.
|
||
|
.TP
|
||
|
\f3protocol.http.accept_ui_language\f2 [0|1]\f1 (default: 1)
|
||
|
Request localised versions of documents from web-servers (using the
|
||
|
Accept-Language header) using the language you have configured for
|
||
|
ELinks' user-interface (this also affects navigator.language ECMAScript
|
||
|
value available to scripts). Note that some see this as a potential
|
||
|
security risk because it tells web-masters and the FBI sniffers about
|
||
|
your language preference.
|
||
|
.TP
|
||
|
\f3protocol.http.trace\f2 [0|1]\f1 (default: 0)
|
||
|
If active, all HTTP requests are sent with TRACE as their method
|
||
|
rather than GET or POST. This is useful for debugging of both ELinks
|
||
|
and various server-side scripts --- the server only returns the client's
|
||
|
request back to the client verbatim. Note that this type of request may
|
||
|
not be enabled on all servers.
|
||
|
.TP
|
||
|
\f3protocol.http.user_agent\f2 <str>\f1 (default: "ELinks/%v (textmode; %s; %t-%b)")
|
||
|
Change the User Agent ID. That means identification string, which
|
||
|
is sent to HTTP server when a document is requested. The 'textmode'
|
||
|
token in the first field is our silent attempt to establish this as
|
||
|
a standard for new textmode user agents, so that the webmasters can
|
||
|
have just a single uniform test for these if they are ie. pushing
|
||
|
some lite version to them automagically.
|
||
|
%v in the string means ELinks version
|
||
|
%s in the string means system identification
|
||
|
%t in the string means size of the terminal
|
||
|
%b in the string means number of bars displayed by ELinks
|
||
|
Use " " if you don't want any User-Agent header to be sent at all.
|
||
|
.SS HTTPS (protocol.https)
|
||
|
HTTPS-specific options.
|
||
|
.SS Proxy configuration (protocol.https.proxy)
|
||
|
HTTPS proxy configuration.
|
||
|
.TP
|
||
|
\f3protocol.https.proxy.host\f2 <str>\f1 (default: "")
|
||
|
Host and port-number (host:port) of the HTTPS CONNECT proxy, or blank.
|
||
|
If it's blank, HTTPS_PROXY environment variable is checked as well.
|
||
|
.SS NNTP (protocol.nntp)
|
||
|
NNTP and news specific options.
|
||
|
.TP
|
||
|
\f3protocol.nntp.server\f2 <str>\f1 (default: "")
|
||
|
Used when resolving news: URIs. If set to the empty string
|
||
|
the value of the NNTPSERVER environment variable will be used.
|
||
|
.TP
|
||
|
\f3protocol.nntp.header_entries\f2 <str>\f1 (default: "Subject,From,Date,Message-ID,Newsgroups")
|
||
|
Comma separated list of which entries in the article header
|
||
|
to show. E.g. 'Subject' and 'From'.
|
||
|
All header entries can be read in the header info dialog.
|
||
|
.SS URI rewriting (protocol.rewrite)
|
||
|
Rules for rewriting URIs entered in the goto dialog.
|
||
|
It makes it possible to define a set of prefixes that will
|
||
|
be expanded if they match a string entered in the goto dialog.
|
||
|
The prefixes can be dumb, meaning that they work only like
|
||
|
URI abbreviations, or smart ones, making it possible to pass
|
||
|
arguments to them like search engine keywords.
|
||
|
.SS Dumb Prefixes (protocol.rewrite.dumb)
|
||
|
Dumb prefixes, see enable-dumb description for details.
|
||
|
.TP
|
||
|
\f3protocol.rewrite.dumb._template_\f2 <str>\f1 (default: "")
|
||
|
Replacement URI for this dumbprefix:
|
||
|
%c in the string means the current URL
|
||
|
%% in the string means '%'
|
||
|
.SS Smart Prefixes (protocol.rewrite.smart)
|
||
|
Smart prefixes, see enable-smart description for details.
|
||
|
.TP
|
||
|
\f3protocol.rewrite.smart._template_\f2 <str>\f1 (default: "")
|
||
|
Replacement URI for this smartprefix:
|
||
|
%c in the string means the current URL
|
||
|
%s in the string means the whole argument to smartprefix
|
||
|
%0,%1,...,%9 means argument 0, 1, ..., 9
|
||
|
%% in the string means '%'
|
||
|
.TP
|
||
|
\f3protocol.rewrite.default_template\f2 <str>\f1 (default: "")
|
||
|
Default URI template used when the string entered in
|
||
|
the goto dialog does not appear to be a URI or a filename
|
||
|
(i.e. contains no '.', ':' or '/' characters), and does
|
||
|
not match any defined prefixes. Set the value to "" to
|
||
|
disable use of the default template rewrite rule.
|
||
|
.TP
|
||
|
\f3protocol.rewrite.enable-dumb\f2 [0|1]\f1 (default: 1)
|
||
|
Enable dumb prefixes - simple URI abbreviations which can
|
||
|
be written to the Goto URL dialog instead of actual URIs - i.e.
|
||
|
if you write 'elinks' there, you are directed to
|
||
|
http://elinks.or.cz/.
|
||
|
.TP
|
||
|
\f3protocol.rewrite.enable-smart\f2 [0|1]\f1 (default: 1)
|
||
|
Enable smart prefixes - URI templates triggered by writing
|
||
|
given abbreviation to the Goto URL dialog followed by a list
|
||
|
of arguments from which the actual URI is composed - i.e.
|
||
|
'gg:search keywords' or 'gn search keywords for news'.
|
||
|
.SS SMB (protocol.smb)
|
||
|
SAMBA specific options.
|
||
|
.TP
|
||
|
\f3protocol.smb.credentials\f2 <str>\f1 (default: "")
|
||
|
Credentials file passed to smbclient via -A option.
|
||
|
.SS User protocols (protocol.user)
|
||
|
User protocols. Options in this tree specify external
|
||
|
handlers for the appropriate protocols. Ie.
|
||
|
protocol.user.mailto.unix.
|
||
|
.SS Template option folder (protocol.user._template_)
|
||
|
Handler (external program) for this protocol. Name the
|
||
|
options in this tree after your system (ie. unix, unix-xwin).
|
||
|
.TP
|
||
|
\f3protocol.user._template_._template_\f2 <str>\f1 (default: "")
|
||
|
Handler (external program) for this protocol and system.
|
||
|
%f in the string means file name to include form data from
|
||
|
%h in the string means hostname (or email address)
|
||
|
%p in the string means port
|
||
|
%d in the string means path (everything after the port)
|
||
|
%s in the string means subject (?subject=<this>)
|
||
|
%u in the string means the whole URL
|
||
|
.TP
|
||
|
\f3protocol.no_proxy\f2 <str>\f1 (default: "")
|
||
|
Comma separated list of domains for which the proxy (HTTP/FTP)
|
||
|
should be disabled. Optionally, a port can be specified for some
|
||
|
domains as well. If it's blank, NO_PROXY environment variable is
|
||
|
checked as well.
|
||
|
.SS Terminals (terminal)
|
||
|
Terminal options.
|
||
|
.SS Template option folder (terminal._template_)
|
||
|
Options specific to this terminal type (according to $TERM value).
|
||
|
.TP
|
||
|
\f3terminal._template_.type\f2 <num>\f1 (default: 0)
|
||
|
Terminal type; matters mostly only when drawing frames and
|
||
|
dialog box borders:
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
is dumb terminal type, ASCII art
|
||
|
.TP
|
||
|
.B 1
|
||
|
is VT100, simple but portable
|
||
|
.TP
|
||
|
.B 2
|
||
|
is Linux, you get double frames and other goodies
|
||
|
.TP
|
||
|
.B 3
|
||
|
is KOI-8
|
||
|
.TP
|
||
|
.B 4
|
||
|
is FreeBSD
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3terminal._template_.m11_hack\f2 [0|1]\f1 (default: 0)
|
||
|
Switch fonts when drawing lines, enabling both local characters
|
||
|
and lines working at the same time. Makes sense only with linux
|
||
|
terminal.
|
||
|
.TP
|
||
|
\f3terminal._template_.utf_8_io\f2 [0|1]\f1 (default: 0)
|
||
|
Enable I/O in UTF8 for Unicode terminals. Note that currently,
|
||
|
only the subset of UTF8 according to terminal codepage is used.
|
||
|
.TP
|
||
|
\f3terminal._template_.restrict_852\f2 [0|1]\f1 (default: 0)
|
||
|
Restrict the characters used when drawing lines. Makes sense
|
||
|
only with linux terminals using the cp850/852 character sets.
|
||
|
.TP
|
||
|
\f3terminal._template_.block_cursor\f2 [0|1]\f1 (default: 0)
|
||
|
Move cursor to bottom right corner when done drawing.
|
||
|
This is particularly useful when we have a block cursor,
|
||
|
so that inversed text is displayed correctly.
|
||
|
.TP
|
||
|
\f3terminal._template_.colors\f2 <num>\f1 (default: 0)
|
||
|
The color mode controls what colors are used and how they are
|
||
|
output to the terminal. The color modes are:
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
is mono mode, only 2 colors are used
|
||
|
.TP
|
||
|
.B 1
|
||
|
is 16 color mode, uses the common ANSI colors
|
||
|
.TP
|
||
|
.B 2
|
||
|
is 256 color mode, uses XTerm RGB codes
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3terminal._template_.transparency\f2 [0|1]\f1 (default: 1)
|
||
|
If we should not set the background to black. This is particularly
|
||
|
useful when we have a terminal (typically in some windowing
|
||
|
environment) with a background image or a transparent background -
|
||
|
it will be visible in ELinks as well. Note that this option makes
|
||
|
sense only when colors are enabled.
|
||
|
.TP
|
||
|
\f3terminal._template_.underline\f2 [0|1]\f1 (default: 0)
|
||
|
If we should use underline or enhance the color instead.
|
||
|
.TP
|
||
|
\f3terminal._template_.charset\f2 <codepage>\f1 (default: System)
|
||
|
Codepage of charset used for displaying content on terminal.
|
||
|
'System' stands for a codepage determined by a selected locale.
|
||
|
.SS User interface (ui)
|
||
|
User interface options.
|
||
|
.SS Clock (ui.clock)
|
||
|
Digital clock in the status bar.
|
||
|
.TP
|
||
|
\f3ui.clock.enable\f2 [0|1]\f1 (default: 0)
|
||
|
Whether to display a digital clock in the status bar.
|
||
|
.TP
|
||
|
\f3ui.clock.format\f2 <str>\f1 (default: "[%H:%M]")
|
||
|
Format string for the digital clock. See the strftime(3)
|
||
|
manpage for details.
|
||
|
.SS Color settings (ui.colors)
|
||
|
Default user interface color settings.
|
||
|
.SS Color terminals (ui.colors.color)
|
||
|
Color settings for color terminal.
|
||
|
.SS Main menu bar (ui.colors.color.mainmenu)
|
||
|
Main menu bar colors.
|
||
|
.SS Unselected main menu bar item (ui.colors.color.mainmenu.normal)
|
||
|
Unselected main menu bar item colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.mainmenu.normal.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.mainmenu.normal.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Selected main menu bar item (ui.colors.color.mainmenu.selected)
|
||
|
Selected main menu bar item colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.mainmenu.selected.text\f2 <color|#rrggbb>\f1 (default: green)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.mainmenu.selected.background\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default background color.
|
||
|
.SS Hotkey (ui.colors.color.mainmenu.hotkey)
|
||
|
Main menu hotkey colors.
|
||
|
.SS Unselected hotkey (ui.colors.color.mainmenu.hotkey.normal)
|
||
|
Main menu unselected hotkey colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.mainmenu.hotkey.normal.text\f2 <color|#rrggbb>\f1 (default: darkred)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.mainmenu.hotkey.normal.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Selected hotkey (ui.colors.color.mainmenu.hotkey.selected)
|
||
|
Main menu selected hotkey colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.mainmenu.hotkey.selected.text\f2 <color|#rrggbb>\f1 (default: darkred)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.mainmenu.hotkey.selected.background\f2 <color|#rrggbb>\f1 (default: green)
|
||
|
Default background color.
|
||
|
.SS Menu bar (ui.colors.color.menu)
|
||
|
Menu bar colors.
|
||
|
.SS Unselected menu item (ui.colors.color.menu.normal)
|
||
|
Unselected menu item colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.menu.normal.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.menu.normal.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Selected menu item (ui.colors.color.menu.selected)
|
||
|
Selected menu item colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.menu.selected.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.menu.selected.background\f2 <color|#rrggbb>\f1 (default: green)
|
||
|
Default background color.
|
||
|
.SS Marked menu item (ui.colors.color.menu.marked)
|
||
|
Marked menu item colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.menu.marked.text\f2 <color|#rrggbb>\f1 (default: red)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.menu.marked.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Hotkey (ui.colors.color.menu.hotkey)
|
||
|
Menu item hotkey colors.
|
||
|
.SS Unselected hotkey (ui.colors.color.menu.hotkey.normal)
|
||
|
Menu item unselected hotkey colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.menu.hotkey.normal.text\f2 <color|#rrggbb>\f1 (default: darkred)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.menu.hotkey.normal.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Selected hotkey (ui.colors.color.menu.hotkey.selected)
|
||
|
Menu item selected hotkey colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.menu.hotkey.selected.text\f2 <color|#rrggbb>\f1 (default: darkred)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.menu.hotkey.selected.background\f2 <color|#rrggbb>\f1 (default: green)
|
||
|
Default background color.
|
||
|
.SS Menu frame (ui.colors.color.menu.frame)
|
||
|
Menu frame colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.menu.frame.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.menu.frame.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Dialog (ui.colors.color.dialog)
|
||
|
Dialog colors.
|
||
|
.SS Generic (ui.colors.color.dialog.generic)
|
||
|
Generic dialog colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.generic.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.generic.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Frame (ui.colors.color.dialog.frame)
|
||
|
Dialog frame colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.frame.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.frame.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Scrollbar (ui.colors.color.dialog.scrollbar)
|
||
|
Scrollbar colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.scrollbar.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.scrollbar.background\f2 <color|#rrggbb>\f1 (default: blue)
|
||
|
Default background color.
|
||
|
.SS Selected scrollbar (ui.colors.color.dialog.scrollbar-selected)
|
||
|
Scrollbar selected colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.scrollbar-selected.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.scrollbar-selected.background\f2 <color|#rrggbb>\f1 (default: green)
|
||
|
Default background color.
|
||
|
.SS Title (ui.colors.color.dialog.title)
|
||
|
Dialog title colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.title.text\f2 <color|#rrggbb>\f1 (default: darkred)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.title.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Text (ui.colors.color.dialog.text)
|
||
|
Dialog text colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.text.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.text.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Checkbox (ui.colors.color.dialog.checkbox)
|
||
|
Dialog checkbox colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.checkbox.text\f2 <color|#rrggbb>\f1 (default: darkred)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.checkbox.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Selected checkbox (ui.colors.color.dialog.checkbox-selected)
|
||
|
Dialog selected checkbox colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.checkbox-selected.text\f2 <color|#rrggbb>\f1 (default: yellow)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.checkbox-selected.background\f2 <color|#rrggbb>\f1 (default: green)
|
||
|
Default background color.
|
||
|
.SS Checkbox label (ui.colors.color.dialog.checkbox-label)
|
||
|
Dialog checkbox label colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.checkbox-label.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.checkbox-label.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Button (ui.colors.color.dialog.button)
|
||
|
Dialog button colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.button.text\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.button.background\f2 <color|#rrggbb>\f1 (default: blue)
|
||
|
Default background color.
|
||
|
.SS Selected button (ui.colors.color.dialog.button-selected)
|
||
|
Dialog selected button colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.button-selected.text\f2 <color|#rrggbb>\f1 (default: yellow)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.button-selected.background\f2 <color|#rrggbb>\f1 (default: green)
|
||
|
Default background color.
|
||
|
.SS Button shortcut (ui.colors.color.dialog.button-shortcut)
|
||
|
Dialog button colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.button-shortcut.text\f2 <color|#rrggbb>\f1 (default: yellow)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.button-shortcut.background\f2 <color|#rrggbb>\f1 (default: blue)
|
||
|
Default background color.
|
||
|
.SS Selected button shortcut (ui.colors.color.dialog.button-shortcut-selected)
|
||
|
Dialog selected button colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.button-shortcut-selected.text\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.button-shortcut-selected.background\f2 <color|#rrggbb>\f1 (default: blue)
|
||
|
Default background color.
|
||
|
.SS Text field (ui.colors.color.dialog.field)
|
||
|
Dialog text field colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.field.text\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.field.background\f2 <color|#rrggbb>\f1 (default: blue)
|
||
|
Default background color.
|
||
|
.SS Text field text (ui.colors.color.dialog.field-text)
|
||
|
Dialog field text colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.field-text.text\f2 <color|#rrggbb>\f1 (default: yellow)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.field-text.background\f2 <color|#rrggbb>\f1 (default: blue)
|
||
|
Default background color.
|
||
|
.SS Meter (ui.colors.color.dialog.meter)
|
||
|
Dialog meter colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.meter.text\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.meter.background\f2 <color|#rrggbb>\f1 (default: blue)
|
||
|
Default background color.
|
||
|
.SS Shadow (ui.colors.color.dialog.shadow)
|
||
|
Dialog shadow colors (see ui.shadows option).
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.shadow.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.dialog.shadow.background\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default background color.
|
||
|
.SS Title bar (ui.colors.color.title)
|
||
|
Title bar colors.
|
||
|
.SS Generic title bar (ui.colors.color.title.title-bar)
|
||
|
Generic title bar colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.title.title-bar.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.title.title-bar.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Title bar text (ui.colors.color.title.title-text)
|
||
|
Title bar text colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.title.title-text.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.title.title-text.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Status bar (ui.colors.color.status)
|
||
|
Status bar colors.
|
||
|
.SS Generic status bar (ui.colors.color.status.status-bar)
|
||
|
Generic status bar colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.status.status-bar.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.status.status-bar.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Status bar text (ui.colors.color.status.status-text)
|
||
|
Status bar text colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.status.status-text.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.status.status-text.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Tabs bar (ui.colors.color.tabs)
|
||
|
Tabs bar colors.
|
||
|
.SS Unvisited tab (ui.colors.color.tabs.unvisited)
|
||
|
Tab colors for tabs that have not been
|
||
|
selected since they completed loading.
|
||
|
.TP
|
||
|
\f3ui.colors.color.tabs.unvisited.text\f2 <color|#rrggbb>\f1 (default: darkblue)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.tabs.unvisited.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Unselected tab (ui.colors.color.tabs.normal)
|
||
|
Unselected tab colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.tabs.normal.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.tabs.normal.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Loading tab (ui.colors.color.tabs.loading)
|
||
|
Tab colors for tabs that are loading in the background.
|
||
|
.TP
|
||
|
\f3ui.colors.color.tabs.loading.text\f2 <color|#rrggbb>\f1 (default: darkred)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.tabs.loading.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Selected tab (ui.colors.color.tabs.selected)
|
||
|
Selected tab colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.tabs.selected.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.tabs.selected.background\f2 <color|#rrggbb>\f1 (default: green)
|
||
|
Default background color.
|
||
|
.SS Tab separator (ui.colors.color.tabs.separator)
|
||
|
Tab separator colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.tabs.separator.text\f2 <color|#rrggbb>\f1 (default: brown)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.tabs.separator.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Searched strings (ui.colors.color.searched)
|
||
|
Searched string highlight colors.
|
||
|
.TP
|
||
|
\f3ui.colors.color.searched.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.color.searched.background\f2 <color|#rrggbb>\f1 (default: lime)
|
||
|
Default background color.
|
||
|
.SS Non-color terminals (ui.colors.mono)
|
||
|
Color settings for non-color terminal.
|
||
|
.SS Main menu bar (ui.colors.mono.mainmenu)
|
||
|
Main menu bar colors.
|
||
|
.SS Unselected main menu bar item (ui.colors.mono.mainmenu.normal)
|
||
|
Unselected main menu bar item colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.mainmenu.normal.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.mainmenu.normal.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Selected main menu bar item (ui.colors.mono.mainmenu.selected)
|
||
|
Selected main menu bar item colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.mainmenu.selected.text\f2 <color|#rrggbb>\f1 (default: gray)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.mainmenu.selected.background\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default background color.
|
||
|
.SS Hotkey (ui.colors.mono.mainmenu.hotkey)
|
||
|
Main menu hotkey colors.
|
||
|
.SS Unselected hotkey (ui.colors.mono.mainmenu.hotkey.normal)
|
||
|
Main menu unselected hotkey colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.mainmenu.hotkey.normal.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.mainmenu.hotkey.normal.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Selected hotkey (ui.colors.mono.mainmenu.hotkey.selected)
|
||
|
Main menu selected hotkey colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.mainmenu.hotkey.selected.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.mainmenu.hotkey.selected.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Menu bar (ui.colors.mono.menu)
|
||
|
Menu bar colors.
|
||
|
.SS Unselected menu item (ui.colors.mono.menu.normal)
|
||
|
Unselected menu item colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.menu.normal.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.menu.normal.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Selected menu item (ui.colors.mono.menu.selected)
|
||
|
Selected menu item colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.menu.selected.text\f2 <color|#rrggbb>\f1 (default: gray)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.menu.selected.background\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default background color.
|
||
|
.SS Marked menu item (ui.colors.mono.menu.marked)
|
||
|
Marked menu item colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.menu.marked.text\f2 <color|#rrggbb>\f1 (default: gray)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.menu.marked.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Hotkey (ui.colors.mono.menu.hotkey)
|
||
|
Menu item hotkey colors.
|
||
|
.SS Unselected hotkey (ui.colors.mono.menu.hotkey.normal)
|
||
|
Menu item unselected hotkey colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.menu.hotkey.normal.text\f2 <color|#rrggbb>\f1 (default: gray)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.menu.hotkey.normal.background\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default background color.
|
||
|
.SS Selected hotkey (ui.colors.mono.menu.hotkey.selected)
|
||
|
Menu item selected hotkey colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.menu.hotkey.selected.text\f2 <color|#rrggbb>\f1 (default: gray)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.menu.hotkey.selected.background\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default background color.
|
||
|
.SS Menu frame (ui.colors.mono.menu.frame)
|
||
|
Menu frame colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.menu.frame.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.menu.frame.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Dialog (ui.colors.mono.dialog)
|
||
|
Dialog colors.
|
||
|
.SS Generic (ui.colors.mono.dialog.generic)
|
||
|
Generic dialog colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.generic.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.generic.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Frame (ui.colors.mono.dialog.frame)
|
||
|
Dialog frame colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.frame.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.frame.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Scrollbar (ui.colors.mono.dialog.scrollbar)
|
||
|
Scrollbar colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.scrollbar.text\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.scrollbar.background\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default background color.
|
||
|
.SS Selected scrollbar (ui.colors.mono.dialog.scrollbar-selected)
|
||
|
Scrollbar selected colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.scrollbar-selected.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.scrollbar-selected.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Title (ui.colors.mono.dialog.title)
|
||
|
Dialog title colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.title.text\f2 <color|#rrggbb>\f1 (default: gray)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.title.background\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default background color.
|
||
|
.SS Text (ui.colors.mono.dialog.text)
|
||
|
Dialog text colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.text.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.text.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Checkbox (ui.colors.mono.dialog.checkbox)
|
||
|
Dialog checkbox colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.checkbox.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.checkbox.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Selected checkbox (ui.colors.mono.dialog.checkbox-selected)
|
||
|
Dialog selected checkbox colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.checkbox-selected.text\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.checkbox-selected.background\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default background color.
|
||
|
.SS Checkbox label (ui.colors.mono.dialog.checkbox-label)
|
||
|
Dialog checkbox label colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.checkbox-label.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.checkbox-label.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Button (ui.colors.mono.dialog.button)
|
||
|
Dialog button colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.button.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.button.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Selected button (ui.colors.mono.dialog.button-selected)
|
||
|
Dialog selected button colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.button-selected.text\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.button-selected.background\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default background color.
|
||
|
.SS Button shortcut (ui.colors.mono.dialog.button-shortcut)
|
||
|
Dialog button colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.button-shortcut.text\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.button-shortcut.background\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default background color.
|
||
|
.SS Selected button shortcut (ui.colors.mono.dialog.button-shortcut-selected)
|
||
|
Dialog selected button colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.button-shortcut-selected.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.button-shortcut-selected.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Text field (ui.colors.mono.dialog.field)
|
||
|
Dialog text field colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.field.text\f2 <color|#rrggbb>\f1 (default: gray)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.field.background\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default background color.
|
||
|
.SS Text field text (ui.colors.mono.dialog.field-text)
|
||
|
Dialog field text colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.field-text.text\f2 <color|#rrggbb>\f1 (default: gray)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.field-text.background\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default background color.
|
||
|
.SS Meter (ui.colors.mono.dialog.meter)
|
||
|
Dialog meter colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.meter.text\f2 <color|#rrggbb>\f1 (default: gray)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.meter.background\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default background color.
|
||
|
.SS Shadow (ui.colors.mono.dialog.shadow)
|
||
|
Dialog shadow colors (see ui.shadows option).
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.shadow.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.dialog.shadow.background\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default background color.
|
||
|
.SS Title bar (ui.colors.mono.title)
|
||
|
Title bar colors.
|
||
|
.SS Generic title bar (ui.colors.mono.title.title-bar)
|
||
|
Generic title bar colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.title.title-bar.text\f2 <color|#rrggbb>\f1 (default: gray)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.title.title-bar.background\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default background color.
|
||
|
.SS Title bar text (ui.colors.mono.title.title-text)
|
||
|
Title bar text colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.title.title-text.text\f2 <color|#rrggbb>\f1 (default: gray)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.title.title-text.background\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default background color.
|
||
|
.SS Status bar (ui.colors.mono.status)
|
||
|
Status bar colors.
|
||
|
.SS Generic status bar (ui.colors.mono.status.status-bar)
|
||
|
Generic status bar colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.status.status-bar.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.status.status-bar.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Status bar text (ui.colors.mono.status.status-text)
|
||
|
Status bar text colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.status.status-text.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.status.status-text.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Tabs bar (ui.colors.mono.tabs)
|
||
|
Tabs bar colors.
|
||
|
.SS Unvisited tab (ui.colors.mono.tabs.unvisited)
|
||
|
Tab colors for tabs that have not been
|
||
|
selected since they completed loading.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.tabs.unvisited.text\f2 <color|#rrggbb>\f1 (default: gray)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.tabs.unvisited.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Unselected tab (ui.colors.mono.tabs.normal)
|
||
|
Unselected tab colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.tabs.normal.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.tabs.normal.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Loading tab (ui.colors.mono.tabs.loading)
|
||
|
Tab colors for tabs that are loading in the background.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.tabs.loading.text\f2 <color|#rrggbb>\f1 (default: gray)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.tabs.loading.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Selected tab (ui.colors.mono.tabs.selected)
|
||
|
Selected tab colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.tabs.selected.text\f2 <color|#rrggbb>\f1 (default: gray)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.tabs.selected.background\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default background color.
|
||
|
.SS Tab separator (ui.colors.mono.tabs.separator)
|
||
|
Tab separator colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.tabs.separator.text\f2 <color|#rrggbb>\f1 (default: gray)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.tabs.separator.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Searched strings (ui.colors.mono.searched)
|
||
|
Searched string highlight colors.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.searched.text\f2 <color|#rrggbb>\f1 (default: black)
|
||
|
Default text color.
|
||
|
.TP
|
||
|
\f3ui.colors.mono.searched.background\f2 <color|#rrggbb>\f1 (default: white)
|
||
|
Default background color.
|
||
|
.SS Dialog settings (ui.dialogs)
|
||
|
Dialogs-specific appearance and behaviour settings.
|
||
|
.TP
|
||
|
\f3ui.dialogs.listbox_min_height\f2 <num>\f1 (default: 10)
|
||
|
Minimal height of the listbox widget (used e.g. for bookmarks
|
||
|
or global history).
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3ui.dialogs.shadows\f2 [0|1]\f1 (default: 0)
|
||
|
Make dialogs drop shadows (the shadows are solid, you can
|
||
|
adjust their color by ui.colors.*.dialog.shadow). You may
|
||
|
also want to eliminate the wide borders by adjusting setup.h.
|
||
|
.TP
|
||
|
\f3ui.dialogs.underline_hotkeys\f2 [0|1]\f1 (default: 0)
|
||
|
Whether to underline hotkeys in menus to make them more
|
||
|
visible. Requires the underlining is enabled for the terminal.
|
||
|
.TP
|
||
|
\f3ui.dialogs.underline_button_shortcuts\f2 [0|1]\f1 (default: 0)
|
||
|
Whether to underline button shortcuts to make them more
|
||
|
visible. Requires the underlining is enabled for the terminal.
|
||
|
.SS LEDs (ui.leds)
|
||
|
LEDs (visual indicators) options.
|
||
|
.TP
|
||
|
\f3ui.leds.enable\f2 [0|1]\f1 (default: 1)
|
||
|
Enable LEDs.
|
||
|
These visual indicators will inform you about various states.
|
||
|
.SS Sessions (ui.sessions)
|
||
|
Sessions settings.
|
||
|
.TP
|
||
|
\f3ui.sessions.auto_restore\f2 [0|1]\f1 (default: 0)
|
||
|
Automatically restore the session at start.
|
||
|
This feature requires bookmark support.
|
||
|
.TP
|
||
|
\f3ui.sessions.auto_save\f2 [0|1]\f1 (default: 0)
|
||
|
Automatically save the session when quitting.
|
||
|
This feature requires bookmark support.
|
||
|
.TP
|
||
|
\f3ui.sessions.auto_save_foldername\f2 <str>\f1 (default: "Auto saved session")
|
||
|
Name of the bookmarks folder used for auto saving and restoring session.
|
||
|
The name has to be unique. Any folders with the same name will be deleted.
|
||
|
This only makes sense with bookmark support.
|
||
|
.TP
|
||
|
\f3ui.sessions.homepage\f2 <str>\f1 (default: "")
|
||
|
The URI to load either at startup time when no URI was given
|
||
|
on the command line or when requested by the goto-url-home action.
|
||
|
Set to "" if the environment variable WWW_HOME should be used
|
||
|
as homepage URI instead.
|
||
|
.TP
|
||
|
\f3ui.sessions.snapshot\f2 [0|1]\f1 (default: 0)
|
||
|
Automatically save a snapshot of all tabs periodically.
|
||
|
This will periodically bookmark the tabs of each terminal in a separate folder
|
||
|
for recovery after a crash.
|
||
|
.SS Window tabs (ui.tabs)
|
||
|
Window tabs settings.
|
||
|
.TP
|
||
|
\f3ui.tabs.show_bar\f2 <num>\f1 (default: 1)
|
||
|
Show tabs bar on the screen:
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
means never
|
||
|
.TP
|
||
|
.B 1
|
||
|
means only if two or more tabs are open
|
||
|
.TP
|
||
|
.B 2
|
||
|
means always
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3ui.tabs.wraparound\f2 [0|1]\f1 (default: 1)
|
||
|
When moving right from the last tab, jump at the first one, and
|
||
|
vice versa.
|
||
|
.TP
|
||
|
\f3ui.tabs.confirm_close\f2 [0|1]\f1 (default: 0)
|
||
|
When closing a tab show confirmation dialog.
|
||
|
.SS Timer options (ui.timer)
|
||
|
Timed action after certain interval of user inactivity. Someone can
|
||
|
even find this useful, although you may not believe that.
|
||
|
.TP
|
||
|
\f3ui.timer.enable\f2 <num>\f1 (default: 0)
|
||
|
Whether to enable the timer or not:
|
||
|
.RS
|
||
|
.PD 0
|
||
|
.TP
|
||
|
.B 0
|
||
|
is don't count down anything
|
||
|
.TP
|
||
|
.B 1
|
||
|
is count down, but don't show the timer
|
||
|
.TP
|
||
|
.B 2
|
||
|
is count down and show the timer near LEDs
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3ui.timer.duration\f2 <num>\f1 (default: 86400)
|
||
|
Inactivity timeout in seconds. The maximum of one day
|
||
|
should be enough for just everyone (TM).
|
||
|
.PD
|
||
|
.RE
|
||
|
.TP
|
||
|
\f3ui.timer.action\f2 <str>\f1 (default: "")
|
||
|
Keybinding action to be triggered when timer reaches zero.
|
||
|
.TP
|
||
|
\f3ui.date_format\f2 <str>\f1 (default: "%b %e %H:%M")
|
||
|
Date format to use in dialogs. See strftime(3).
|
||
|
.TP
|
||
|
\f3ui.language\f2 <language>\f1 (default: "System")
|
||
|
Language of user interface. 'System' means that the language will
|
||
|
be extracted from the environment dynamically.
|
||
|
.TP
|
||
|
\f3ui.show_status_bar\f2 [0|1]\f1 (default: 1)
|
||
|
Show status bar on the screen.
|
||
|
.TP
|
||
|
\f3ui.show_title_bar\f2 [0|1]\f1 (default: 1)
|
||
|
Show title bar on the screen.
|
||
|
.TP
|
||
|
\f3ui.startup_goto_dialog\f2 [0|1]\f1 (default: 1)
|
||
|
Pop up goto dialog in newly created tabs when there's no homepage
|
||
|
set. This means also showing goto dialog on startup.
|
||
|
.TP
|
||
|
\f3ui.success_msgbox\f2 [0|1]\f1 (default: 1)
|
||
|
When you pressed a [ Save ] button in some manager, this option
|
||
|
will make sure that a box confirming success of the operation will
|
||
|
pop up.
|
||
|
.TP
|
||
|
\f3ui.window_title\f2 [0|1]\f1 (default: 1)
|
||
|
Set the window title when running in a windowing environment
|
||
|
in an xterm-like terminal. This way the document's title is
|
||
|
shown on the window titlebar.
|
||
|
.SH "DOCUMENT INFO"
|
||
|
.PP
|
||
|
Generated by help2doc (Revision: 1.19) on 09 August 05 using output from ELinks version 0.11.CVS.
|
||
|
help2doc is distributed with ELinks under the terms of the GPL.
|
||
|
.SH "SEE ALSO"
|
||
|
.BR elinks (1),
|
||
|
.BR elinksmanual (1),
|
||
|
.BR elinkskeys (5)
|