doc/elinks.conf.5.txt

   1 elinks.conf(5)
   2 ==============
   3 :Description:   ELinks configuration file
   4
   5 NAME
   6 ----
   7 elinks.conf - ELinks configuration file
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 set     "<option>" = <value>
  13 unset   "<option>" = <value>
  14 bind    "<keymap>" "<key>" = "<action>"
  15 include "<file>"
  16
  17 DESCRIPTION
  18 -----------
  19
  20 The `elinks.conf` file contains configuration information for ELinks.  It can
  21 be used to configure the behaviour of ELinks in a wide variety of ways:
  22 protocol behaviour, keybindings, colors used for rendering and for the user
  23 interface.
  24
  25 It is read at startup and saved only when requested. All options described in
  26 this document can be fully configured from within ELinks so no editing of
  27 elinks.conf is needed.
  28
  29 Note that MIME-related options used for specifying handlers of various MIME
  30 types are NOT described in this document. Documentation for these options can
  31 be found at the ELinks homepage. Keybindings can also be specified in
  32 elinks.conf.  This is described in man:elinkskeys[5].
  33
  34 SYNTAX
  35 ------
  36
  37 The syntax of the configuration file is very simple. The elinks.conf file is a
  38 free-form ASCII text file. The file may contain extra tabs and newlines for
  39 formatting purposes. Keywords in the file are case-sensitive. Comments may be
  40 placed anywhere within the file (except within quotes). Comments begin with
  41 the # character and end at the end of the line.
  42
  43 EXAMPLES
  44 --------
  45
  46 Some sample settings:
  47
  48         # Use asynchronous DNS resolver?
  49         set connection.async_dns = 1
  50         # horizontal text margin.
  51         set document.browse.margin_width = 3
  52         # Default document codepage.
  53         set document.codepage.assume = "ISO-8859-1"
  54         # User defined protocol handlers
  55         set protocol.user.mailto.unix = "mutt %h -s \e\*(lq%s\e\*(rq"
  56
  57 OPTIONS
  58 -------
  59 include::{builddir}option-config.txt[]
  60
  61 SEE ALSO
  62 --------
  63 man:elinks[1], man:elinkskeys[5]