1ELINKS(1) The Elinks text-browser ELINKS(1)
2
6 elinks - lynx-like alternative character mode WWW browser
7
9 elinks [OPTION]... [URL]...
10
13 ELinks is a text mode WWW browser, supporting colors, table rendering,
14 background downloading, menu driven configuration interface, tabbed
15 browsing and slim code.
16 Frames are supported. You can have different file formats associated
18 with external viewers. mailto: and telnet: are supported via external
19 clients.
20 ELinks can handle both local files and remote URLs. The main supported
22 remote URL protocols are HTTP, HTTPS (with SSL support compiled in) and
23 FTP. Additional protocol support exists for BitTorrent finger, Gopher,
24 SMB and NNTP.
25 The homepage of ELinks can be found at <http://elinks.cz/>, where the
27 ELinks manual is also hosted.
28
31 Most options can be set in the user interface or config file, so
32 usually you do not need to care about them. Note that this list is
33 roughly equivalent to the output of running ELinks with the option
34 --long-help.
35 -anonymous [0|1] (default: 0)
37 Restricts ELinks so it can run on an anonymous account. Local file
38 browsing, downloads, and modification of options will be disabled.
39 Execution of viewers is allowed, but entries in the association
40 table can´t be added or modified.
41 -auto-submit [0|1] (default: 0)
43 Automatically submit the first form in the given URLs.
44 -base-session <num> (default: 0)
46 Used internally when opening ELinks instances in new windows. The
47 ID maps to information that will be used when creating the new
48 instance. You don´t want to use it.
49 -config-dir <str> (default: "")
51 Path of the directory ELinks will read and write its config and
52 runtime state files to instead of ~/.elinks. If the path does not
53 begin with a ´/´ it is assumed to be relative to your HOME
54 directory.
55 -config-dump
57 Print a configuration file with options set to the built-in
58 defaults to stdout.
59 -config-file <str> (default: "elinks.conf")
61 Name of the configuration file that all configuration options will
62 be read from and written to. It should be relative to config-dir.
63 -config-help
65 Print help for configuration options and exit.
66 -default-mime-type (alias for mime.default_type)
68 The default MIME type used for documents of unknown type.
69 -default-keys [0|1] (default: 0)
71 When set, all keybindings from configuration files will be ignored.
72 It forces use of default keybindings and will reset user-defined
73 ones on save.
74 -dump [0|1] (default: 0)
76 Print formatted plain-text versions of given URLs to stdout.
77 -dump-charset (alias for document.dump.codepage)
79 Codepage used when formatting dump output.
80 -dump-color-mode (alias for document.dump.color_mode)
82 Color mode used with -dump.
83 -dump-width (alias for document.dump.width)
85 Width of the dump output.
86 -eval
88 Specify configuration file directives on the command-line which
89 will be evaluated after all configuration files has been read.
90 Example usage: -eval ´set protocol.file.allow_special_files = 1´
91 -force-html
93 Makes ELinks assume documents of unknown types are HTML. Useful
94 when using ELinks as an external viewer from MUAs. This is
95 equivalent to -default-mime-type text/html.
96 -?, -h, -help
98 Print usage help and exit.
99 -localhost [0|1] (default: 0)
101 Restricts ELinks to work offline and only connect to servers with
102 local addresses (ie. 127.0.0.1). No connections to remote servers
103 will be permitted.
104 -long-help
106 Print detailed usage help and exit.
107 -lookup
109 Look up specified host and print all DNS resolved IP addresses.
110 -no-connect [0|1] (default: 0)
112 Run ELinks as a separate instance instead of connecting to an
113 existing instance. Note that normally no runtime state files
114 (bookmarks, history, etc.) are written to the disk when this option
115 is used. See also -touch-files.
116 -no-home [0|1] (default: 0)
118 Disables creation and use of files in the user specific home
119 configuration directory (~/.elinks). It forces default
120 configuration values to be used and disables saving of runtime
121 state files.
122 -no-numbering (alias for document.dump.numbering)
124 Prevents printing of link number in dump output.
125 Note that this really affects only -dump, nothing else.
127 -no-references (alias for document.dump.references)
129 Prevents printing of references (URIs) of document links in dump
130 output.
131 Note that this really affects only -dump, nothing else.
133 -remote
135 Control a remote ELinks instance by passing commands to it. The
136 option takes an additional argument containing the method which
137 should be invoked and any parameters that should be passed to it.
138 For ease of use, the additional method argument can be omitted in
139 which case any URL arguments will be opened in new tabs in the
140 remote instance.
141 Following is a list of the supported methods:
143 · ping(): look for a remote instance
145 · openURL(): prompt URL in current tab
147 · openURL(URL): open URL in current tab
149 · openURL(URL, new-tab): open URL in new tab
151 · openURL(URL, new-window): open URL in new window
153 · addBookmark(URL): bookmark URL
155 · infoBox(text): show text in a message box
157 · xfeDoCommand(openBrowser): open new window
159 -session-ring <num> (default: 0)
161 ID of session ring this ELinks session should connect to. ELinks
162 works in so-called session rings, whereby all instances of ELinks
163 are interconnected and share state (cache, bookmarks, cookies, and
164 so on). By default, all ELinks instances connect to session ring 0.
165 You can change that behaviour with this switch and form as many
166 session rings as you want. Obviously, if the session-ring with this
167 number doesn´t exist yet, it´s created and this ELinks instance
168 will become the master instance (that usually doesn´t matter for
169 you as a user much).
170 Note that you usually don´t want to use this unless you´re a
172 developer and you want to do some testing - if you want the ELinks
173 instances each running standalone, rather use the -no-connect
174 command-line option. Also note that normally no runtime state files
175 are written to the disk when this option is used. See also
176 -touch-files.
177 -source [0|1] (default: 0)
179 Print given URLs in source form to stdout.
180 -touch-files [0|1] (default: 0)
182 When enabled, runtime state files (bookmarks, history, etc.) are
183 written to disk, even when -no-connect or -session-ring is used.
184 The option has no effect if not used in conjunction with any of
185 these options.
186 -verbose <num> (default: 1)
188 The verbose level controls what messages are shown at start up and
189 while running:
190 · 0 means only show serious errors
192 · 1 means show serious errors and warnings
194 · 2 means show all messages
196 -version
198 Print ELinks version information and exit.
199 Generated using output from ELinks version 0.12pre5.
200
203 COMSPEC, SHELL
204 The shell used for File -> OS Shell on DOS/Windows and UNIX,
205 respectively.
206 EDITOR
208 The program to use for external editor (when editing textareas).
209 ELINKS_CONFDIR
211 The location of the directory containing configuration files. If
212 not set the default is ~/.elinks/.
213 ELINKS_TWTERM, LINKS_TWTERM
215 The command to run when selecting File -> New window and if
216 TWDISPLAY is defined (default twterm -e).
217 ELINKS_XTERM, LINKS_XTERM
219 The command to run when selecting File -> New window and if DISPLAY
220 is defined (default xterm -e).
221 FTP_PROXY, HTTP_PROXY, HTTPS_PROXY
223 The host to proxy the various protocol traffic through.
224 NO_PROXY
226 A comma separated list of URLs which should not be proxied.
227 HOME
229 The path to the users home directory. Used when expanding ~/.
230 WWW_HOME
232 Homepage location (as in lynx(1)).
233
235 Configuration files controlled by ELinks are located in the user
236 configuration directory, defaulting to ~/.elinks/. In addition to the
237 files listed below, a user defined CSS stylesheet can be defined using
238 the document.css.stylesheet option.
239 /etc/elinks.conf
241 Site-wide configuration file.
242 ~/.elinks/elinks.conf
244 Per-user config file, loaded after site-wide configuration.
245 ~/.elinks/bookmarks
247 Bookmarks file.
248 ~/.elinks/cookies
250 Cookies file.
251 ~/.elinks/exmodehist
253 Exmode history file.
254 ~/.elinks/formhist
256 Form history file.
257 ~/.elinks/globhist
259 History file containing most recently visited URLs.
260 ~/.elinks/gotohist
262 GoTo URL dialog history file.
263 ~/.elinks/hooks.{js,lua,pl,py,rb,scm}
265 Browser scripting hooks.
266 ~/.elinks/searchhist
268 Search history file.
269 ~/.elinks/socket
271 Internal ELinks socket for communication between its instances.
272 ~/.mailcap, /etc/mailcap
274 Mappings of MIME types to external handlers.
275 ~/.mime.types, /etc/mime.types
277 Mappings of file extensions to MIME types.
278
280 Please report any other bugs you find to the either the ELinks mailing
281 list at <elinks-users@linuxfromscratch.org> or if you prefer enter them
282 into the bug tracking system <http://bugzilla.elinks.cz/>. More
283 information about how to get in contact with developers and getting
284 help can be found on the community page
285 <http://elinks.cz/community.html>.
286
289 ELinks is free software; you can redistribute it and/or modify it under
290 the terms of the GNU General Public License
291 <http://www.gnu.org/copyleft/gpl.html> as published by the Free
292 Software Foundation; version 2 of the License.
293
296 The Links browser - on which ELinks is based - was written by Mikulas
297 Patocka <mikulas@artax.karlin.mff.cuni.cz>. ELinks was written by Petr
298 Baudis <pasky@ucw.cz>. See file AUTHORS in the source tree for a list
299 of people contributing to this project.
300 This manual page was written by Peter Gervai <grin@tolna.net>, using
302 excerpts from a (yet?) unknown Links fan for the Debian GNU/Linux
303 system (but may be used by others). Contributions from Francis A.
304 Holop. Extended, clarified and made more up-to-date by Petr Baudis
305 <pasky@ucw.cz>. Updated by Zas <zas@norz.org>. The conversion to
306 Asciidoc and trimming was done by Jonas Fonseca <fonseca@diku.dk>.
307
310 elinkskeys(5), elinks.conf(5), links(1), lynx(1), w3m(1), wget(1)
311ELinks 0.12pre5 07/07/2009 ELINKS(1)