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