doc/installation.txt

   1 Getting ELinks up and running
   2 -----------------------------
   3
   4 Installing ELinks should be pretty easy on most systems. Below is described
   5 the whole process of configuring the compilation, compiling and installing.
   6
   7 Building and Installing ELinks
   8 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   9
  10 The quick guide for the impatient. Issue the following commands from the
  11 ELinks source directory:
  12
  13         $ ./configure && make && make install
  14
  15 However you might consider to tweek a few compile time options before building
  16 ELinks. You might also want to take a look at what libraries and programs are
  17 required or recommended that you install.
  18
  19 Requirements
  20 ~~~~~~~~~~~~
  21
  22 To successfully install ELinks all that is required is GNU make
  23 (version 3.78 or later) and a C compiler. If you want to install
  24 directly from GIT it is also required that automake and autoconf
  25 is installed on your system.
  26
  27 Recommended Libraries and Programs
  28 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  29
  30 To make use of many of ELinks features you will need to have some external
  31 libraries and utility programs installed on your system. It is recommended to
  32 have the following libraries and programs installed:
  33
  34 [separator="|"]
  35 `_______________________`____________________________________________________
  36 Dependency              |Description
  37 _____________________________________________________________________________
  38 Lua or Guile            |Makes it possible to write scripting plugins.      \
  39 ifdef::installation-webpage[]
  40                          See link:manual.html#lua-scripting[the Elinks - Lua interface]    \
  41 endif::installation-webpage[]
  42 ifndef::installation-webpage[]
  43                          See <<lua-scripting,the Elinks - Lua interface>>   \
  44 endif::installation-webpage[]
  45                          for more info.
  46 zlib 1.2.0.2 or later   |For handling gzip or deflate compressed documents   \
  47                          both locally and sent from server.
  48 bzip2                   |Likewise, for bzip2 compressed documents.
  49 LZMA Utils              |Likewise, for LZMA compressed documents.            \
  50                          Version 4.32.5 should work.  XZ Utils does not work.
  51 OpenSSL, GNU TLS, or nss_compat_ossl \
  52                         |For handling secure HTTP browsing.
  53 pkg-config              |Needed for locating some libraries (at least       \
  54                          GNU TLS, TRE, and SpiderMonkey)
  55 GPM                     |'General Purpose Mouse' for mouse support.
  56 expat                   |'XML Parser Toolkit' needed for XBEL support.
  57 http://laurikari.net/tre/[TRE]                                               \
  58                         |For regexp searching.  Version 0.8.0 works.
  59 libsmbclient            |Library needed for smb:// protocol support.
  60 rxvt-unicode            |For terminal emulator which supports 88 colors.
  61 xterm with 256 colors   |Program atleast patch level  179 or rxvt program   \
  62                          from version 2.7.9 for support of 256 colors.      \
  63                          Newer PuTTY also has 256 color support.
  64 libidn                  |For internationalized domain names.
  65 SpiderMonkey            |Mozilla's JavaScript engine for getting            \
  66                          JavaScript/ECMAScript support in ELinks.           \
  67 ifdef::installation-webpage[]
  68                          See also link:manual.html#ecmascript[notes on ECMAScript support].
  69 endif::installation-webpage[]
  70 ifndef::installation-webpage[]
  71                          See also <<ecmascript,notes on ECMAScript support>>.
  72 endif::installation-webpage[]
  73 _____________________________________________________________________________
  74
  75 When compiling, you also need the header files for the libraries. Most OS
  76 distributors put a given library's headers in a package separate from the
  77 library itself; this package usually has `-dev` or similar appended to its
  78 name.
  79
  80 Further reading
  81 ~~~~~~~~~~~~~~~
  82
  83 This installation guide is far from being complete. You are also advised to
  84 read the `README` and the `INSTALL` files distributed with ELinks for further
  85 up to date info on building and installing.
  86
  87 ifndef::installation-webpage[]
  88
  89 include::small.txt[]
  90
  91 include::ecmascript.txt[]
  92
  93 include::{builddir}features.txt[]
  94
  95 endif::installation-webpage[]