| blob | acacb363e4dcbe3c085f352f79ab22d80e64a509 |
1 .\" Title: elinks
2 .\" Author:
3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
4 .\" Date: 07/07/2009
5 .\" Manual: The Elinks text-browser
6 .\" Source: ELinks 0.12pre5
7 .\"
8 .TH "ELINKS" "1" "07/07/2009" "ELinks 0\&.12pre5" "The Elinks text\-browser"
9 .\" disable hyphenation
10 .nh
11 .\" disable justification (adjust text to left margin only)
12 .ad l
13 .SH "NAME"
14 elinks \- lynx-like alternative character mode WWW browser
15 .SH "SYNOPSIS"
16 \fIelinks\fR [OPTION]\&... [URL]\&...
17 .sp
18 .SH "DESCRIPTION"
19 \fIELinks\fR is a text mode WWW browser, supporting colors, table rendering, background downloading, menu driven configuration interface, tabbed browsing and slim code\&.
20 .sp
21 Frames are supported\&. You can have different file formats associated with external viewers\&. mailto: and telnet: are supported via external clients\&.
22 .sp
23 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\&.
24 .sp
25 The homepage of \fIELinks\fR can be found at <http://elinks\&.cz/>, where the ELinks manual is also hosted\&.
26 .sp
27 .SH "OPTIONS"
28 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\&.
29 .PP
30 \fB\-anonymous\fR \fI[0|1]\fR (default: 0)
31 .RS 4
32 Restricts
33 ELinks
34 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\&.
35 .RE
36 .PP
37 \fB\-auto\-submit\fR \fI[0|1]\fR (default: 0)
38 .RS 4
39 Automatically submit the first form in the given URLs\&.
40 .RE
41 .PP
42 \fB\-base\-session\fR \fI<num>\fR (default: 0)
43 .RS 4
44 Used internally when opening
45 ELinks
46 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\&.
47 .RE
48 .PP
49 \fB\-config\-dir\fR \fI<str>\fR (default: "")
50 .RS 4
51 Path of the directory
52 ELinks
53 will read and write its config and runtime state files to instead of
54 \fI~/\&.elinks\fR\&. If the path does not begin with a \'/\' it is assumed to be relative to your
55 \fBHOME\fR
56 directory\&.
57 .RE
58 .PP
59 \fB\-config\-dump\fR
60 .RS 4
61 Print a configuration file with options set to the built\-in defaults to stdout\&.
62 .RE
63 .PP
64 \fB\-config\-file\fR \fI<str>\fR (default: "elinks\&.conf")
65 .RS 4
66 Name of the configuration file that all configuration options will be read from and written to\&. It should be relative to
67 config\-dir\&.
68 .RE
69 .PP
70 \fB\-config\-help\fR
71 .RS 4
72 Print help for configuration options and exit\&.
73 .RE
74 .PP
75 \fB\-default\-mime\-type\fR (alias for mime\&.default_type)
76 .RS 4
77 The default MIME type used for documents of unknown type\&.
78 .RE
79 .PP
80 \fB\-default\-keys\fR \fI[0|1]\fR (default: 0)
81 .RS 4
82 When set, all keybindings from configuration files will be ignored\&. It forces use of default keybindings and will reset user\-defined ones on save\&.
83 .RE
84 .PP
85 \fB\-dump\fR \fI[0|1]\fR (default: 0)
86 .RS 4
87 Print formatted plain\-text versions of given URLs to stdout\&.
88 .RE
89 .PP
90 \fB\-dump\-charset\fR (alias for document\&.dump\&.codepage)
91 .RS 4
92 Codepage used when formatting dump output\&.
93 .RE
94 .PP
95 \fB\-dump\-color\-mode\fR (alias for document\&.dump\&.color_mode)
96 .RS 4
97 Color mode used with
98 \-dump\&.
99 .RE
100 .PP
101 \fB\-dump\-width\fR (alias for document\&.dump\&.width)
102 .RS 4
103 Width of the dump output\&.
104 .RE
105 .PP
106 \fB\-eval\fR
107 .RS 4
108 Specify configuration file directives on the command\-line which will be evaluated after all configuration files has been read\&. Example usage:
109 \fB\-eval \'set protocol\&.file\&.allow_special_files = 1\'\fR
110 .RE
111 .PP
112 \fB\-force\-html\fR
113 .RS 4
114 Makes
115 ELinks
116 assume documents of unknown types are HTML\&. Useful when using
117 ELinks
118 as an external viewer from MUAs\&. This is equivalent to
119 \fB\-default\-mime\-type\fR\fB text/html\fR\&.
120 .RE
121 .PP
122 \fB\-?\fR, \fB\-h\fR, \fB\-help\fR
123 .RS 4
124 Print usage help and exit\&.
125 .RE
126 .PP
127 \fB\-localhost\fR \fI[0|1]\fR (default: 0)
128 .RS 4
129 Restricts
130 ELinks
131 to work offline and only connect to servers with local addresses (ie\&. 127\&.0\&.0\&.1)\&. No connections to remote servers will be permitted\&.
132 .RE
133 .PP
134 \fB\-long\-help\fR
135 .RS 4
136 Print detailed usage help and exit\&.
137 .RE
138 .PP
139 \fB\-lookup\fR
140 .RS 4
141 Look up specified host and print all DNS resolved IP addresses\&.
142 .RE
143 .PP
144 \fB\-no\-connect\fR \fI[0|1]\fR (default: 0)
145 .RS 4
146 Run
147 ELinks
148 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
149 \-touch\-files\&.
150 .RE
151 .PP
152 \fB\-no\-home\fR \fI[0|1]\fR (default: 0)
153 .RS 4
154 Disables creation and use of files in the user specific home configuration directory (\fI~/\&.elinks\fR)\&. It forces default configuration values to be used and disables saving of runtime state files\&.
155 .RE
156 .PP
157 \fB\-no\-numbering\fR (alias for document\&.dump\&.numbering)
158 .RS 4
159 Prevents printing of link number in dump output\&.
160 .sp
161 Note that this really affects only
162 \-dump, nothing else\&.
163 .RE
164 .PP
165 \fB\-no\-references\fR (alias for document\&.dump\&.references)
166 .RS 4
167 Prevents printing of references (URIs) of document links in dump output\&.
168 .sp
169 Note that this really affects only
170 \-dump, nothing else\&.
171 .RE
172 .PP
173 \fB\-remote\fR
174 .RS 4
175 Control a remote
176 ELinks
177 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\&.
178 .sp
179 Following is a list of the supported methods:
180 .sp
181 .RS 4
182 \h'-04'\(bu\h'+03'\fBping()\fR: look for a remote instance
183 .RE
184 .sp
185 .RS 4
186 \h'-04'\(bu\h'+03'\fBopenURL()\fR: prompt URL in current tab
187 .RE
188 .sp
189 .RS 4
190 \h'-04'\(bu\h'+03'\fBopenURL(\fR\fB\fIURL\fR\fR\fB)\fR: open URL in current tab
191 .RE
192 .sp
193 .RS 4
194 \h'-04'\(bu\h'+03'\fBopenURL(\fR\fB\fIURL\fR\fR\fB, \fR\fBnew\-tab\fR\fB)\fR: open URL in new tab
195 .RE
196 .sp
197 .RS 4
198 \h'-04'\(bu\h'+03'\fBopenURL(\fR\fB\fIURL\fR\fR\fB, \fR\fBnew\-window\fR\fB)\fR: open URL in new window
199 .RE
200 .sp
201 .RS 4
202 \h'-04'\(bu\h'+03'\fBaddBookmark(\fR\fB\fIURL\fR\fR\fB)\fR: bookmark URL
203 .RE
204 .sp
205 .RS 4
206 \h'-04'\(bu\h'+03'\fBinfoBox(\fR\fB\fItext\fR\fR\fB)\fR: show text in a message box
207 .RE
208 .sp
209 .RS 4
210 \h'-04'\(bu\h'+03'\fBxfeDoCommand(\fR\fBopenBrowser\fR\fB)\fR: open new window
211 .RE
212 .RE
213 .PP
214 \fB\-session\-ring\fR \fI<num>\fR (default: 0)
215 .RS 4
216 ID of session ring this
217 ELinks
218 session should connect to\&.
219 ELinks
220 works in so\-called session rings, whereby all instances of
221 ELinks
222 are interconnected and share state (cache, bookmarks, cookies, and so on)\&. By default, all
223 ELinks
224 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
225 ELinks
226 instance will become the master instance (that usually doesn\'t matter for you as a user much)\&.
227 .sp
228 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
229 ELinks
230 instances each running standalone, rather use the
231 \-no\-connect
232 command\-line option\&. Also note that normally no runtime state files are written to the disk when this option is used\&. See also
233 \-touch\-files\&.
234 .RE
235 .PP
236 \fB\-source\fR \fI[0|1]\fR (default: 0)
237 .RS 4
238 Print given URLs in source form to stdout\&.
239 .RE
240 .PP
241 \fB\-touch\-files\fR \fI[0|1]\fR (default: 0)
242 .RS 4
243 When enabled, runtime state files (bookmarks, history, etc\&.) are written to disk, even when
244 \-no\-connect
245 or
246 \-session\-ring
247 is used\&. The option has no effect if not used in conjunction with any of these options\&.
248 .RE
249 .PP
250 \fB\-verbose\fR \fI<num>\fR (default: 1)
251 .RS 4
252 The verbose level controls what messages are shown at start up and while running:
253 .sp
254 .RS 4
255 \h'-04'\(bu\h'+03'0 means only show serious errors
256 .RE
257 .sp
258 .RS 4
259 \h'-04'\(bu\h'+03'1 means show serious errors and warnings
260 .RE
261 .sp
262 .RS 4
263 \h'-04'\(bu\h'+03'2 means show all messages
264 .RE
265 .RE
266 .PP
267 \fB\-version\fR
268 .RS 4
269 Print
270 ELinks
271 version information and exit\&.
272 .RE
273 Generated using output from ELinks version 0\&.12pre5\&.
274 .sp
275 .SH "ENVIRONMENT VARIABLES"
276 .PP
277 COMSPEC, SHELL
278 .RS 4
279 The shell used for File \-> OS Shell on DOS/Windows and UNIX, respectively\&.
280 .RE
281 .PP
282 EDITOR
283 .RS 4
284 The program to use for external editor (when editing textareas)\&.
285 .RE
286 .PP
287 ELINKS_CONFDIR
288 .RS 4
289 The location of the directory containing configuration files\&. If not set the default is
290 ~/\&.elinks/\&.
291 .RE
292 .PP
293 ELINKS_TWTERM, LINKS_TWTERM
294 .RS 4
295 The command to run when selecting File \-> New window and if
296 TWDISPLAY
297 is defined (default
298 twterm \-e)\&.
299 .RE
300 .PP
301 ELINKS_XTERM, LINKS_XTERM
302 .RS 4
303 The command to run when selecting File \-> New window and if
304 DISPLAY
305 is defined (default
306 xterm \-e)\&.
307 .RE
308 .PP
309 FTP_PROXY, HTTP_PROXY, HTTPS_PROXY
310 .RS 4
311 The host to proxy the various protocol traffic through\&.
312 .RE
313 .PP
314 NO_PROXY
315 .RS 4
316 A comma separated list of URLs which should not be proxied\&.
317 .RE
318 .PP
319 HOME
320 .RS 4
321 The path to the users home directory\&. Used when expanding
322 ~/\&.
323 .RE
324 .PP
325 WWW_HOME
326 .RS 4
327 Homepage location (as in
328 \fBlynx\fR(1))\&.
329 .RE
330 .SH "FILES"
331 Configuration files controlled by ELinks are located in the user configuration directory, defaulting to \fI~/\&.elinks/\fR\&. In addition to the files listed below, a user defined CSS stylesheet can be defined using the \fIdocument\&.css\&.stylesheet\fR option\&.
332 .PP
333 @sysconfdir@/elinks\&.conf
334 .RS 4
335 Site\-wide configuration file\&.
336 .RE
337 .PP
338 ~/\&.elinks/elinks\&.conf
339 .RS 4
340 Per\-user config file, loaded after site\-wide configuration\&.
341 .RE
342 .PP
343 ~/\&.elinks/bookmarks
344 .RS 4
345 Bookmarks file\&.
346 .RE
347 .PP
348 ~/\&.elinks/cookies
349 .RS 4
350 Cookies file\&.
351 .RE
352 .PP
353 ~/\&.elinks/exmodehist
354 .RS 4
355 Exmode history file\&.
356 .RE
357 .PP
358 ~/\&.elinks/formhist
359 .RS 4
360 Form history file\&.
361 .RE
362 .PP
363 ~/\&.elinks/globhist
364 .RS 4
365 History file containing most recently visited URLs\&.
366 .RE
367 .PP
368 ~/\&.elinks/gotohist
369 .RS 4
370 GoTo URL dialog history file\&.
371 .RE
372 .PP
373 ~/\&.elinks/hooks\&.{js,lua,pl,py,rb,scm}
374 .RS 4
375 Browser scripting hooks\&.
376 .RE
377 .PP
378 ~/\&.elinks/searchhist
379 .RS 4
380 Search history file\&.
381 .RE
382 .PP
383 ~/\&.elinks/socket
384 .RS 4
385 Internal
386 \fIELinks\fR
387 socket for communication between its instances\&.
388 .RE
389 .PP
390 ~/\&.mailcap, /etc/mailcap
391 .RS 4
392 Mappings of MIME types to external handlers\&.
393 .RE
394 .PP
395 ~/\&.mime\&.types, /etc/mime\&.types
396 .RS 4
397 Mappings of file extensions to MIME types\&.
398 .RE
399 .SH "BUGS"
400 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>\&.
401 .sp
402 .SH "LICENSE"
403 \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\&.
404 .sp
405 .SH "AUTHORS"
406 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\&.
407 .sp
408 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>\&.
409 .sp
410 .SH "SEE ALSO"
411 \fBelinkskeys\fR(5), \fBelinks.conf\fR(5), \fBlinks\fR(1), \fBlynx\fR(1), \fBw3m\fR(1), \fBwget\fR(1)
412 .sp