doc/elinks.1.txt

   1 elinks(1)
   2 =========
   3 :Description:   The Elinks text-browser
   4
   5 NAME
   6 ----
   7 elinks - lynx-like alternative character mode WWW browser
   8
   9 SYNOPSIS
  10 --------
  11 'elinks' [OPTION]... [URL]...
  12
  13 DESCRIPTION
  14 -----------
  15
  16 'ELinks' is a text mode WWW browser, supporting colors, table rendering,
  17 background downloading, menu driven configuration interface, tabbed browsing
  18 and slim code.
  19
  20 Frames are supported. You can have different file formats associated with
  21 external viewers. `mailto:` and `telnet:` are supported via external clients.
  22
  23 ELinks  can handle both local files and remote URLs. The main supported remote
  24 URL protocols are 'HTTP', 'HTTPS' (with SSL support compiled in) and 'FTP'.
  25 Additional  protocol  support  exists for 'BitTorrent' 'finger', 'Gopher',
  26 'SMB' and 'NNTP'.
  27
  28 The homepage of 'ELinks' can be found at http://elinks.cz/[], where the ELinks
  29 manual is also hosted.
  30
  31 OPTIONS
  32 -------
  33
  34 Most options can be set in the user interface or config file, so usually you
  35 do not need to care about them. Note that this list is roughly equivalent to
  36 the output of running ELinks with the option `--long-help`.
  37
  38 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  39 ifdef::backend-docbook[]
  40 include1::{builddir}option-command.frag.xml[]
  41 endif::backend-docbook[]
  42 ifdef::backend-xhtml11[]
  43 include1::{builddir}option-command.frag.xhtml[]
  44 endif::backend-xhtml11[]
  45 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  46
  47 ENVIRONMENT VARIABLES
  48 ---------------------
  49
  50 COMSPEC, SHELL::
  51
  52         The shell used for File -> OS Shell on DOS/Windows and UNIX,
  53         respectively.
  54
  55 EDITOR::
  56
  57         The program to use for external editor (when editing textareas).
  58
  59 ELINKS_CONFDIR::
  60
  61         The location of the directory containing configuration files.  If not
  62         set the default is `~/.elinks/`.
  63
  64 ELINKS_TWTERM, LINKS_TWTERM::
  65
  66         The command to run when selecting File -> New window and if
  67         `TWDISPLAY` is defined (default `twterm -e`).
  68
  69 ELINKS_XTERM, LINKS_XTERM::
  70
  71         The command to run when selecting File -> New window and if `DISPLAY`
  72         is defined (default `xterm -e`).
  73
  74 FTP_PROXY, HTTP_PROXY, HTTPS_PROXY::
  75
  76         The host to proxy the various protocol traffic through.
  77
  78 NO_PROXY::
  79
  80         A comma separated list of URLs which should not be proxied.
  81
  82 HOME::
  83
  84         The path to the users home directory. Used when expanding `~/`.
  85
  86 WWW_HOME::
  87
  88         Homepage location (as in otherman:lynx[1]).
  89
  90 FILES
  91 -----
  92
  93 Configuration files controlled by ELinks are located in the user
  94 configuration directory, defaulting to '~/.elinks/'. In addition to the
  95 files listed below, a user defined CSS stylesheet can be defined using
  96 the 'document.css.stylesheet' option.
  97
  98 @sysconfdir@/elinks.conf::
  99         Site-wide configuration file.
 100
 101 ~/.elinks/elinks.conf::
 102         Per-user config file, loaded after site-wide configuration.
 103
 104 ~/.elinks/bookmarks::
 105         Bookmarks file.
 106
 107 ~/.elinks/cookies::
 108         Cookies file.
 109
 110 ~/.elinks/exmodehist::
 111         Exmode history file.
 112
 113 ~/.elinks/formhist::
 114         Form history file.
 115
 116 ~/.elinks/globhist::
 117         History file containing most recently visited URLs.
 118
 119 ~/.elinks/gotohist::
 120         GoTo URL dialog history file.
 121
 122 ~/.elinks/hooks.{js,lua,pl,py,rb,scm}::
 123         Browser scripting hooks.
 124
 125 ~/.elinks/searchhist::
 126         Search history file.
 127
 128 ~/.elinks/socket::
 129         Internal 'ELinks' socket for communication between its instances.
 130
 131 ~/.mailcap, /etc/mailcap::
 132         Mappings of MIME types to external handlers.
 133
 134 ~/.mime.types, /etc/mime.types::
 135         Mappings of file extensions to MIME types.
 136
 137 //////////////////////////////////////////////////////////////////////////////
 138 // Commented out since it's neither super useful nor manpage material. --jonas
 139
 140 PLATFORMS
 141 ---------
 142
 143 'ELinks' is known to work on 'Linux', 'FreeBSD', 'OpenBSD', 'Solaris', 'IRIX',
 144 'HPUX', 'Digital Unix', 'AIX', 'OS/2', 'BeOS' and 'RISC OS'. Port for 'Win32'
 145 is in state of beta testing.
 146 //////////////////////////////////////////////////////////////////////////////
 147
 148 BUGS
 149 ----
 150
 151 Please report any other bugs you find to the either the ELinks mailing list at
 152 mailto:elinks-users@linuxfromscratch.org[] or if you prefer enter them into
 153 http://bugzilla.elinks.cz/[the bug tracking system]. More information about
 154 how to get in contact with developers and getting help can be found on
 155 http://elinks.cz/community.html[the community page].
 156
 157 LICENSE
 158 -------
 159
 160 'ELinks' is free software; you can redistribute it and/or modify it under the
 161 terms of http://www.gnu.org/licenses/old-licenses/gpl-2.0.html[the GNU General Public License]
 162 as published by the Free Software Foundation; version 2 of the License.
 163
 164 AUTHORS
 165 -------
 166
 167 The 'Links' browser - on which 'ELinks' is based - was written by Mikulas
 168 Patocka mailto:mikulas@artax.karlin.mff.cuni.cz[]. 'ELinks' was written by
 169 Petr Baudis mailto:pasky@ucw.cz[]. See file `AUTHORS` in the source tree for a
 170 list of people contributing to this project.
 171
 172 This manual page was written by Peter Gervai mailto:grin@tolna.net[], using
 173 excerpts from a (yet?) unknown 'Links' fan for the 'Debian GNU/Linux system'
 174 (but may be used by others). Contributions from Francis A. Holop. Extended,
 175 clarified and made more up-to-date by Petr Baudis mailto:pasky@ucw.cz[].
 176 Updated by Zas mailto:zas@norz.org[]. The conversion to Asciidoc and trimming
 177 was done by Jonas Fonseca mailto:fonseca@diku.dk[].
 178
 179 SEE ALSO
 180 --------
 181
 182 man:elinkskeys[5], man:elinks.conf[5], otherman:links[1], otherman:lynx[1],
 183 otherman:w3m[1], otherman:wget[1]
 184
 185 ////////////////////////////////////////////////////////////////////////////
 186 # vim: tabstop=4 shiftwidth=4 textwidth=76
 187 ////////////////////////////////////////////////////////////////////////////