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 and a C
  23 compiler. If you want to install directly from GIT it is also required that
  24 automake and autoconf is installed on your system.
  25
  26 Recommended Libraries and Programs
  27 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  28
  29 To make use of many of ELinks features you will need to have some external
  30 libraries and utility programs installed on your system. It is recommended to
  31 have the following libraries and programs installed:
  32
  33 `-----------------------`----------------------------------------------------
  34 Dependency              Description
  35 -----------------------------------------------------------------------------
  36 Lua or Guile            Makes it possible to write scripting plugins.       \
  37 ifdef::installation-webpage[]
  38                         See link:manual.html#lua-scripting[the Elinks - Lua interface]    \
  39 endif::installation-webpage[]
  40 ifndef::installation-webpage[]
  41                         See <<lua-scripting,the Elinks - Lua interface>>    \
  42 endif::installation-webpage[]
  43                         for more info.
  44 zlib 1.2.0.2 or later   For handling compressed documents both locally and  \
  45                         sent from server.
  46 bzip2                   For handling local compressed documents.
  47 OpenSSL or GNU TLS      For handling secure HTTP browsing.
  48 GPM                     'General Purpose Mouse' for mouse support.
  49 expat                   'XML Parser Toolkit' needed for XBEL support.
  50 smbclient               Program needed for smb:// protocol support.
  51 rxvt-unicode            For terminal emulator which supports 88 colors.
  52 xterm with 256 colors   Program atleast patch level  179 or rxvt program    \
  53                         from version 2.7.9 for support of 256 colors.       \
  54                         Newer PuTTY also has 256 color support.
  55 libidn                  For internationalized domain names.
  56 SpiderMonkey            Mozilla's JavaScript engine for getting             \
  57                         JavaScript/ECMAScript support in ELinks.            \
  58 ifdef::installation-webpage[]
  59                         See also link:manual.html#ecmascript[notes on ECMAScript support].
  60 endif::installation-webpage[]
  61 ifndef::installation-webpage[]
  62                         See also <<ecmascript,notes on ECMAScript support>>.
  63 endif::installation-webpage[]
  64 -----------------------------------------------------------------------------
  65
  66 When compiling, you also need the header files for the libraries. Most OS
  67 distributors put a given library's headers in a package separate from the
  68 library itself; this package usually has `-dev` or similar appended to its
  69 name.
  70
  71 Further reading
  72 ~~~~~~~~~~~~~~~
  73
  74 This installation guide is far from being complete. You are also advised to
  75 read the `README` and the `INSTALL` files distributed with ELinks for further
  76 up to date info on building and installing.
  77
  78 ifndef::installation-webpage[]
  79
  80 include::small.txt[]
  81
  82 include::ecmascript.txt[]
  83
  84 include::{builddir}features.txt[]
  85
  86 endif::installation-webpage[]