1
0
mirror of https://github.com/rkd77/elinks.git synced 2024-11-04 08:17:17 -05:00
elinks/doc/elinks.conf.5.txt
Kalle Olavi Niemitalo 1208a8dd2a bug 15, doc: Option manager doesn't support domain-specific
Mention in elinks.conf.5 that there's one reason to edit elinks.conf:
the option manager doesn't yet support domain-specific options,
so any set_domain statements have to be added with an editor.
2009-08-23 04:12:19 +03:00

95 lines
2.9 KiB
Plaintext

elinks.conf(5)
==============
:Description: ELinks configuration file
NAME
----
elinks.conf - ELinks configuration file
SYNOPSIS
--------
[verse]
set <option> = <value>
set_domain <domain> <option> = <value>
unset <option>
bind "<keymap>" "<key>" = "<action>"
include "<file>"
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 configured from within ELinks. Editing of elinks.conf is
needed only if you want to override the values of some options in individual
domains (`set_domain`).
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 man:elinkskeys[5].
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
-------
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
ifdef::backend-docbook[]
include1::{builddir}option-config.frag.xml[]
endif::backend-docbook[]
ifdef::backend-xhtml11[]
include1::{builddir}option-config.frag.xhtml[]
endif::backend-xhtml11[]
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
// The OpenSSL license requires the following acknowledgements in all
// advertising materials that mention features of OpenSSL. The web
// pages at http://elinks.cz/ might be thought of as advertising, and
// the documentation of the connection.ssl.cert_verify option mentions
// a feature of OpenSSL. So include the acknowledgements in the HTML
// web page that documents the options.
ifdef::man-webpage[]
ACKNOWLEDGEMENTS
----------------
If ELinks was configured to use OpenSSL, then the following apply:
- This product includes software developed by the OpenSSL Project
for use in the OpenSSL Toolkit. (http://www.openssl.org/)
- This product includes cryptographic software written by
Eric Young (eay@cryptsoft.com)
endif::man-webpage[]
SEE ALSO
--------
man:elinks[1], man:elinkskeys[5]