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
19 with external viewers. mailto: and telnet: are supported via external
20 clients.
21 ELinks can handle both local files and remote URLs. The main supported
24 remote URL protocols are HTTP, HTTPS (with SSL support compiled in) and
25 FTP. Additional protocol support exists for BitTorrent finger, Gopher,
26 SMB and NNTP.
27 The homepage of ELinks can be found at <http://elinks.cz/>, where the
30 ELinks manual is also hosted.
31
34 Most options can be set in the user interface or config file, so usu‐
35 ally you do not need to care about them. Note that this list is roughly
36 equivalent to the output of running ELinks with the option --long-help.
37 -anonymous [0|1] (default: 0)
40 Restricts ELinks so it can run on an anonymous account. Local
41 file browsing, downloads, and modification of options will be
42 disabled. Execution of viewers is allowed, but entries in the
43 association table can't be added or modified.
44 -auto-submit [0|1] (default: 0)
47 Automatically submit the first form in the given URLs.
48 -base-session <num> (default: 0)
51 Used internally when opening ELinks instances in new windows.
52 The ID maps to information that will be used when creating the
53 new instance. You don't want to use it.
54 -config-dir <str> (default: "")
57 Path of the directory ELinks will read and write its config and
58 runtime state files to instead of ~/.elinks. If the path does
59 not begin with a '/' it is assumed to be relative to your HOME
60 directory.
61 -config-dump
64 Print a configuration file with options set to the built-in
65 defaults to stdout.
66 -config-file <str> (default: "elinks.conf")
69 Name of the configuration file that all configuration options
70 will be read from and written to. It should be relative to con‐
71 fig-dir.
72 -config-help
75 Print help for configuration options and exit.
76 -default-mime-type (alias for mime.default_type)
79 The default MIME type used for documents of unknown type.
80 -default-keys [0|1] (default: 0)
83 When set, all keybindings from configuration files will be
84 ignored. It forces use of default keybindings and will reset
85 user-defined ones on save.
86 -dump [0|1] (default: 0)
89 Print formatted plain-text versions of given URLs to stdout.
90 -dump-charset (alias for document.dump.codepage)
93 Codepage used when formatting dump output.
94 -dump-width (alias for document.dump.width)
97 Width of the dump output.
98 -eval Specify configuration file directives on the command-line which
101 will be evaluated after all configuration files has been read.
102 Example usage:
103 -eval 'set protocol.file.allow_special_files = 1'
105 -force-html
108 Makes ELinks assume documents of unknown types are HTML. Useful
109 when using ELinks as an external viewer from MUAs. This is
110 equivalent to -default-mime-type text/html.
111 -?, -h, -help
114 Print usage help and exit.
115 -localhost [0|1] (default: 0)
118 Restricts ELinks to work offline and only connect to servers
119 with local addresses (ie. 127.0.0.1). No connections to remote
120 servers will be permitted.
121 -long-help
124 Print detailed usage help and exit.
125 -lookup
128 Look up specified host and print all DNS resolved IP addresses.
129 -no-connect [0|1] (default: 0)
132 Run ELinks as a separate instance instead of connecting to an
133 existing instance. Note that normally no runtime state files
134 (bookmarks, history, etc.) are written to the disk when this
135 option is used. See also -touch-files.
136 -no-home [0|1] (default: 0)
139 Disables creation and use of files in the user specific home
140 configuration directory (~/.elinks). It forces default configu‐
141 ration values to be used and disables saving of runtime state
142 files.
143 -no-numbering (alias for document.dump.numbering)
146 Prevents printing of link number in dump output. Note that this
147 really affects only -dump, nothing else.
148 -no-references (alias for document.dump.references)
151 Prevents printing of references (URIs) of document links in dump
152 output. Note that this really affects only -dump, nothing else.
153 -remote
156 Control a remote ELinks instance by passing commands to it. The
157 option takes an additional argument containing the method which
158 should be invoked and any parameters that should be passed to
159 it. For ease of use, the additional method argument can be omit‐
160 ted in which case any URL arguments will be opened in new tabs
161 in the remote instance. Following is a list of the supported
162 methods:
163 ·
166 ping(): look for a remote instance
167 ·
169 openURL(): prompt URL in current tab
170 ·
172 openURL(URL): open URL in current tab
173 ·
175 openURL(URL, new-tab): open URL in new tab
176 ·
178 openURL(URL, new-window): open URL in new window
179 ·
181 addBookmark(URL): bookmark URL
182 ·
184 infoBox(text): show text in a message box
185 ·
187 xfeDoCommand(openBrowser): open new window
188 -session-ring <num> (default: 0)
190 ID of session ring this ELinks session should connect to. ELinks
191 works in so-called session rings, whereby all instances of
192 ELinks are interconnected and share state (cache, bookmarks,
193 cookies, and so on). By default, all ELinks instances connect to
194 session ring 0. You can change that behaviour with this switch
195 and form as many session rings as you want. Obviously, if the
196 session-ring with this number doesn't exist yet, it's created
197 and this 'ELinks' instance will become the master instance (that
198 usually doesn't matter for you as a user much). Note that you
199 usually don't want to use this unless you're a developer and you
200 want to do some testing - if you want the ELinks instances each
201 running standalone, rather use the -no-connect command-line
202 option. Also note that normally no runtime state files are writ‐
203 ten to the disk when this option is used. See also -touch-files.
204 -source [0|1] (default: 0)
207 Print given URLs in source form to stdout.
208 -touch-files [0|1] (default: 0)
211 When enabled, runtime state files (bookmarks, history, etc.) are
212 written to disk, even when -no-connect or -session-ring is used.
213 The option has no effect if not used in conjunction with any of
214 these options.
215 -verbose <num> (default: 1)
218 The verbose level controls what messages are shown at start up
219 and while running:
220 · 0: means only show serious errors
223 · 1: means show serious errors and warnings
225 · 2: means show all messages
227 -version
229 Print ELinks version information and exit.
230 Generated using output from ELinks version 0.11.0.GIT.
233
236 COMSPEC, SHELL
237 The shell used for File -> OS Shell on DOS/Windows and UNIX,
238 respectively.
239 EDITOR The program to use for external editor (when editing textareas).
242 ELINKS_CONFDIR
245 The location of the directory containing configuration files. If
246 not set the default is ~/.elinks/.
247 ELINKS_TWTERM, LINKS_TWTERM
250 The command to run when selecting File -> New window and if
251 TWDISPLAY is defined (default twterm -e)
252 ELINKS_XTERM, LINKS_XTERM
255 The command to run when selecting File -> New window and if DIS‐
256 PLAY is defined (default xterm -e)
257 FTP_PROXY, HTTP_PROXY, HTTPS_PROXY
260 The host to proxy the various protocol traffic through.
261 NO_PROXY
264 A comma separated list of URLs which should not be proxied.
265 HOME The path to the users home directory. Used when expanding ~/.
268 WWW_HOME
271 Homepage location (as in lynx(1)).
272
275 /etc/elinks.conf
276 Site-wide configuration file.
277 ~/.elinks/elinks.conf
280 Per-user config file, loaded after site-wide configuration.
281 ~/.elinks/bookmarks
284 Bookmarks file.
285 ~/.elinks/cookies
288 Cookies file.
289 ~/.elinks/exmodehist
292 Exmode history file.
293 ~/.elinks/formhist
296 Form history file.
297 ~/.elinks/globhist
300 History file containing most recently visited URLs.
301 ~/.elinks/gotohist
304 GoTo URL dialog history file.
305 ~/.elinks/hooks.{js,lua,pl,py,rb,scm}
308 Browser scripting hooks.
309 ~/.elinks/searchhist
312 Search history file.
313 ~/.elinks/socket
316 Internal ELinks socket for communication between its instances.
317 ~/.mailcap
320 Mappings of MIME types to external handlers.
321 ~/.mime.types
324 Mappings of file extensions to MIME types.
325 Other files that ELinks uses from ~/.elinks/ includes the user
328 defined CSS stylesheet. The name of the file can set in the doc‐
329 ument.css.stylesheet option.
330
333 ELinks is known to work on Linux, FreeBSD, OpenBSD, Solaris, IRIX,
334 HPUX, Digital Unix, AIX, OS/2, BeOS and RISC OS. Port for Win32 is in
335 state of beta testing.
336
339 Please report any other bugs you find to the either the ELinks mailing
340 list at <elinks-users@linuxfromscratch.org> or if you prefer enter them
341 into the bug tracking system <http://bugzilla.elinks.or.cz/>. More
342 information about how to get in contact with developers and getting
343 help can be found on the community page <http://elinks.or.cz/commu‐
344 nity.html>.
345
348 ELinks is free software; you can redistribute it and/or modify it under
349 the terms of the GNU General Public License <http://www.gnu.org/copy‐
350 left/gpl.html> as published by the Free Software Foundation; version 2
351 of the License.
352
355 The Links browser - on which ELinks is based - was written by Mikulas
356 Patocka <mikulas@artax.karlin.mff.cuni.cz>. ELinks was written by Petr
357 Baudis <pasky@ucw.cz>. See file AUTHORS in the source tree for a list
358 of people contributing to this project.
359 This manual page was written by Peter Gervai <grin@tolna.net>, using
362 excerpts from a (yet?) unknown Links fan for the Debian GNU/Linux sys‐
363 tem (but may be used by others). Contributions from Francis A. Holop.
364 Extended, clarified and made more up-to-date by Petr Baudis
365 <pasky@ucw.cz>. Updated by Zas <zas@norz.org>. The conversion to Asci‐
366 idoc and trimming was done by Jonas Fonseca <fonseca@diku.dk>.
367
370 elinkskeys(5), elinks.conf(5), links(1), lynx(1), w3m(1), wget(1)
3712006-01-29 The Elinks text-browser ELINKS(1)