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 • reload(): reload the document in the current tab
159 • search(string): search in the current tab
161 • xfeDoCommand(openBrowser): open new window
163 -session-ring <num> (default: 0)
165 ID of session ring this ELinks session should connect to. ELinks
166 works in so-called session rings, whereby all instances of ELinks
167 are interconnected and share state (cache, bookmarks, cookies, and
168 so on). By default, all ELinks instances connect to session ring 0.
169 You can change that behaviour with this switch and form as many
170 session rings as you want. Obviously, if the session-ring with this
171 number doesn´t exist yet, it´s created and this ELinks instance
172 will become the master instance (that usually doesn´t matter for
173 you as a user much).
174 Note that you usually don´t want to use this unless you´re a
176 developer and you want to do some testing - if you want the ELinks
177 instances each running standalone, rather use the -no-connect
178 command-line option. Also note that normally no runtime state files
179 are written to the disk when this option is used. See also
180 -touch-files.
181 -source [0|1] (default: 0)
183 Print given URLs in source form to stdout.
184 -touch-files [0|1] (default: 0)
186 When enabled, runtime state files (bookmarks, history, etc.) are
187 written to disk, even when -no-connect or -session-ring is used.
188 The option has no effect if not used in conjunction with any of
189 these options.
190 -verbose <num> (default: 1)
192 The verbose level controls what messages are shown at start up and
193 while running:
194 • 0 means only show serious errors
196 • 1 means show serious errors and warnings
198 • 2 means show all messages
200 -version
202 Print ELinks version information and exit.
203 Generated using output from ELinks version 0.13.GIT.
204
207 COMSPEC, SHELL
208 The shell used for File -> OS Shell on DOS/Windows and UNIX,
209 respectively.
210 EDITOR
212 The program to use for external editor (when editing textareas).
213 ELINKS_CONFDIR
215 The location of the directory containing configuration files. If
216 not set the default is ~/.elinks/.
217 ELINKS_TWTERM, LINKS_TWTERM
219 The command to run when selecting File -> New window and if
220 TWDISPLAY is defined (default twterm -e).
221 ELINKS_XTERM, LINKS_XTERM
223 The command to run when selecting File -> New window and if DISPLAY
224 is defined (default xterm -e).
225 FTP_PROXY, HTTP_PROXY, HTTPS_PROXY
227 The host to proxy the various protocol traffic through.
228 NO_PROXY
230 A comma separated list of URLs which should not be proxied.
231 HOME
233 The path to the users home directory. Used when expanding ~/.
234 HOME_ETC
236 If set the location of the directory containing configuration files
237 is $HOME_ETC/.elinks/ instead of ~/.elinks/.
238 WWW_HOME
240 Homepage location (as in lynx(1)).
241
243 Configuration files controlled by ELinks are located in the user
244 configuration directory, defaulting to ~/.elinks/. In addition to the
245 files listed below, a user defined CSS stylesheet can be defined using
246 the document.css.stylesheet option.
247 /etc/elinks.conf
249 Site-wide configuration file.
250 ~/.elinks/elinks.conf
252 Per-user config file, loaded after site-wide configuration.
253 ~/.elinks/bookmarks
255 Bookmarks file.
256 ~/.elinks/cookies
258 Cookies file.
259 ~/.elinks/exmodehist
261 Exmode history file.
262 ~/.elinks/formhist
264 Form history file.
265 ~/.elinks/globhist
267 History file containing most recently visited URLs.
268 ~/.elinks/gotohist
270 GoTo URL dialog history file.
271 ~/.elinks/hooks.{js,lua,pl,py,rb,scm}
273 Browser scripting hooks.
274 ~/.elinks/searchhist
276 Search history file.
277 ~/.elinks/socket
279 Internal ELinks socket for communication between its instances.
280 ~/.mailcap, /etc/mailcap
282 Mappings of MIME types to external handlers.
283 ~/.mime.types, /etc/mime.types
285 Mappings of file extensions to MIME types.
286
288 Please report any other bugs you find to the either the ELinks mailing
289 list at <elinks-users@linuxfromscratch.org> or if you prefer enter them
290 into the bug tracking system <http://bugzilla.elinks.cz/>. More
291 information about how to get in contact with developers and getting
292 help can be found on the community page
293 <http://elinks.cz/community.html>.
294
297 ELinks is free software; you can redistribute it and/or modify it under
298 the terms of the GNU General Public License
299 <http://www.gnu.org/copyleft/gpl.html> as published by the Free
300 Software Foundation; version 2 of the License.
301
304 The Links browser - on which ELinks is based - was written by Mikulas
305 Patocka <mikulas@artax.karlin.mff.cuni.cz>. ELinks was written by Petr
306 Baudis <pasky@ucw.cz>. See file AUTHORS in the source tree for a list
307 of people contributing to this project.
308 This manual page was written by Peter Gervai <grin@tolna.net>, using
310 excerpts from a (yet?) unknown Links fan for the Debian GNU/Linux
311 system (but may be used by others). Contributions from Francis A.
312 Holop. Extended, clarified and made more up-to-date by Petr Baudis
313 <pasky@ucw.cz>. Updated by Zas <zas@norz.org>. The conversion to
314 Asciidoc and trimming was done by Jonas Fonseca <fonseca@diku.dk>.
315
318 elinkskeys(5), elinks.conf(5), links(1), lynx(1), w3m(1), wget(1)
319ELinks 0.13.GIT 07/11/2009 ELINKS(1)