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