mirror of
https://github.com/rkd77/elinks.git
synced 2024-12-04 14:46:47 -05:00
573036a403
The older help2doc script is no longer used for anything. To make future cherry-picking easier, this commit does not include the resulting changes in generated files.
188 lines
5.4 KiB
Plaintext
188 lines
5.4 KiB
Plaintext
elinks(1)
|
|
=========
|
|
:Description: The Elinks text-browser
|
|
|
|
NAME
|
|
----
|
|
elinks - lynx-like alternative character mode WWW browser
|
|
|
|
SYNOPSIS
|
|
--------
|
|
'elinks' [OPTION]... [URL]...
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
'ELinks' is a text mode WWW browser, supporting colors, table rendering,
|
|
background downloading, menu driven configuration interface, tabbed browsing
|
|
and slim code.
|
|
|
|
Frames are supported. You can have different file formats associated with
|
|
external viewers. `mailto:` and `telnet:` are supported via external clients.
|
|
|
|
ELinks can handle both local files and remote URLs. The main supported remote
|
|
URL protocols are 'HTTP', 'HTTPS' (with SSL support compiled in) and 'FTP'.
|
|
Additional protocol support exists for 'BitTorrent' 'finger', 'Gopher',
|
|
'SMB' and 'NNTP'.
|
|
|
|
The homepage of 'ELinks' can be found at http://elinks.cz/[], where the ELinks
|
|
manual is also hosted.
|
|
|
|
OPTIONS
|
|
-------
|
|
|
|
Most options can be set in the user interface or config file, so usually you
|
|
do not need to care about them. Note that this list is roughly equivalent to
|
|
the output of running ELinks with the option `--long-help`.
|
|
|
|
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
ifdef::backend-docbook[]
|
|
include1::{builddir}option-command.frag.xml[]
|
|
endif::backend-docbook[]
|
|
ifdef::backend-xhtml11[]
|
|
include1::{builddir}option-command.frag.xhtml[]
|
|
endif::backend-xhtml11[]
|
|
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
|
|
ENVIRONMENT VARIABLES
|
|
---------------------
|
|
|
|
COMSPEC, SHELL::
|
|
|
|
The shell used for File -> OS Shell on DOS/Windows and UNIX,
|
|
respectively.
|
|
|
|
EDITOR::
|
|
|
|
The program to use for external editor (when editing textareas).
|
|
|
|
ELINKS_CONFDIR::
|
|
|
|
The location of the directory containing configuration files. If not
|
|
set the default is `~/.elinks/`.
|
|
|
|
ELINKS_TWTERM, LINKS_TWTERM::
|
|
|
|
The command to run when selecting File -> New window and if
|
|
`TWDISPLAY` is defined (default `twterm -e`).
|
|
|
|
ELINKS_XTERM, LINKS_XTERM::
|
|
|
|
The command to run when selecting File -> New window and if `DISPLAY`
|
|
is defined (default `xterm -e`).
|
|
|
|
FTP_PROXY, HTTP_PROXY, HTTPS_PROXY::
|
|
|
|
The host to proxy the various protocol traffic through.
|
|
|
|
NO_PROXY::
|
|
|
|
A comma separated list of URLs which should not be proxied.
|
|
|
|
HOME::
|
|
|
|
The path to the users home directory. Used when expanding `~/`.
|
|
|
|
WWW_HOME::
|
|
|
|
Homepage location (as in otherman:lynx[1]).
|
|
|
|
FILES
|
|
-----
|
|
|
|
Configuration files controlled by ELinks are located in the user
|
|
configuration directory, defaulting to '~/.elinks/'. In addition to the
|
|
files listed below, a user defined CSS stylesheet can be defined using
|
|
the 'document.css.stylesheet' option.
|
|
|
|
@sysconfdir@/elinks.conf::
|
|
Site-wide configuration file.
|
|
|
|
~/.elinks/elinks.conf::
|
|
Per-user config file, loaded after site-wide configuration.
|
|
|
|
~/.elinks/bookmarks::
|
|
Bookmarks file.
|
|
|
|
~/.elinks/cookies::
|
|
Cookies file.
|
|
|
|
~/.elinks/exmodehist::
|
|
Exmode history file.
|
|
|
|
~/.elinks/formhist::
|
|
Form history file.
|
|
|
|
~/.elinks/globhist::
|
|
History file containing most recently visited URLs.
|
|
|
|
~/.elinks/gotohist::
|
|
GoTo URL dialog history file.
|
|
|
|
~/.elinks/hooks.{js,lua,pl,py,rb,scm}::
|
|
Browser scripting hooks.
|
|
|
|
~/.elinks/searchhist::
|
|
Search history file.
|
|
|
|
~/.elinks/socket::
|
|
Internal 'ELinks' socket for communication between its instances.
|
|
|
|
~/.mailcap, /etc/mailcap::
|
|
Mappings of MIME types to external handlers.
|
|
|
|
~/.mime.types, /etc/mime.types::
|
|
Mappings of file extensions to MIME types.
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
// Commented out since it's neither super useful nor manpage material. --jonas
|
|
|
|
PLATFORMS
|
|
---------
|
|
|
|
'ELinks' is known to work on 'Linux', 'FreeBSD', 'OpenBSD', 'Solaris', 'IRIX',
|
|
'HPUX', 'Digital Unix', 'AIX', 'OS/2', 'BeOS' and 'RISC OS'. Port for 'Win32'
|
|
is in state of beta testing.
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
|
|
BUGS
|
|
----
|
|
|
|
Please report any other bugs you find to the either the ELinks mailing list at
|
|
mailto:elinks-users@linuxfromscratch.org[] or if you prefer enter them into
|
|
http://bugzilla.elinks.cz/[the bug tracking system]. More information about
|
|
how to get in contact with developers and getting help can be found on
|
|
http://elinks.cz/community.html[the community page].
|
|
|
|
LICENSE
|
|
-------
|
|
|
|
'ELinks' is free software; you can redistribute it and/or modify it under the
|
|
terms of http://www.gnu.org/copyleft/gpl.html[the GNU General Public License]
|
|
as published by the Free Software Foundation; version 2 of the License.
|
|
|
|
AUTHORS
|
|
-------
|
|
|
|
The 'Links' browser - on which 'ELinks' is based - was written by Mikulas
|
|
Patocka mailto:mikulas@artax.karlin.mff.cuni.cz[]. 'ELinks' was written by
|
|
Petr Baudis mailto:pasky@ucw.cz[]. See file `AUTHORS` in the source tree for a
|
|
list of people contributing to this project.
|
|
|
|
This manual page was written by Peter Gervai mailto:grin@tolna.net[], using
|
|
excerpts from a (yet?) unknown 'Links' fan for the 'Debian GNU/Linux system'
|
|
(but may be used by others). Contributions from Francis A. Holop. Extended,
|
|
clarified and made more up-to-date by Petr Baudis mailto:pasky@ucw.cz[].
|
|
Updated by Zas mailto:zas@norz.org[]. The conversion to Asciidoc and trimming
|
|
was done by Jonas Fonseca mailto:fonseca@diku.dk[].
|
|
|
|
SEE ALSO
|
|
--------
|
|
|
|
man:elinkskeys[5], man:elinks.conf[5], otherman:links[1], otherman:lynx[1],
|
|
otherman:w3m[1], otherman:wget[1]
|
|
|
|
////////////////////////////////////////////////////////////////////////////
|
|
# vim: tabstop=4 shiftwidth=4 textwidth=76
|
|
////////////////////////////////////////////////////////////////////////////
|