elinks.conf.5

elinks下lynx是最重要的二个文本浏览器, 在linux下非常实用, elinks也是gentoo安装过程中默认使用的浏览器, 这是elinks源代码

.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "ELINKS.CONF" 5 "ELinks configuration file" "2006-01-29" "ELinks configuration file"
.SH NAME
elinks.conf \- ELinks configuration file
.SH "SYNOPSIS"

.nf
set     "<option>" = <value>
unset   "<option>" = <value>
bind    "<keymap>" "<key>" = "<action>"
include "<file>"
.fi

.SH "DESCRIPTION"


The 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\&.


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\&.


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 \fBelinkskeys\fR(5)\&.

.SH "SYNTAX"


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"


Some sample settings:

.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 \\e\\*(lq%s\\e\\*(rq"
.fi

.SH "OPTIONS"

.TP
bookmarks
Bookmark options\&.

.TP
bookmarks\&.file_format <num> (default: 0)
File format for bookmarks (affects both reading and saving):

.RS
.TP 3
\(bu
0: is the default native \fIELinks\fR format
.TP
\(bu
1: is XBEL universal XML bookmarks format (NO NATIONAL CHARS SUPPORT!)
.LP
.RE
.IP

.TP
bookmarks\&.folder_state [0|1] (default: 1)
When saving bookmarks also store whether folders are expanded or not, so the look of the bookmark dialog is kept across \fIELinks\fR sessions\&. If disabled all folders will appear unexpanded next time \fIELinks\fR is run\&.

.TP
config
Configuration handling options\&.

.TP
config\&.comments <num> (default: 3)
Amount of comments automatically written to the config file:

.RS
.TP 3
\(bu
0: is no comments are written
.TP
\(bu
1: is only the "blurb" (name+type) is written
.TP
\(bu
2: is only the description is written
.TP
\(bu
3: is full comments are written
.LP
.RE
.IP

.TP
config\&.indentation <num> (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\&.

.TP
config\&.saving_style <num> (default: 3)
Determines what happens when you tell \fIELinks\fR to save options:

.RS
.TP 3
\(bu
0: is only values of current options are altered
.TP
\(bu
1: is values of current options are altered and missing options are added at the end of the file
.TP
\(bu
2: is the configuration file is rewritten from scratch
.TP
\(bu
3: is values of current options are altered and missing options CHANGED during this \fIELinks\fR session are added at the end of the file
.LP
.RE
.IP

.TP
config\&.i18n [0|1] (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
config\&.saving_style_w [0|1] (default: 0)
This is internal option used when displaying a warning about obsolete config\&.saving_style\&. You shouldn't touch it\&.

.TP
config\&.show_template [0|1] (default: 0)
Show template options in autocreated trees in the options manager and save them to the configuration file\&.

.TP
connection
Connection options\&.

.TP
connection\&.ssl
SSL options\&.

.TP
connection\&.ssl\&.client_cert
X509 client certificate options\&.

.TP
connection\&.ssl\&.client_cert\&.enable [0|1] (default: 0)
Enable or not the sending of X509 client certificates to servers which request them\&.

.TP
connection\&.ssl\&.client_cert\&.file <str> (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
connection\&.ssl\&.cert_verify [0|1] (default: 0)
Verify the peer's SSL certificate\&. Note that this needs extensive configuration of OpenSSL by the user\&.

.TP
connection\&.async_dns [0|1] (default: 1)
Whether to use asynchronous DNS resolving\&.

.TP
connection\&.max_connections <num> (default: 10)
Maximum number of concurrent connections\&.

.TP
connection\&.max_connections_to_host <num> (default: 2)
Maximum number of concurrent connections to a given host\&.

.TP
connection\&.receive_timeout <num> (default: 120)
Receive timeout (in seconds)\&.

.TP
connection\&.retries <num> (default: 3)
Number of tries to establish a connection\&. Zero means try forever\&.

.TP
connection\&.try_ipv4 [0|1] (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
connection\&.try_ipv6 [0|1] (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
connection\&.unrestartable_receive_timeout <num> (default: 600)
Timeout for non\-restartable connections (in seconds)\&.

.TP
cookies
Cookies options\&.

.TP
cookies\&.accept_policy <num> (default: 2)
Cookies accepting policy:

.RS
.TP 3
\(bu
0: is accept no cookies
.TP
\(bu
1: is ask for confirmation before accepting cookie
.TP
\(bu
2: is accept all cookies
.LP
.RE
.IP

.TP
cookies\&.max_age <num> (default: \-1)
Cookie maximum age (in days):

.RS
.TP 3
\(bu
\-1: is use cookie's expiration date if any
.TP
\(bu
0: is force expiration at the end of session, ignoring cookie's expiration date
.TP
\(bu
1: + is use cookie's expiration date, but limit age to the given number of days
.LP
.RE
.IP

.TP
cookies\&.paranoid_security [0|1] (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
cookies\&.save [0|1] (default: 1)
Whether cookies should be loaded from and save to disk\&.

.TP
cookies\&.resave [0|1] (default: 1)
Save cookies after each change in cookies list? No effect when cookie saving (cookies\&.save) is off\&.

.TP
document
Document options\&.

.TP
document\&.browse
Document browsing options (mainly interactivity)\&.

.TP
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
document\&.browse\&.accesskey\&.auto_follow [0|1] (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
document\&.browse\&.accesskey\&.display [0|1] (default: 0)
Display access key in link info\&.

.TP
document\&.browse\&.accesskey\&.priority <num> (default: 0)
Priority of 'accesskey' HTML attribute:

.RS
.TP 3
\(bu
0: is first try all normal bindings; if it fails, check accesskey
.TP
\(bu
1: is first try only frame bindings; if it fails, check accesskey
.TP
\(bu
2: is first check accesskey (this can be dangerous)
.LP
.RE
.IP

.TP
document\&.browse\&.forms
Options for handling of the forms interaction\&.

.TP
document\&.browse\&.forms\&.auto_submit [0|1] (default: 1)
Automagically submit a form when enter is pressed with a text field selected\&.

.TP
document\&.browse\&.forms\&.confirm_submit [0|1] (default: 1)
Ask for confirmation when submitting a form\&.

.TP
document\&.browse\&.forms\&.input_size <num> (default: 20)
Default form input size if none is specified\&.

.TP
document\&.browse\&.forms\&.insert_mode [0|1] (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
document\&.browse\&.forms\&.editor <str> (default: "")
Path to the executable that \fIELinks\fR should launch when the user requests to edit a textarea with an external editor\&. If this is blank, \fIELinks\fR will use the value of the environmental variable $EDITOR\&. If $EDITOR is empty or not set, \fIELinks\fR will then default to "vi"\&.

.TP
document\&.browse\&.forms\&.show_formhist [0|1] (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\&.

.TP
document\&.browse\&.images
Options for handling of images\&.

.TP
document\&.browse\&.images\&.display_style <num> (default: 2)
Display style for image tags when displayed:

.RS
.TP 3
\(bu
0: means always display IMG
.TP
\(bu
1: means always display filename
.TP
\(bu
2: means display alt/title attribute if possible, IMG if not
.TP
\(bu
3: means display alt/title attribute if possible, filename if not
.LP
.RE
.IP

.TP
document\&.browse\&.images\&.filename_maxlen <num> (default: 0)
Maximum length of image filename when displayed:

.RS
.TP 3
\(bu
0: means always display full filename
.TP
\(bu
1\-500: means display filename with this maximal length; if it is longer, the middle is substituted by an asterisk
.LP
.RE
.IP

.TP
document\&.browse\&.images\&.image_link_tagging <num> (default: 1)
When to enclose image links:

.RS
.TP 3
\(bu
0: means never
.TP
\(bu
1: means never if alt or title are provided (old behavior)
.TP
\(bu
2: means always
.LP
.RE
.IP

.TP
document\&.browse\&.images\&.image_link_prefix <str> (default: "[")
Prefix string to use to mark image links\&.

.TP
document\&.browse\&.images\&.image_link_suffix <str> (default: "]")
Suffix string to use to mark image links\&.

.TP
document\&.browse\&.images\&.label_maxlen <num> (default: 0)
Maximum length of image label (alt/title):

.RS
.TP 3
\(bu
0: means always display full label
.TP
\(bu
1\-500: means display label with this maximal length; if it is longer, the middle is substituted by an asterisk
.LP
.RE
.IP

.TP
document\&.browse\&.images\&.show_as_links [0|1] (default: 0)
Display links to images without an alt attribute\&. If this option is off, these images are completely invisible\&.

.TP
document\&.browse\&.images\&.show_any_as_links [0|1] (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\&.

.TP
document\&.browse\&.links
Options for handling of links to other documents\&.

.TP
document\&.browse\&.links\&.active_link
Options for the active link\&.

.TP
document\&.browse\&.links\&.active_link\&.colors
Active link colors\&.

.TP
document\&.browse\&.links\&.active_link\&.colors\&.background <color|#rrggbb> (default: blue)
Default background color\&.

.TP
document\&.browse\&.links\&.active_link\&.colors\&.text <color|#rrggbb> (default: black)
Default text color\&.