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 include::{builddir}option-command.txt[]
  39
  40 ENVIRONMENT VARIABLES
  41 ---------------------
  42
  43 COMSPEC, SHELL::
  44
  45         The shell used for File -> OS Shell on DOS/Windows and UNIX,
  46         respectively.
  47
  48 EDITOR::
  49
  50         The program to use for external editor (when editing textareas).
  51
  52 ELINKS_CONFDIR::
  53
  54         The location of the directory containing configuration files.  If not
  55         set the default is `~/.elinks/`.
  56
  57 ELINKS_TWTERM, LINKS_TWTERM::
  58
  59         The command to run when selecting File -> New window and if
  60         `TWDISPLAY` is defined (default `twterm -e`)
  61
  62 ELINKS_XTERM, LINKS_XTERM::
  63
  64         The command to run when selecting File -> New window and if `DISPLAY`
  65         is defined (default `xterm -e`)
  66
  67 FTP_PROXY, HTTP_PROXY, HTTPS_PROXY::
  68
  69         The host to proxy the various protocol traffic through.
  70
  71 NO_PROXY::
  72
  73         A comma separated list of URLs which should not be proxied.
  74
  75 HOME::
  76
  77         The path to the users home directory. Used when expanding `~/`.
  78
  79 WWW_HOME::
  80
  81         Homepage location (as in man:lynx[1]).
  82
  83 FILES
  84 -----
  85
  86 @sysconfdir@/elinks.conf::
  87         Site-wide configuration file.
  88
  89 ~/.elinks/elinks.conf::
  90         Per-user config file, loaded after site-wide configuration.
  91
  92 ~/.elinks/bookmarks::
  93         Bookmarks file.
  94
  95 ~/.elinks/cookies::
  96         Cookies file.
  97
  98 ~/.elinks/exmodehist::
  99         Exmode history file.
 100
 101 ~/.elinks/formhist::
 102         Form history file.
 103
 104 ~/.elinks/globhist::
 105         History file containing most recently visited URLs.
 106
 107 ~/.elinks/gotohist::
 108         GoTo URL dialog history file.
 109
 110 ~/.elinks/hooks.{js,lua,pl,py,rb,scm}::
 111         Browser scripting hooks.
 112
 113 ~/.elinks/searchhist::
 114         Search history file.
 115
 116 ~/.elinks/socket::
 117         Internal 'ELinks' socket for communication between its instances.
 118
 119 ~/.mailcap::
 120         Mappings of MIME types to external handlers.
 121
 122 ~/.mime.types::
 123         Mappings of file extensions to MIME types.
 124
 125 Other files that ELinks uses from '~/.elinks/' includes the user defined CSS
 126 stylesheet. The name of the file can set in the 'document.css.stylesheet'
 127 option.
 128
 129 PLATFORMS
 130 ---------
 131
 132 'ELinks' is known to work on 'Linux', 'FreeBSD', 'OpenBSD', 'Solaris', 'IRIX',
 133 'HPUX', 'Digital Unix', 'AIX', 'OS/2', 'BeOS' and 'RISC OS'. Port for 'Win32'
 134 is in state of beta testing.
 135
 136 BUGS
 137 ----
 138
 139 Please report any other bugs you find to the either the ELinks mailing list at
 140 mailto:elinks-users@linuxfromscratch.org[] or if you prefer enter them into
 141 http://bugzilla.elinks.cz/[the bug tracking system]. More information about
 142 how to get in contact with developers and getting help can be found on
 143 http://elinks.cz/community.html[the community page].
 144
 145 LICENSE
 146 -------
 147
 148 'ELinks' is free software; you can redistribute it and/or modify it under the
 149 terms of http://www.gnu.org/copyleft/gpl.html[the GNU General Public License]
 150 as published by the Free Software Foundation; version 2 of the License.
 151
 152 AUTHORS
 153 -------
 154
 155 The 'Links' browser - on which 'ELinks' is based - was written by Mikulas
 156 Patocka mailto:mikulas@artax.karlin.mff.cuni.cz[]. 'ELinks' was written by
 157 Petr Baudis mailto:pasky@ucw.cz[]. See file `AUTHORS` in the source tree for a
 158 list of people contributing to this project.
 159
 160 This manual page was written by Peter Gervai mailto:grin@tolna.net[], using
 161 excerpts from a (yet?) unknown 'Links' fan for the 'Debian GNU/Linux system'
 162 (but may be used by others). Contributions from Francis A. Holop. Extended,
 163 clarified and made more up-to-date by Petr Baudis mailto:pasky@ucw.cz[].
 164 Updated by Zas mailto:zas@norz.org[]. The conversion to Asciidoc and trimming
 165 was done by Jonas Fonseca mailto:fonseca@diku.dk[].
 166
 167 SEE ALSO
 168 --------
 169
 170 man:elinkskeys[5], man:elinks.conf[5], man:links[1], man:lynx[1], man:w3m[1],
 171 man:wget[1]
 172
 173 ////////////////////////////////////////////////////////////////////////////
 174 # vim: tabstop=4 shiftwidth=4 textwidth=76
 175 ////////////////////////////////////////////////////////////////////////////