.\" elinks.conf.5.\".\" Generated by help2doc (Revision: 1.15) on 02 May 05 using output from ELinks version 0.10.4.CVS..\".\" Copyleft (c) 2002-2004 The ELinks project.\".\" This file may be distributed under the terms of the GNU.\" General Public License. <www.gnu.org/licenses/gpl.html>.\".\" Process this file with groff -man -Tascii elinks.conf.5.TH ELINKS.CONF 5 "02 May 05".SH NAMEelinks.conf \- ELinks configuration file.SH DESCRIPTION.PPThe .B elinks.conffile contains configurationinformation for ELinks.  It can be used to configure the behaviour ofELinks in a wide variety of ways: protocol behaviour, keybindings,colors used for rendering and for the user interface..PPIt is read at startup and saved only when requested. All optionsdescribed in this document can be fully configured from within ELinksso no editing of elinks.conf is needed..PPNote that MIME-related options used for specifying handlers of variousMIME types are NOT described in this document. Documentation for theseoptions can be found at the ELinks homepage. Keybindings can also bespecified in elinks.conf. This is described in the elinkskeys(5) manpage..SH SYNTAX.PPThe syntax of the configuration file is very simple. The elinks.conf file isa free-form ASCII text file. The file may contain extra tabs andnewlines for formatting purposes. Keywords in the file arecase-sensitive. Comments may be placed anywhere within the file (exceptwithin quotes). Comments begin with the # character and end at the endof the line..SH EXAMPLESSome sample settings:.IP.nf# 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 handlersset protocol.user.mailto.unix = "mutt %h -s "%s"".SH OPTIONS.SS Bookmarks (bookmarks)Bookmark options..TP\f3bookmarks.file_format\f2 <num>\f1 (default: 0)File format for bookmarks (affects both reading and saving):.RS.PD 0.TP.B 0is the default native ELinks format.TP.B 1is XBEL universal XML bookmarks format (NO NATIONAL CHARS SUPPORT!).PD.RE.TP\f3bookmarks.folder_state\f2 [0|1]\f1 (default: 1)When saving bookmarks also store whether folders areexpanded or not, so the look of the bookmark dialog iskept across ELinks sessions. If disabled all folders willappear unexpanded next time ELinks is run..SS Configuration system (config)Configuration handling options..TP\f3config.comments\f2 <num>\f1 (default: 3)Amount of comments automatically written to the config file:.RS.PD 0.TP.B 0is no comments are written.TP.B 1is only the "blurb" (name+type) is written.TP.B 2is only the description is written.TP.B 3is full comments are written.PD.RE.TP\f3config.indentation\f2 <num>\f1 (default: 2)Shift width of one indentation level in the configurationfile. Zero means that no indentation is performed at allwhen saving the configuration..PD.RE.TP\f3config.saving_style\f2 <num>\f1 (default: 3)Determines what happens when you tell ELinks to save options:.RS.PD 0.TP.B 0is only values of current options are altered.TP.B 1is values of current options are altered and missing optionsare added at the end of the file.TP.B 2is the configuration file is rewritten from scratch.TP.B 3is values of current options are altered and missing optionsCHANGED during this ELinks session are added at the end ofthe file.PD.RE.TP\f3config.i18n\f2 [0|1]\f1 (default: 0)If set to 1, comments in the configuration file will betranslated to the language used by UI. Note that if you havedifferent language set in different terminals, the languageused in the configuration file MAY be the same as on theterminal where you saved the file, but it should be generallyconsidered unpredictable..TP\f3config.saving_style_w\f2 [0|1]\f1 (default: 0)This is internal option used when displaying a warning aboutobsolete config.saving_style. You shouldn't touch it..TP\f3config.show_template\f2 [0|1]\f1 (default: 0)Show template options in autocreated trees in the optionsmanager and save them to the configuration file..SS Connections (connection)Connection options..SS SSL (connection.ssl)SSL options..SS Client Certificates (connection.ssl.client_cert)X509 client certificate options..TP\f3connection.ssl.client_cert.enable\f2 [0|1]\f1 (default: 0)Enable or not the sending of X509 client certificatesto servers which request them..TP\f3connection.ssl.client_cert.file\f2 <str>\f1 (default: "")The location of a file containing the client certificateand unencrypted private key in PEM format. If unset, thefile pointed to by the X509_CLIENT_CERT variable is usedinstead..TP\f3connection.ssl.cert_verify\f2 [0|1]\f1 (default: 0)Verify the peer's SSL certificate. Note that thisneeds extensive configuration of OpenSSL by the user..TP\f3connection.async_dns\f2 [0|1]\f1 (default: 1)Whether to use asynchronous DNS resolving..TP\f3connection.max_connections\f2 <num>\f1 (default: 10)Maximum number of concurrent connections..PD.RE.TP\f3connection.max_connections_to_host\f2 <num>\f1 (default: 2)Maximum number of concurrent connections to a given host..PD.RE.TP\f3connection.receive_timeout\f2 <num>\f1 (default: 120)Receive timeout (in seconds)..PD.RE.TP\f3connection.retries\f2 <num>\f1 (default: 3)Number of tries to establish a connection.Zero means try forever..PD.RE.TP\f3connection.try_ipv4\f2 [0|1]\f1 (default: 1)Whether to try to connect to a host over IPv4.Note that if connection.try_ipv6 is enabled too,it takes precedence. And better do not touch thisat all unless you are sure what are you doing.Note that you can also force a given protocolto be used on a per-connection basis by using an URLin the style of i.e. http4://elinks.or.cz/..TP\f3connection.try_ipv6\f2 [0|1]\f1 (default: 1)Whether to try to connect to a host over IPv6.Note that you can also force a given protocolto be used on a per-connection basis by using an URLin the style of i.e. http6://elinks.or.cz/..TP\f3connection.unrestartable_receive_timeout\f2 <num>\f1 (default: 600)Timeout for non-restartable connections (in seconds)..PD.RE.SS Cookies (cookies)Cookies options..TP\f3cookies.accept_policy\f2 <num>\f1 (default: 2)Cookies accepting policy:.RS.PD 0.TP.B 0is accept no cookies.TP.B 1is ask for confirmation before accepting cookie.TP.B 2is accept all cookies.PD.RE.TP\f3cookies.max_age\f2 <num>\f1 (default: -1)Cookie maximum age (in days):.RS.PD 0.TP.B -1is use cookie's expiration date if any.TP.B 0is force expiration at the end of session, ignoring cookie'sexpiration date.TP.B 1+ is use cookie's expiration date, but limit age to the givennumber of days.PD.RE.TP\f3cookies.paranoid_security\f2 [0|1]\f1 (default: 0)When enabled, we'll require three dots in cookies domain for allnon-international domains (instead of just two dots). Some countrieshave generic second level domains (eg. .com.pl, .co.uk) and allowingsites to set cookies for these generic domains could potentially bevery bad. Note, it is off by default as it breaks a lot of sites..TP\f3cookies.save\f2 [0|1]\f1 (default: 1)Whether cookies should be loaded from and save to disk..TP\f3cookies.resave\f2 [0|1]\f1 (default: 1)Save cookies after each change in cookies list? No effect whencookie saving (cookies.save) is off..SS Document (document)Document options..SS Browsing (document.browse)Document browsing options (mainly interactivity)..SS Access keys (document.browse.accesskey)Options for handling of link access keys.An HTML document can use the ACCESSKEY attribute to assignan access key to an element. When an access key is pressed,the corresponding element will be given focus..TP\f3document.browse.accesskey.auto_follow\f2 [0|1]\f1 (default: 0)Automatically follow a link or submit a form if appropriateaccesskey is pressed - this is the standard behaviour, but it'sconsidered dangerous..TP\f3document.browse.accesskey.display\f2 [0|1]\f1 (default: 0)Display access key in link info..TP\f3document.browse.accesskey.priority\f2 <num>\f1 (default: 0)Priority of 'accesskey' HTML attribute:.RS.PD 0.TP.B 0is first try all normal bindings; if it fails, check accesskey.TP.B 1is first try only frame bindings; if it fails, check accesskey.TP.B 2is first check accesskey (this can be dangerous).PD.RE.SS Forms (document.browse.forms)Options for handling of the forms interaction..TP\f3document.browse.forms.auto_submit\f2 [0|1]\f1 (default: 1)Automagically submit a form when enter is pressed with a textfield selected..TP\f3document.browse.forms.confirm_submit\f2 [0|1]\f1 (default: 1)Ask for confirmation when submitting a form..TP\f3document.browse.forms.input_size\f2 <num>\f1 (default: 20)Default form input size if none is specified..PD.RE.TP\f3document.browse.forms.insert_mode\f2 [0|1]\f1 (default: 1)The setting for this option affects how key presses are handledwhen one selects a text-input form-field. When enabled, one mustexplicitly 'enter' a selected text-field to edit it; this preventsa text field from capturing key presses, such as presses of a scroll key,when it is inadvertently selected. When disabled, key presses are alwaysinserted into a selected text field..TP\f3document.browse.forms.show_formhist\f2 [0|1]\f1 (default: 0)Ask if a login form should be saved to file or not.This option only disables the dialog, already saved loginforms are unaffected..SS Images (document.browse.images)Options for handling of images..TP\f3document.browse.images.display_style\f2 <num>\f1 (default: 2)Display style for image tags when displayed:.RS.PD 0.TP.B 0means always display IMG.TP.B 1means always display filename.TP.B 2means display alt/title attribute if possible, IMG if not.TP.B 3means display alt/title attribute if possible, filename if not.PD.RE.TP\f3document.browse.images.filename_maxlen\f2 <num>\f1 (default: 0)Maximum length of image filename when displayed:.RS.PD 0.TP.B 0means always display full filename.TP.B 1-500means display filename with this maximal length;if it is longer, the middle is substituted by an asterisk.PD.RE.TP\f3document.browse.images.image_link_tagging\f2 <num>\f1 (default: 1)When to enclose image links:.RS.PD 0.TP.B 0means never.TP.B 1means never if alt or title are provided (old behavior).TP.B 2means always.PD.RE.TP\f3document.browse.images.image_link_prefix\f2 <str>\f1 (default: "[")Prefix string to use to mark image links..TP\f3document.browse.images.image_link_suffix\f2 <str>\f1 (default: "]")Suffix string to use to mark image links..TP\f3document.browse.images.label_maxlen\f2 <num>\f1 (default: 0)Maximum length of image label (alt/title):.RS.PD 0.TP.B 0means always display full label.TP.B 1-500means display label with this maximal length;if it is longer, the middle is substituted by an asterisk