mirror of
https://github.com/rkd77/elinks.git
synced 2024-09-12 00:34:47 -04:00
336 lines
11 KiB
Groff
336 lines
11 KiB
Groff
.\"Generated by db2man.xsl. Don't modify this, modify the source.
|
|
.de Sh \" Subsection
|
|
.br
|
|
.if t .Sp
|
|
.ne 5
|
|
.PP
|
|
\fB\\$1\fR
|
|
.PP
|
|
..
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Ip \" List item
|
|
.br
|
|
.ie \\n(.$>=3 .ne \\$3
|
|
.el .ne 3
|
|
.IP "\\$1" \\$2
|
|
..
|
|
.TH "ELINKS" 1 "The Elinks text-browser" "2006-06-12" "The Elinks text-browser"
|
|
.SH NAME
|
|
elinks \- lynx-like alternative character mode WWW browser
|
|
.SH "SYNOPSIS"
|
|
|
|
|
|
\fIelinks\fR [OPTION]... [URL]...
|
|
|
|
.SH "DESCRIPTION"
|
|
|
|
|
|
\fIELinks\fR 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 \fIHTTP\fR, \fIHTTPS\fR (with SSL support compiled in) and \fIFTP\fR\&. Additional protocol support exists for \fIBitTorrent\fR \fIfinger\fR, \fIGopher\fR, \fISMB\fR and \fINNTP\fR\&.
|
|
|
|
|
|
The homepage of \fIELinks\fR can be found at <http://elinks\&.cz/>, where the ELinks manual is also hosted\&.
|
|
|
|
.SH "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\&.
|
|
|
|
.TP
|
|
\-anonymous [0|1] (default: 0)
|
|
Restricts \fIELinks\fR so it can run on an anonymous account\&. Local file browsing, downloads, and modification of options will be disabled\&. Execution of viewers is allowed, but entries in the association table can't be added or modified\&.
|
|
|
|
.TP
|
|
\-auto\-submit [0|1] (default: 0)
|
|
Automatically submit the first form in the given URLs\&.
|
|
|
|
.TP
|
|
\-base\-session <num> (default: 0)
|
|
Used internally when opening \fIELinks\fR instances in new windows\&. The ID maps to information that will be used when creating the new instance\&. You don't want to use it\&.
|
|
|
|
.TP
|
|
\-config\-dir <str> (default: "")
|
|
Path of the directory \fIELinks\fR will read and write its config and runtime state files to instead of ~/\&.elinks\&. If the path does not begin with a '/' it is assumed to be relative to your \fIHOME\fR directory\&.
|
|
|
|
.TP
|
|
\-config\-dump
|
|
Print a configuration file with options set to the built\-in defaults to stdout\&.
|
|
|
|
.TP
|
|
\-config\-file <str> (default: "elinks\&.conf")
|
|
Name of the configuration file that all configuration options will be read from and written to\&. It should be relative to config\-dir\&.
|
|
|
|
.TP
|
|
\-config\-help
|
|
Print help for configuration options and exit\&.
|
|
|
|
.TP
|
|
\-default\-mime\-type (alias for mime\&.default_type)
|
|
The default MIME type used for documents of unknown type\&.
|
|
|
|
.TP
|
|
\-default\-keys [0|1] (default: 0)
|
|
When set, all keybindings from configuration files will be ignored\&. It forces use of default keybindings and will reset user\-defined ones on save\&.
|
|
|
|
.TP
|
|
\-dump [0|1] (default: 0)
|
|
Print formatted plain\-text versions of given URLs to stdout\&.
|
|
|
|
.TP
|
|
\-dump\-charset (alias for document\&.dump\&.codepage)
|
|
Codepage used when formatting dump output\&.
|
|
|
|
.TP
|
|
\-dump\-color\-mode (alias for document\&.dump\&.color_mode)
|
|
Color mode used with \-dump\&.
|
|
|
|
.TP
|
|
\-dump\-width (alias for document\&.dump\&.width)
|
|
Width of the dump output\&.
|
|
|
|
.TP
|
|
\-eval
|
|
Specify configuration file directives on the command\-line which will be evaluated after all configuration files has been read\&. Example usage:
|
|
|
|
.nf
|
|
\-eval 'set protocol\&.file\&.allow_special_files = 1'
|
|
.fi
|
|
|
|
.TP
|
|
\-force\-html
|
|
Makes \fIELinks\fR assume documents of unknown types are HTML\&. Useful when using \fIELinks\fR as an external viewer from MUAs\&. This is equivalent to \-default\-mime\-type text/html\&.
|
|
|
|
.TP
|
|
\-?, \-h, \-help
|
|
Print usage help and exit\&.
|
|
|
|
.TP
|
|
\-localhost [0|1] (default: 0)
|
|
Restricts \fIELinks\fR to work offline and only connect to servers with local addresses (ie\&. 127\&.0\&.0\&.1)\&. No connections to remote servers will be permitted\&.
|
|
|
|
.TP
|
|
\-long\-help
|
|
Print detailed usage help and exit\&.
|
|
|
|
.TP
|
|
\-lookup
|
|
Look up specified host and print all DNS resolved IP addresses\&.
|
|
|
|
.TP
|
|
\-no\-connect [0|1] (default: 0)
|
|
Run \fIELinks\fR as a separate instance instead of connecting to an existing instance\&. Note that normally no runtime state files (bookmarks, history, etc\&.) are written to the disk when this option is used\&. See also \-touch\-files\&.
|
|
|
|
.TP
|
|
\-no\-home [0|1] (default: 0)
|
|
Disables creation and use of files in the user specific home configuration directory (~/\&.elinks)\&. It forces default configuration values to be used and disables saving of runtime state files\&.
|
|
|
|
.TP
|
|
\-no\-numbering (alias for document\&.dump\&.numbering)
|
|
Prevents printing of link number in dump output\&. Note that this really affects only \-dump, nothing else\&.
|
|
|
|
.TP
|
|
\-no\-references (alias for document\&.dump\&.references)
|
|
Prevents printing of references (URIs) of document links in dump output\&. Note that this really affects only \-dump, nothing else\&.
|
|
|
|
.TP
|
|
\-remote
|
|
Control a remote \fIELinks\fR instance by passing commands to it\&. The option takes an additional argument containing the method which should be invoked and any parameters that should be passed to it\&. For ease of use, the additional method argument can be omitted in which case any URL arguments will be opened in new tabs in the remote instance\&. Following is a list of the supported methods:
|
|
|
|
.RS
|
|
.TP 3
|
|
\(bu
|
|
ping(): look for a remote instance
|
|
.TP
|
|
\(bu
|
|
openURL(): prompt URL in current tab
|
|
.TP
|
|
\(bu
|
|
openURL(URL): open URL in current tab
|
|
.TP
|
|
\(bu
|
|
openURL(URL, new\-tab): open URL in new tab
|
|
.TP
|
|
\(bu
|
|
openURL(URL, new\-window): open URL in new window
|
|
.TP
|
|
\(bu
|
|
addBookmark(URL): bookmark URL
|
|
.TP
|
|
\(bu
|
|
infoBox(text): show text in a message box
|
|
.TP
|
|
\(bu
|
|
xfeDoCommand(openBrowser): open new window
|
|
.LP
|
|
.RE
|
|
.IP
|
|
|
|
.TP
|
|
\-session\-ring <num> (default: 0)
|
|
ID of session ring this \fIELinks\fR session should connect to\&. \fIELinks\fR works in so\-called session rings, whereby all instances of \fIELinks\fR are interconnected and share state (cache, bookmarks, cookies, and so on)\&. By default, all \fIELinks\fR instances connect to session ring 0\&. You can change that behaviour with this switch and form as many session rings as you want\&. Obviously, if the session\-ring with this number doesn't exist yet, it's created and this 'ELinks' instance will become the master instance (that usually doesn't matter for you as a user much)\&. Note that you usually don't want to use this unless you're a developer and you want to do some testing \- if you want the \fIELinks\fR instances each running standalone, rather use the \-no\-connect command\-line option\&. Also note that normally no runtime state files are written to the disk when this option is used\&. See also \-touch\-files\&.
|
|
|
|
.TP
|
|
\-source [0|1] (default: 0)
|
|
Print given URLs in source form to stdout\&.
|
|
|
|
.TP
|
|
\-touch\-files [0|1] (default: 0)
|
|
When enabled, runtime state files (bookmarks, history, etc\&.) are written to disk, even when \-no\-connect or \-session\-ring is used\&. The option has no effect if not used in conjunction with any of these options\&.
|
|
|
|
.TP
|
|
\-verbose <num> (default: 1)
|
|
The verbose level controls what messages are shown at start up and while running:
|
|
|
|
.RS
|
|
.TP 3
|
|
\(bu
|
|
0: means only show serious errors
|
|
.TP
|
|
\(bu
|
|
1: means show serious errors and warnings
|
|
.TP
|
|
\(bu
|
|
2: means show all messages
|
|
.LP
|
|
.RE
|
|
.IP
|
|
|
|
.TP
|
|
\-version
|
|
Print \fIELinks\fR version information and exit\&.
|
|
|
|
|
|
Generated using output from ELinks version 0\&.12\&.GIT\&.
|
|
|
|
.SH "ENVIRONMENT VARIABLES"
|
|
|
|
.TP
|
|
COMSPEC, SHELL
|
|
The shell used for File \-> OS Shell on DOS/Windows and UNIX, respectively\&.
|
|
|
|
.TP
|
|
EDITOR
|
|
The program to use for external editor (when editing textareas)\&.
|
|
|
|
.TP
|
|
ELINKS_CONFDIR
|
|
The location of the directory containing configuration files\&. If not set the default is ~/\&.elinks/\&.
|
|
|
|
.TP
|
|
ELINKS_TWTERM, LINKS_TWTERM
|
|
The command to run when selecting File \-> New window and if TWDISPLAY is defined (default twterm \-e)
|
|
|
|
.TP
|
|
ELINKS_XTERM, LINKS_XTERM
|
|
The command to run when selecting File \-> New window and if DISPLAY is defined (default xterm \-e)
|
|
|
|
.TP
|
|
FTP_PROXY, HTTP_PROXY, HTTPS_PROXY
|
|
The host to proxy the various protocol traffic through\&.
|
|
|
|
.TP
|
|
NO_PROXY
|
|
A comma separated list of URLs which should not be proxied\&.
|
|
|
|
.TP
|
|
HOME
|
|
The path to the users home directory\&. Used when expanding ~/\&.
|
|
|
|
.TP
|
|
WWW_HOME
|
|
Homepage location (as in \fBlynx\fR(1))\&.
|
|
|
|
.SH "FILES"
|
|
|
|
.TP
|
|
@sysconfdir@/elinks\&.conf
|
|
Site\-wide configuration file\&.
|
|
|
|
.TP
|
|
~/\&.elinks/elinks\&.conf
|
|
Per\-user config file, loaded after site\-wide configuration\&.
|
|
|
|
.TP
|
|
~/\&.elinks/bookmarks
|
|
Bookmarks file\&.
|
|
|
|
.TP
|
|
~/\&.elinks/cookies
|
|
Cookies file\&.
|
|
|
|
.TP
|
|
~/\&.elinks/exmodehist
|
|
Exmode history file\&.
|
|
|
|
.TP
|
|
~/\&.elinks/formhist
|
|
Form history file\&.
|
|
|
|
.TP
|
|
~/\&.elinks/globhist
|
|
History file containing most recently visited URLs\&.
|
|
|
|
.TP
|
|
~/\&.elinks/gotohist
|
|
GoTo URL dialog history file\&.
|
|
|
|
.TP
|
|
~/\&.elinks/hooks\&.{js,lua,pl,py,rb,scm}
|
|
Browser scripting hooks\&.
|
|
|
|
.TP
|
|
~/\&.elinks/searchhist
|
|
Search history file\&.
|
|
|
|
.TP
|
|
~/\&.elinks/socket
|
|
Internal \fIELinks\fR socket for communication between its instances\&.
|
|
|
|
.TP
|
|
~/\&.mailcap
|
|
Mappings of MIME types to external handlers\&.
|
|
|
|
.TP
|
|
~/\&.mime\&.types
|
|
Mappings of file extensions to MIME types\&.
|
|
|
|
|
|
Other files that ELinks uses from \fI~/\&.elinks/\fR includes the user defined CSS stylesheet\&. The name of the file can set in the \fIdocument\&.css\&.stylesheet\fR option\&.
|
|
|
|
.SH "PLATFORMS"
|
|
|
|
|
|
\fIELinks\fR is known to work on \fILinux\fR, \fIFreeBSD\fR, \fIOpenBSD\fR, \fISolaris\fR, \fIIRIX\fR, \fIHPUX\fR, \fIDigital Unix\fR, \fIAIX\fR, \fIOS/2\fR, \fIBeOS\fR and \fIRISC OS\fR\&. Port for \fIWin32\fR is in state of beta testing\&.
|
|
|
|
.SH "BUGS"
|
|
|
|
|
|
Please report any other bugs you find to the either the ELinks mailing list at <elinks\-users@linuxfromscratch\&.org> or if you prefer enter them into the bug tracking system <http://bugzilla\&.elinks\&.cz/>\&. More information about how to get in contact with developers and getting help can be found on the community page <http://elinks\&.cz/community\&.html>\&.
|
|
|
|
.SH "LICENSE"
|
|
|
|
|
|
\fIELinks\fR is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License <http://www\&.gnu\&.org/copyleft/gpl\&.html> as published by the Free Software Foundation; version 2 of the License\&.
|
|
|
|
.SH "AUTHORS"
|
|
|
|
|
|
The \fILinks\fR browser \- on which \fIELinks\fR is based \- was written by Mikulas Patocka <mikulas@artax\&.karlin\&.mff\&.cuni\&.cz>\&. \fIELinks\fR was written by Petr Baudis <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 <grin@tolna\&.net>, using excerpts from a (yet?) unknown \fILinks\fR fan for the \fIDebian GNU/Linux system\fR (but may be used by others)\&. Contributions from Francis A\&. Holop\&. Extended, clarified and made more up\-to\-date by Petr Baudis <pasky@ucw\&.cz>\&. Updated by Zas <zas@norz\&.org>\&. The conversion to Asciidoc and trimming was done by Jonas Fonseca <fonseca@diku\&.dk>\&.
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
|
|
\fBelinkskeys\fR(5), \fBelinks\&.conf\fR(5), \fBlinks\fR(1), \fBlynx\fR(1), \fBw3m\fR(1), \fBwget\fR(1)
|
|
|