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 otherman:lynx[1]).
  82
  83 FILES
  84 -----
  85
  86 Configuration files controlled by ELinks are located in the user
  87 configuration directory, defaulting to '~/.elinks/'. In addition to the
  88 files listed below, a user defined CSS stylesheet can be defined using
  89 the 'document.css.stylesheet' option.
  90
  91 @sysconfdir@/elinks.conf::
  92         Site-wide configuration file.
  93
  94 ~/.elinks/elinks.conf::
  95         Per-user config file, loaded after site-wide configuration.
  96
  97 ~/.elinks/bookmarks::
  98         Bookmarks file.
  99
 100 ~/.elinks/cookies::
 101         Cookies file.
 102
 103 ~/.elinks/exmodehist::
 104         Exmode history file.
 105
 106 ~/.elinks/formhist::
 107         Form history file.
 108
 109 ~/.elinks/globhist::
 110         History file containing most recently visited URLs.
 111
 112 ~/.elinks/gotohist::
 113         GoTo URL dialog history file.
 114
 115 ~/.elinks/hooks.{js,lua,pl,py,rb,scm}::
 116         Browser scripting hooks.
 117
 118 ~/.elinks/searchhist::
 119         Search history file.
 120
 121 ~/.elinks/socket::
 122         Internal 'ELinks' socket for communication between its instances.
 123
 124 ~/.mailcap, /etc/mailcap::
 125         Mappings of MIME types to external handlers.
 126
 127 ~/.mime.types, /etc/mime.types::
 128         Mappings of file extensions to MIME types.
 129
 130 //////////////////////////////////////////////////////////////////////////////
 131 // Commented out since it's neither super useful nor manpage material. --jonas
 132
 133 PLATFORMS
 134 ---------
 135
 136 'ELinks' is known to work on 'Linux', 'FreeBSD', 'OpenBSD', 'Solaris', 'IRIX',
 137 'HPUX', 'Digital Unix', 'AIX', 'OS/2', 'BeOS' and 'RISC OS'. Port for 'Win32'
 138 is in state of beta testing.
 139 //////////////////////////////////////////////////////////////////////////////
 140
 141 BUGS
 142 ----
 143
 144 Please report any other bugs you find to the either the ELinks mailing list at
 145 mailto:elinks-users@linuxfromscratch.org[] or if you prefer enter them into
 146 http://bugzilla.elinks.cz/[the bug tracking system]. More information about
 147 how to get in contact with developers and getting help can be found on
 148 http://elinks.cz/community.html[the community page].
 149
 150 LICENSE
 151 -------
 152
 153 'ELinks' is free software; you can redistribute it and/or modify it under the
 154 terms of http://www.gnu.org/copyleft/gpl.html[the GNU General Public License]
 155 as published by the Free Software Foundation; version 2 of the License.
 156
 157 AUTHORS
 158 -------
 159
 160 The 'Links' browser - on which 'ELinks' is based - was written by Mikulas
 161 Patocka mailto:mikulas@artax.karlin.mff.cuni.cz[]. 'ELinks' was written by
 162 Petr Baudis mailto:pasky@ucw.cz[]. See file `AUTHORS` in the source tree for a
 163 list of people contributing to this project.
 164
 165 This manual page was written by Peter Gervai mailto:grin@tolna.net[], using
 166 excerpts from a (yet?) unknown 'Links' fan for the 'Debian GNU/Linux system'
 167 (but may be used by others). Contributions from Francis A. Holop. Extended,
 168 clarified and made more up-to-date by Petr Baudis mailto:pasky@ucw.cz[].
 169 Updated by Zas mailto:zas@norz.org[]. The conversion to Asciidoc and trimming
 170 was done by Jonas Fonseca mailto:fonseca@diku.dk[].
 171
 172 SEE ALSO
 173 --------
 174
 175 man:elinkskeys[5], man:elinks.conf[5], otherman:links[1], otherman:lynx[1],
 176 otherman:w3m[1], otherman:wget[1]
 177
 178 ////////////////////////////////////////////////////////////////////////////
 179 # vim: tabstop=4 shiftwidth=4 textwidth=76
 180 ////////////////////////////////////////////////////////////////////////////