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 configured from within ELinks. Editing of elinks.conf is
  28 needed only if you want to override the values of some options in individual
  29 domains (`set_domain`).
  30
  31 Note that MIME-related options used for specifying handlers of various MIME
  32 types are NOT described in this document. Documentation for these options can
  33 be found at the ELinks homepage. Keybindings can also be specified in
  34 elinks.conf.  This is described in man:elinkskeys[5].
  35
  36 SYNTAX
  37 ------
  38
  39 The syntax of the configuration file is very simple. The elinks.conf file is a
  40 free-form ASCII text file. The file may contain extra tabs and newlines for
  41 formatting purposes. Keywords in the file are case-sensitive. Comments may be
  42 placed anywhere within the file (except within quotes). Comments begin with
  43 the # character and end at the end of the line.
  44
  45 EXAMPLES
  46 --------
  47
  48 Some sample settings:
  49
  50         # Use asynchronous DNS resolver?
  51         set connection.async_dns = 1
  52         # horizontal text margin.
  53         set document.browse.margin_width = 3
  54         # Default document codepage.
  55         set document.codepage.assume = "ISO-8859-1"
  56         # User defined protocol handlers
  57         set protocol.user.mailto.unix = "mutt %h -s \"%s\""
  58
  59 OPTIONS
  60 -------
  61
  62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  63 ifdef::backend-docbook[]
  64 include1::{builddir}option-config.frag.xml[]
  65 endif::backend-docbook[]
  66 ifdef::backend-xhtml11[]
  67 include1::{builddir}option-config.frag.xhtml[]
  68 endif::backend-xhtml11[]
  69 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  70
  71 // The OpenSSL license requires the following acknowledgements in all
  72 // advertising materials that mention features of OpenSSL.  The web
  73 // pages at http://elinks.cz/ might be thought of as advertising, and
  74 // the documentation of the connection.ssl.cert_verify option mentions
  75 // a feature of OpenSSL.  So include the acknowledgements in the HTML
  76 // web page that documents the options.
  77 ifdef::man-webpage[]
  78
  79 ACKNOWLEDGEMENTS
  80 ----------------
  81
  82 If ELinks was configured to use OpenSSL, then the following apply:
  83
  84 - This product includes software developed by the OpenSSL Project
  85   for use in the OpenSSL Toolkit. (http://www.openssl.org/)
  86
  87 - This product includes cryptographic software written by
  88   Eric Young (eay@cryptsoft.com)
  89
  90 endif::man-webpage[]
  91
  92 SEE ALSO
  93 --------
  94 man:elinks[1], man:elinkskeys[5]