1ELINKS(1)                   The Elinks text-browser                  ELINKS(1)
2
3
4

NAME

6       elinks - lynx-like alternative character mode WWW browser
7

SYNOPSIS

9       elinks [OPTION]... [URL]...
10

DESCRIPTION

12       ELinks is a text mode WWW browser, supporting colors, table rendering,
13       background downloading, menu driven configuration interface, tabbed
14       browsing and slim code.
15
16       Frames are supported. You can have different file formats associated
17       with external viewers. mailto: and telnet: are supported via external
18       clients.
19
20       ELinks can handle both local files and remote URLs. The main supported
21       remote URL protocols are HTTP, HTTPS (with SSL support compiled in) and
22       FTP. Additional protocol support exists for BitTorrent finger, Gopher,
23       SMB and NNTP.
24
25       The homepage of ELinks can be found at <http://elinks.cz/>, where the
26       ELinks manual is also hosted.
27

OPTIONS

29       Most options can be set in the user interface or config file, so
30       usually you do not need to care about them. Note that this list is
31       roughly equivalent to the output of running ELinks with the option
32       --long-help.
33
34       -anonymous [0|1] (default: 0)
35           Restricts ELinks so it can run on an anonymous account. Local file
36           browsing, downloads, and modification of options will be disabled.
37           Execution of viewers is allowed, but entries in the association
38           table can't be added or modified.
39
40       -auto-submit [0|1] (default: 0)
41           Automatically submit the first form in the given URLs.
42
43       -base-session <num> (default: 0)
44           Used internally when opening ELinks instances in new windows. The
45           ID maps to information that will be used when creating the new
46           instance. You don't want to use it.
47
48       -config-dir <str> (default: "")
49           Path of the directory ELinks will read and write its config and
50           runtime state files to instead of ~/.elinks. If the path does not
51           begin with a '/' it is assumed to be relative to your HOME
52           directory.
53
54       -config-dump
55           Print a configuration file with options set to the built-in
56           defaults to stdout.
57
58       -config-file <str> (default: "elinks.conf")
59           Name of the configuration file that all configuration options will
60           be read from and written to. It should be relative to config-dir.
61
62       -config-help
63           Print help for configuration options and exit.
64
65       -default-mime-type (alias for mime.default_type)
66           The default MIME type used for documents of unknown type.
67
68       -default-keys [0|1] (default: 0)
69           When set, all keybindings from configuration files will be ignored.
70           It forces use of default keybindings and will reset user-defined
71           ones on save.
72
73       -dump [0|1] (default: 0)
74           Print formatted plain-text versions of given URLs to stdout.
75
76       -dump-charset (alias for document.dump.codepage)
77           Codepage used when formatting dump output.
78
79       -dump-color-mode (alias for document.dump.color_mode)
80           Color mode used with -dump.
81
82       -dump-width (alias for document.dump.width)
83           Width of the dump output.
84
85       -eval
86           Specify configuration file directives on the command-line which
87           will be evaluated after all configuration files has been read.
88           Example usage: -eval 'set protocol.file.allow_special_files = 1'
89
90       -force-html
91           Makes ELinks assume documents of unknown types are HTML. Useful
92           when using ELinks as an external viewer from MUAs. This is
93           equivalent to -default-mime-type text/html.
94
95       -?, -h, -help
96           Print usage help and exit.
97
98       -localhost [0|1] (default: 0)
99           Restricts ELinks to work offline and only connect to servers with
100           local addresses (ie. 127.0.0.1). No connections to remote servers
101           will be permitted.
102
103       -long-help
104           Print detailed usage help and exit.
105
106       -lookup
107           Look up specified host and print all DNS resolved IP addresses.
108
109       -no-connect [0|1] (default: 0)
110           Run ELinks as a separate instance instead of connecting to an
111           existing instance. Note that normally no runtime state files
112           (bookmarks, history, etc.) are written to the disk when this option
113           is used. See also -touch-files.
114
115       -no-home [0|1] (default: 0)
116           Disables creation and use of files in the user specific home
117           configuration directory (~/.elinks). It forces default
118           configuration values to be used and disables saving of runtime
119           state files.
120
121       -no-numbering (alias for document.dump.numbering)
122           Prevents printing of link number in dump output.
123
124           Note that this really affects only -dump, nothing else.
125
126       -no-references (alias for document.dump.references)
127           Prevents printing of references (URIs) of document links in dump
128           output.
129
130           Note that this really affects only -dump, nothing else.
131
132       -remote
133           Control a remote ELinks instance by passing commands to it. The
134           option takes an additional argument containing the method which
135           should be invoked and any parameters that should be passed to it.
136           For ease of use, the additional method argument can be omitted in
137           which case any URL arguments will be opened in new tabs in the
138           remote instance.
139
140           Following is a list of the supported methods:
141
142           ·   ping(): look for a remote instance
143
144           ·   openURL(): prompt URL in current tab
145
146           ·   openURL(URL): open URL in current tab
147
148           ·   openURL(URL, new-tab): open URL in new tab
149
150           ·   openURL(URL, new-window): open URL in new window
151
152           ·   addBookmark(URL): bookmark URL
153
154           ·   infoBox(text): show text in a message box
155
156           ·   xfeDoCommand(openBrowser): open new window
157
158       -session-ring <num> (default: 0)
159           ID of session ring this ELinks session should connect to.  ELinks
160           works in so-called session rings, whereby all instances of ELinks
161           are interconnected and share state (cache, bookmarks, cookies, and
162           so on). By default, all ELinks instances connect to session ring 0.
163           You can change that behaviour with this switch and form as many
164           session rings as you want. Obviously, if the session-ring with this
165           number doesn't exist yet, it's created and this ELinks instance
166           will become the master instance (that usually doesn't matter for
167           you as a user much).
168
169           Note that you usually don't want to use this unless you're a
170           developer and you want to do some testing - if you want the ELinks
171           instances each running standalone, rather use the -no-connect
172           command-line option. Also note that normally no runtime state files
173           are written to the disk when this option is used. See also
174           -touch-files.
175
176       -source [0|1] (default: 0)
177           Print given URLs in source form to stdout.
178
179       -touch-files [0|1] (default: 0)
180           When enabled, runtime state files (bookmarks, history, etc.) are
181           written to disk, even when -no-connect or -session-ring is used.
182           The option has no effect if not used in conjunction with any of
183           these options.
184
185       -verbose <num> (default: 1)
186           The verbose level controls what messages are shown at start up and
187           while running:
188
189           ·   0 means only show serious errors
190
191           ·   1 means show serious errors and warnings
192
193           ·   2 means show all messages
194
195       -version
196           Print ELinks version information and exit.
197
198       Generated using output from ELinks version 0.12pre6.
199

ENVIRONMENT VARIABLES

201       COMSPEC, SHELL
202           The shell used for File -> OS Shell on DOS/Windows and UNIX,
203           respectively.
204
205       EDITOR
206           The program to use for external editor (when editing textareas).
207
208       ELINKS_CONFDIR
209           The location of the directory containing configuration files. If
210           not set the default is ~/.elinks/.
211
212       ELINKS_TWTERM, LINKS_TWTERM
213           The command to run when selecting File -> New window and if
214           TWDISPLAY is defined (default twterm -e).
215
216       ELINKS_XTERM, LINKS_XTERM
217           The command to run when selecting File -> New window and if DISPLAY
218           is defined (default xterm -e).
219
220       FTP_PROXY, HTTP_PROXY, HTTPS_PROXY
221           The host to proxy the various protocol traffic through.
222
223       NO_PROXY
224           A comma separated list of URLs which should not be proxied.
225
226       HOME
227           The path to the users home directory. Used when expanding ~/.
228
229       WWW_HOME
230           Homepage location (as in lynx(1)).
231

FILES

233       Configuration files controlled by ELinks are located in the user
234       configuration directory, defaulting to ~/.elinks/. In addition to the
235       files listed below, a user defined CSS stylesheet can be defined using
236       the document.css.stylesheet option.
237
238       /etc/elinks.conf
239           Site-wide configuration file.
240
241       ~/.elinks/elinks.conf
242           Per-user config file, loaded after site-wide configuration.
243
244       ~/.elinks/bookmarks
245           Bookmarks file.
246
247       ~/.elinks/cookies
248           Cookies file.
249
250       ~/.elinks/exmodehist
251           Exmode history file.
252
253       ~/.elinks/formhist
254           Form history file.
255
256       ~/.elinks/globhist
257           History file containing most recently visited URLs.
258
259       ~/.elinks/gotohist
260           GoTo URL dialog history file.
261
262       ~/.elinks/hooks.{js,lua,pl,py,rb,scm}
263           Browser scripting hooks.
264
265       ~/.elinks/searchhist
266           Search history file.
267
268       ~/.elinks/socket
269           Internal ELinks socket for communication between its instances.
270
271       ~/.mailcap, /etc/mailcap
272           Mappings of MIME types to external handlers.
273
274       ~/.mime.types, /etc/mime.types
275           Mappings of file extensions to MIME types.
276

BUGS

278       Please report any other bugs you find to the either the ELinks mailing
279       list at <elinks-users@linuxfromscratch.org> or if you prefer enter them
280       into the bug tracking system <http://bugzilla.elinks.cz/>. More
281       information about how to get in contact with developers and getting
282       help can be found on the community page
283       <http://elinks.cz/community.html>.
284

LICENSE

286       ELinks is free software; you can redistribute it and/or modify it under
287       the terms of the GNU General Public License
288       <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html> as published by
289       the Free Software Foundation; version 2 of the License.
290

AUTHORS

292       The Links browser - on which ELinks is based - was written by Mikulas
293       Patocka <mikulas@artax.karlin.mff.cuni.cz>. ELinks was written by Petr
294       Baudis <pasky@ucw.cz>. See file AUTHORS in the source tree for a list
295       of people contributing to this project.
296
297       This manual page was written by Peter Gervai <grin@tolna.net>, using
298       excerpts from a (yet?) unknown Links fan for the Debian GNU/Linux
299       system (but may be used by others). Contributions from Francis A.
300       Holop. Extended, clarified and made more up-to-date by Petr Baudis
301       <pasky@ucw.cz>. Updated by Zas <zas@norz.org>. The conversion to
302       Asciidoc and trimming was done by Jonas Fonseca <fonseca@diku.dk>.
303

SEE ALSO

305       elinkskeys(5), elinks.conf(5), links(1), lynx(1), w3m(1), wget(1)
306
307
308
309ELinks 0.12pre6                   10/28/2012                         ELINKS(1)
Impressum