aniani/elinks
1
0
Fork 0
mirror of https://github.com/rkd77/elinks.git synced 2024-11-02 08:57:19 -04:00
Code
0e482b02da
elinks/doc/installation.txt

96 lines
3.6 KiB
Plaintext
Raw Normal View History

Initial commit of the HEAD branch of the ELinks CVS repository, as of Thu Sep 15 15:57:07 CEST 2005. The previous history can be added to this by grafting.
2005-09-15 09:58:31 -04:00
Getting ELinks up and running
-----------------------------
Installing ELinks should be pretty easy on most systems. Below is described
the whole process of configuring the compilation, compiling and installing.
Building and Installing ELinks
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The quick guide for the impatient. Issue the following commands from the
ELinks source directory:
$ ./configure && make && make install
However you might consider to tweek a few compile time options before building
ELinks. You might also want to take a look at what libraries and programs are
required or recommended that you install.
Requirements
~~~~~~~~~~~~
Document that GNU Make >= 3.78 is needed, and check it. (cherry picked from commit 4ffbf1faed6717ae6e32da44529be3a57526d6d4)
2007-12-06 16:46:19 -05:00
To successfully install ELinks all that is required is GNU make
(version 3.78 or later) and a C compiler. If you want to install
directly from GIT it is also required that automake and autoconf
is installed on your system.
Initial commit of the HEAD branch of the ELinks CVS repository, as of Thu Sep 15 15:57:07 CEST 2005. The previous history can be added to this by grafting.
2005-09-15 09:58:31 -04:00
Recommended Libraries and Programs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To make use of many of ELinks features you will need to have some external
libraries and utility programs installed on your system. It is recommended to
have the following libraries and programs installed:
doc/installation: convert dependency table to dsv format The dependency table was originally in "fixed" format, so that AsciiDoc took a fixed number of characters to the first column and the rest to the second column. However, "OpenSSL or GNU TLS or nss_compat_ossl" will not fit in that number of characters, and backslash line continuation will not help because AsciiDoc apparently parses that before it counts the characters. I could widen the column in the AsciiDoc source but switching to "dsv" format seems prettier.
2008-09-27 04:56:35 -04:00
[separator="|"]
`_______________________`____________________________________________________
Dependency |Description
_____________________________________________________________________________
Lua or Guile |Makes it possible to write scripting plugins. \
Revive #lua-scripting and #ecmascript links in installation.html. installation.html built from installation.txt does not include the sections about LUA scripting and ECMAScript, but installation.txt tries to link to them via fragment identifiers. Point those links to manual.html instead; not manual.html-chunked because the file names there might not remain stable. Alternatively, installation.txt could be changed to include lua-scripting.txt and ecmascript.txt into installation.html.
2007-02-10 18:35:34 -05:00
ifdef::installation-webpage[]
doc/installation: convert dependency table to dsv format The dependency table was originally in "fixed" format, so that AsciiDoc took a fixed number of characters to the first column and the rest to the second column. However, "OpenSSL or GNU TLS or nss_compat_ossl" will not fit in that number of characters, and backslash line continuation will not help because AsciiDoc apparently parses that before it counts the characters. I could widen the column in the AsciiDoc source but switching to "dsv" format seems prettier.
2008-09-27 04:56:35 -04:00
See link:manual.html#lua-scripting[the Elinks - Lua interface] \
Revive #lua-scripting and #ecmascript links in installation.html. installation.html built from installation.txt does not include the sections about LUA scripting and ECMAScript, but installation.txt tries to link to them via fragment identifiers. Point those links to manual.html instead; not manual.html-chunked because the file names there might not remain stable. Alternatively, installation.txt could be changed to include lua-scripting.txt and ecmascript.txt into installation.html.
2007-02-10 18:35:34 -05:00
endif::installation-webpage[]
ifndef::installation-webpage[]
doc/installation: convert dependency table to dsv format The dependency table was originally in "fixed" format, so that AsciiDoc took a fixed number of characters to the first column and the rest to the second column. However, "OpenSSL or GNU TLS or nss_compat_ossl" will not fit in that number of characters, and backslash line continuation will not help because AsciiDoc apparently parses that before it counts the characters. I could widen the column in the AsciiDoc source but switching to "dsv" format seems prettier.
2008-09-27 04:56:35 -04:00
See <<lua-scripting,the Elinks - Lua interface>> \
Revive #lua-scripting and #ecmascript links in installation.html. installation.html built from installation.txt does not include the sections about LUA scripting and ECMAScript, but installation.txt tries to link to them via fragment identifiers. Point those links to manual.html instead; not manual.html-chunked because the file names there might not remain stable. Alternatively, installation.txt could be changed to include lua-scripting.txt and ecmascript.txt into installation.html.
2007-02-10 18:35:34 -05:00
endif::installation-webpage[]
doc/installation: convert dependency table to dsv format The dependency table was originally in "fixed" format, so that AsciiDoc took a fixed number of characters to the first column and the rest to the second column. However, "OpenSSL or GNU TLS or nss_compat_ossl" will not fit in that number of characters, and backslash line continuation will not help because AsciiDoc apparently parses that before it counts the characters. I could widen the column in the AsciiDoc source but switching to "dsv" format seems prettier.
2008-09-27 04:56:35 -04:00
for more info.
zlib 1.2.0.2 or later |For handling gzip or deflate compressed documents \
both locally and sent from server.
bzip2 |Likewise, for bzip2 compressed documents.
LZMA Utils |Likewise, for LZMA compressed documents. \
NEWS about decompression
2009-02-22 11:33:48 -05:00
Version 4.32.5 should work. XZ Utils does not work.
doc/installation: Mention nss_compat_ossl
2008-09-27 05:00:00 -04:00
OpenSSL, GNU TLS, or nss_compat_ossl \
|For handling secure HTTP browsing.
Mention pkg-config dependency in doc/installation.txt
2009-05-22 15:29:55 -04:00
pkg-config |Needed for locating some libraries (at least \
configure: Find SpiderMonkey with pkg-config only Don't search for SpiderMonkey in hardcoded directories (/usr /usr/local /opt/spidermonkey /opt/js), and don't support --with-spidermonkey=DIR (which I think was documented in elinks-users only). Instead, ask pkg-config for mozjs185 or mozilla-js. Everyone who installed SpiderMonkey in an unusual place must set PKG_CONFIG_PATH appropriately. This commit also includes a few minor changes in the SpiderMonkey section of the configure script: * Update the SpiderMonkey version number in "checking" messages from 1.5 RC3a to 1.8.5, which matches the actual checks. * Wrap the option documentation with AS_HELP_STRING. * Use the Autoconf-generated $with_spidermonkey variable directly, instead of copying $withval. * Quote the arguments of macros more consistently. * Warn if SpiderMonkey was requested but not found.
2011-05-01 14:13:37 -04:00
GNU TLS, TRE, and SpiderMonkey)
doc/installation: convert dependency table to dsv format The dependency table was originally in "fixed" format, so that AsciiDoc took a fixed number of characters to the first column and the rest to the second column. However, "OpenSSL or GNU TLS or nss_compat_ossl" will not fit in that number of characters, and backslash line continuation will not help because AsciiDoc apparently parses that before it counts the characters. I could widen the column in the AsciiDoc source but switching to "dsv" format seems prettier.
2008-09-27 04:56:35 -04:00
GPM |'General Purpose Mouse' for mouse support.
expat |'XML Parser Toolkit' needed for XBEL support.
Bug 1060: Document the need for TRE.
2009-02-08 11:55:15 -05:00
http://laurikari.net/tre/[TRE] \
doc: TRE 0.8.0 required
2009-12-17 03:13:28 -05:00
|For regexp searching. Version 0.8.0 works.
doc/installation: libsmbclient, not smbclient
2008-09-27 07:03:51 -04:00
libsmbclient |Library needed for smb:// protocol support.
doc/installation: convert dependency table to dsv format The dependency table was originally in "fixed" format, so that AsciiDoc took a fixed number of characters to the first column and the rest to the second column. However, "OpenSSL or GNU TLS or nss_compat_ossl" will not fit in that number of characters, and backslash line continuation will not help because AsciiDoc apparently parses that before it counts the characters. I could widen the column in the AsciiDoc source but switching to "dsv" format seems prettier.
2008-09-27 04:56:35 -04:00
rxvt-unicode |For terminal emulator which supports 88 colors.
xterm with 256 colors |Program atleast patch level 179 or rxvt program \
from version 2.7.9 for support of 256 colors. \
Newer PuTTY also has 256 color support.
libidn |For internationalized domain names.
SpiderMonkey |Mozilla's JavaScript engine for getting \
JavaScript/ECMAScript support in ELinks. \
Revive #lua-scripting and #ecmascript links in installation.html. installation.html built from installation.txt does not include the sections about LUA scripting and ECMAScript, but installation.txt tries to link to them via fragment identifiers. Point those links to manual.html instead; not manual.html-chunked because the file names there might not remain stable. Alternatively, installation.txt could be changed to include lua-scripting.txt and ecmascript.txt into installation.html.
2007-02-10 18:35:34 -05:00
ifdef::installation-webpage[]
doc/installation: convert dependency table to dsv format The dependency table was originally in "fixed" format, so that AsciiDoc took a fixed number of characters to the first column and the rest to the second column. However, "OpenSSL or GNU TLS or nss_compat_ossl" will not fit in that number of characters, and backslash line continuation will not help because AsciiDoc apparently parses that before it counts the characters. I could widen the column in the AsciiDoc source but switching to "dsv" format seems prettier.
2008-09-27 04:56:35 -04:00
See also link:manual.html#ecmascript[notes on ECMAScript support].
Revive #lua-scripting and #ecmascript links in installation.html. installation.html built from installation.txt does not include the sections about LUA scripting and ECMAScript, but installation.txt tries to link to them via fragment identifiers. Point those links to manual.html instead; not manual.html-chunked because the file names there might not remain stable. Alternatively, installation.txt could be changed to include lua-scripting.txt and ecmascript.txt into installation.html.
2007-02-10 18:35:34 -05:00
endif::installation-webpage[]
ifndef::installation-webpage[]
doc/installation: convert dependency table to dsv format The dependency table was originally in "fixed" format, so that AsciiDoc took a fixed number of characters to the first column and the rest to the second column. However, "OpenSSL or GNU TLS or nss_compat_ossl" will not fit in that number of characters, and backslash line continuation will not help because AsciiDoc apparently parses that before it counts the characters. I could widen the column in the AsciiDoc source but switching to "dsv" format seems prettier.
2008-09-27 04:56:35 -04:00
See also <<ecmascript,notes on ECMAScript support>>.
Revive #lua-scripting and #ecmascript links in installation.html. installation.html built from installation.txt does not include the sections about LUA scripting and ECMAScript, but installation.txt tries to link to them via fragment identifiers. Point those links to manual.html instead; not manual.html-chunked because the file names there might not remain stable. Alternatively, installation.txt could be changed to include lua-scripting.txt and ecmascript.txt into installation.html.
2007-02-10 18:35:34 -05:00
endif::installation-webpage[]
doc/installation: convert dependency table to dsv format The dependency table was originally in "fixed" format, so that AsciiDoc took a fixed number of characters to the first column and the rest to the second column. However, "OpenSSL or GNU TLS or nss_compat_ossl" will not fit in that number of characters, and backslash line continuation will not help because AsciiDoc apparently parses that before it counts the characters. I could widen the column in the AsciiDoc source but switching to "dsv" format seems prettier.
2008-09-27 04:56:35 -04:00
_____________________________________________________________________________
Initial commit of the HEAD branch of the ELinks CVS repository, as of Thu Sep 15 15:57:07 CEST 2005. The previous history can be added to this by grafting.
2005-09-15 09:58:31 -04:00
When compiling, you also need the header files for the libraries. Most OS
distributors put a given library's headers in a package separate from the
library itself; this package usually has `-dev` or similar appended to its
name.
Further reading
~~~~~~~~~~~~~~~
This installation guide is far from being complete. You are also advised to
read the `README` and the `INSTALL` files distributed with ELinks for further
up to date info on building and installing.
ifndef::installation-webpage[]
include::small.txt[]
include::ecmascript.txt[]
Make it possible to build all-docs when $(builddir) != $(srcdir)
2006-01-15 18:18:39 -05:00
include::{builddir}features.txt[]
Initial commit of the HEAD branch of the ELinks CVS repository, as of Thu Sep 15 15:57:07 CEST 2005. The previous history can be added to this by grafting.
2005-09-15 09:58:31 -04:00
endif::installation-webpage[]
Copy Permalink