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 the elinkskeys(5) man
page.
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.
EXAMPLES
Some sample settings:
# 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""
OPTIONS
Bookmarks (bookmarks)
Bookmark options.
bookmarks.file_format <num> (default: 0)
File format for bookmarks (affects both reading and saving):
0
is the default ELinks (Links 0.9x compatible) format
1
is XBEL universal XML bookmarks format (NO NATIONAL CHARS SUPPORT!)
Configuration system (config)
Configuration handling options.
config.comments <num> (default: 3)
Amount of comments automatically written to the config file:
0
is no comments are written
1
is only the "blurb" (name+type) is written
2
is only the description is written
3
is full comments are written
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.
config.saving_style <num> (default: 3)
Determines what happens when you tell ELinks to save options:
0
is only values of current options are altered
1
is values of current options are altered and missing options
are added at the end of the file
2
is the configuration file is rewritten from scratch
3
is values of current options are altered and missing options
CHANGED during this ELinks session are added at the end of
the file
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.
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.
config.show_template [0|1] (default: 0)
Show _template_ options in autocreated trees in the options
manager and save them to the configuration file.
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.
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.
Timeout for non-restartable connections (in seconds).
Cookies (cookies)
Cookies options.
cookies.accept_policy <num> (default: 2)
Cookies accepting policy:
0
is accept no cookies
1
is ask for confirmation before accepting cookie
2
is accept all cookies
cookies.max_age <num> (default: -1)
Cookie maximum age (in days):
-1
is use cookie's expiration date if any
0
is force expiration at the end of session, ignoring cookie's expiration date
1
+ is use cookie's expiration date, but limit age to the given number of days
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). Please see
code (cookies.c:check_domain_security()) for explanation.
cookies.save [0|1] (default: 1)
Load/save cookies from/to disk?
cookies.resave [0|1] (default: 1)
Save cookies after each change in cookies list? No effect when
cookies_save is off.
Document (document)
Document options.
Browsing (document.browse)
Document browsing options (mainly interactivity).
Accesskeys (document.browse.accesskey)
Options for handling of the accesskey attribute of the active
HTML elements.
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.
How to handle errors when nothing is matched.
Currently only used for typeahead:
0
means do nothing
1
means beep the terminal
2
means pop up message box
document.browse.margin_width <num> (default: 3)
Horizontal text margin.
document.browse.refresh [0|1] (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 take.
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.
document.browse.scroll_margin <num> (default: 3)
Size of the virtual margin - when you click inside of that margin,
document scrolls in that direction.
document.browse.scroll_step <num> (default: 2)
Number of lines to scroll when a key bound to scroll-up or scroll-
down is pressed and no prefix was given.
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.
is use document colors if available, except background
2
is use document colors, including background. This can
look really impressive mostly, but few sites look really
ugly there (unfortunately including slashdot (but try to
let him serve you that 'plain' version and the world will
suddenly become a much more happy place for life)). Note
that obviously if the background isn't black, it will
break transparency, if you have it enabled for your terminal
and on your terminal.
Enable to make table rendering expand table columns so cells
are more correctly vertically aligned with respect to the background
colors, but less correctly vertically aligned with respect to the
overall layout. Only useful if you also have
document.colors.use_document_colors set to 2. Experimental.
document.html.display_subs [0|1] (default: 1)
Display subscripts (as [thing]).
document.html.display_sups [0|1] (default: 1)
Display superscripts (as ^thing).
document.html.link_display <num> (default: 2)
Html link rendering verbosity:
0
is nothing
1
is title
2
is name in addition
3
is hreflang in addition
4
is type in addition
5
is everything
document.html.underline_links [0|1] (default: 0)
Underline links.
document.html.wrap_nbsp [0|1] (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.
Plain rendering (document.plain)
Options concerning the display of plain text pages.
Mailcap search path. Colon-separated list of files.
Leave as "" to use MAILCAP environment variable or
built-in defaults instead.
mime.mailcap.ask [0|1] (default: 1)
Ask before using the handlers defined by mailcap.
mime.mailcap.description <num> (default: 0)
Type of description to show in "what shall I do with this file"
query dialog:
0
is show "mailcap".
1
is show program to be run.
2
is show mailcap description field if any; "mailcap" otherwise.
mime.mailcap.prioritize [0|1] (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.
Mimetypes files (mime.mimetypes)
Options for the support of mimetypes files. Mimetypes files
can be used to find the content type of an URL by looking at the
extension of the file name.
mime.mimetypes.enable [0|1] (default: 1)
Enable mime.types support.
mime.mimetypes.path <str>
(default: "~/.mime.types:/etc/mime.types:/usr/etc/mime.types:/usr/local/etc/mime.types:/usr/share/mime.types:/usr/share/misc/mime.types")
Mimetypes search path. Colon-separated list of files.
Leave as "" to use built-in default instead.
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>).
Template option folder (mime.type._template_)
Handler matching this MIME-type class ('*' is used here in place
of '.').
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.
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.
Host and port-number (host:port) of the HTTP proxy, or blank.
If it's blank, HTTP_PROXY environment variable is checked as well.
protocol.http.proxy.user <str> (default: "")
Proxy authentication username.
protocol.http.proxy.passwd <str> (default: "")
Proxy authentication password.
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.
protocol.http.referer.policy <num> (default: 1)
Mode of sending HTTP referer:
0
is send no referer
1
is send current URL as referer
2
is send fixed fake referer
3
is send previous URL as referer (correct, but insecure)
Request localised versions of documents from web-servers (using the
Accept-Language header) using the language you have configured for
ELinks' user-interface. Note that some see this as a potential security
risk because it tells web-masters about your preference in language.
protocol.http.trace [0|1] (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.
Change the User Agent ID. That means identification string, which
is sent to HTTP server when a document is requested.
%v in the string means ELinks version
%s in the string means system identification
%t in the string means size of the terminal
Use " " if you don't want any User-Agent header to be sent at all.
HTTPS (protocol.https)
HTTPS-specific options.
Proxy configuration (protocol.https.proxy)
HTTPS proxy configuration.
protocol.https.proxy.host <str> (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.
Mailcap (protocol.mailcap)
Options for mailcap support. (Deprecated. Please use
mime.mailcap instead)
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.
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 '%'
protocol.rewrite.enable-dumb [0|1] (default: 1)
Enable dumb prefixes.
protocol.rewrite.enable-smart [0|1] (default: 1)
Enable smart prefixes.
User protocols (protocol.user)
User protocols. Options in this tree specify external
handlers for the appropriate protocols. Ie.
protocol.user.mailto.unix.
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).
Handler (external program) for this protocol and system.
%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
protocol.no_proxy <str> (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.
Terminals (terminal)
Terminal options.
Template option folder (terminal._template_)
Options specific to this terminal type (according to $TERM value).
terminal._template_.type <num> (default: 0)
Terminal type; matters mostly only when drawing frames and
dialog box borders:
0
is dumb terminal type, ASCII art
1
is VT100, simple but portable
2
is Linux, you get double frames and other goodies
3
is KOI-8
4
is FreeBSD
terminal._template_.m11_hack [0|1] (default: 0)
Switch fonts when drawing lines, enabling both local characters
and lines working at the same time. Makes sense only with linux
terminal.
terminal._template_.utf_8_io [0|1] (default: 0)
Enable I/O in UTF8 for Unicode terminals. Note that currently,
only the subset of UTF8 according to terminal codepage is used.
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.
terminal._template_.colors <num> (default: 0)
The color mode controls what colors are used and how they are
output to the terminal. The color modes are:
0
is mono mode, only 2 colors are used
1
is 16 color mode, uses the common ANSI colors
2
is 256 color mode, requires that xterm-256color TERM is used
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.
terminal._template_.underline [0|1] (default: 0)
If we should use underline or enhance the color instead.
Dialogs-specific appearance and behaviour settings.
ui.dialogs.listbox_min_height <num> (default: 10)
Minimal height of the listbox widget (used e.g. for bookmarks
or global history).
ui.dialogs.shadows [0|1] (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.
ui.dialogs.underline_hotkeys [0|1] (default: 0)
Whether to underline hotkeys in menus to make them more
visible. Requires the underlining is enabled for the terminal.
LEDs (ui.leds)
LEDs (visual indicators) options.
ui.leds.enable [0|1] (default: 1)
Enable LEDs.
These visual indicators will inform you about various states.
Sessions (ui.sessions)
Sessions settings.
ui.sessions.auto_save [0|1] (default: 0)
Automatically save the session when quitting.
This feature requires bookmark support.
ui.sessions.auto_restore [0|1] (default: 0)
Automatically restore the session at start.
This feature requires bookmark support.
Name of the bookmarks folder used for auto saving and restoring session.
This only makes sense with bookmark support.
ui.sessions.homepage <str> (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
used as homepage URI instead.
Window tabs (ui.tabs)
Window tabs settings.
ui.tabs.show_bar <num> (default: 1)
Show tabs bar on the screen:
0
means never.
1
means only if two or more tabs.
2
means always.
ui.tabs.wraparound [0|1] (default: 1)
When moving right from the last tab, jump at the first one, and
vice versa.
ui.tabs.confirm_close [0|1] (default: 0)
When closing a tab show confirmation dialog.
Timer options (ui.timer)
Timed action after certain interval of user inactivity. Someone can
even find this useful, although you may not believe that.
ui.timer.enable <num> (default: 0)
Whether to enable the timer or not:
0
is don't count down anything
1
is count down, but don't show the timer
2
is count down and show the timer near LEDs
ui.timer.duration <num> (default: 86400)
Inactivity timeout. One day should be enough for just everyone (TM).
ui.timer.action <str> (default: "")
Key-binding action to be triggered when timer reaches zero.
ui.language <language> (default: "System")
Language of user interface. System means that the language will
be extracted from the environment dynamically.
ui.show_status_bar [0|1] (default: 1)
Show status bar on the screen.
ui.show_title_bar [0|1] (default: 1)
Show title bar on the screen.
ui.startup_goto_dialog [0|1] (default: 1)
Pop up goto dialog on startup when there's no homepage set.
ui.success_msgbox [0|1] (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.
ui.window_title [0|1] (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.
secure_file_saving [0|1] (default: 1)
First write data to 'file.tmp', then rename to 'file' upon
successfully finishing this. Note that this relates only to
config files, not downloaded files. You may want to disable
it, if you want some config file with some exotic permissions.
Secure file saving is automagically disabled if file is symlink.
DOCUMENT INFO
Generated by help2doc (Revision: 1.10) on 08 January 04 using output from ELinks version 0.9.0.CVS.
help2doc is distributed with ELinks under the terms of the GPL.
