INSTALL

   1 Elinks installation guidelines
   2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   3
   4   Quick guide for the impatient:
   5
   6         ./configure && make && make install
   7
   8   Check out the bottom of this file if you're upgrading from Links or an older
   9 ELinks! And be sure to look at doc/ecmascript.txt if you want (experimental)
  10 ECMAScript (that's JavaScript) support.
  11
  12 ##########
  13
  14   In order to check out the latest tree from GIT:
  15
  16         $ git clone check_file_SITES_for_value_of_this
  17         $ cd elinks
  18
  19   To update your existing tree to the latest GIT version, do:
  20
  21         $ git pull
  22
  23   Note that if you obtained the sources directly from GIT, you NEED to run
  24 ./autogen.sh!  (It should be enough to do it once - however, if you have build
  25 problems, try running this first.) Also, you obviously need GNU make and
  26 autoconf installed on your system (for the supported versions of autoconf,
  27 see AC_PREREQ in configure.in).  Otherwise, you have to use the nightly GIT
  28 snapshot - you don't need to do this there.
  29
  30
  31 ##########
  32
  33   If you want to compile ELinks, first check the directory named contrib/, it
  34 may contain patches that are of use to you.  If you're interested in any of
  35 them, try to apply them by doing (for each one):
  36
  37         $ patch -p0 < contrib/that-patch
  38
  39   They may not apply, since I don't update patches in contrib/ regularly - if
  40 you want, feel free to go ahead and update the patch for the current tree and
  41 submit the newer version.
  42
  43   The compilation itself looks like:
  44
  45   Unix - just doing:
  46
  47          $ ./configure
  48          $ make
  49
  50          should be enough.  However, in some FreeBSD 3 distributions you have to
  51          set CFLAGS=-aout before running ./configure.  Also, you may want to
  52          adjust some (well, plenty of) compile-time options through ./configure
  53          - do ./configure --help and it'll print out a list of them. You can
  54          finetune what's going to be included in the binary in the features.conf
  55          file, and some really detailed tuning can be performed in src/setup.h.
  56
  57          Also, a nice idea is to compile ELinks outside of the source tree (note
  58          that this might not quite work right now, but we're working on fixing
  59          it). Make another directory and run path_to_source_tree/configure from
  60          it. Typically, it looks like:
  61
  62          $ mkdir ../elinks-build
  63          $ cd ../elinks-build
  64          $ ../elinks/configure
  65          $ make
  66
  67   OS/2 - you can use ./configure.
  68
  69          The only supported compiler is EMX, you probably won't be able to
  70          compile it with anything else.
  71
  72          Configure under OS/2 needs to know paths to gcc, make and bash.
  73          Set (for example):
  74
  75          SET HOSTTYPE=i586
  76          SET MACHTYPE=i586-pc-os2
  77          SET CONFIG_SHELL=d:/prg/gnu/bin/bash.exe
  78          SET CC=d:/prg/emx/bin/gcc.exe
  79          SET MAKE=d:/prg/emx/bin/make.exe
  80          SET EMXOPT=-h100
  81
  82   DOS, Windows - port it by yourself.
  83
  84   Usually, even after strip, the ELinks binary can measure a lot, but you can
  85 radically reduce the resulting binary size by throwing out stuff you don't like.
  86 Detailed discussion of reducing the executable size can be found in
  87
  88         doc/small.txt
  89
  90
  91 ##########
  92
  93   Ok, now let's install it:
  94
  95   Unix - # make install
  96
  97   OS/2 -
  98         Copy file links.exe somewhere to your path or create CMD file that runs
  99         links.
 100
 101          WARNING: EMX has a nasty limit on open files.  Links will work badly or
 102          won't work with the default settings.  Set the variable EMXOPT=-h100
 103          before you run links.
 104
 105   Now, check the contrib/ directory again.  There may be some useful config
 106 file examples there, along with few support tools and some Lua scripts - you
 107 probably want them ;) so just copy hooks.lua to ~/.elinks, and edit the
 108 configuration part - it adds various functionality to ELinks, like
 109 decompression of gzipped files or HTML code rewriting for ELinks-unfriendly
 110 websites.
 111
 112
 113   !BEWARE!  If you _distribute_ an ELinks executable linked with OpenSSL and
 114 the OpenSSL library is not part of your base system, you are VIOLATING THE GPL.
 115 I honestly believe that for this absurd case no ELinks copyright holder will
 116 sue you, and it's not a problem for the OpenSSL people as well, as they have
 117 explicitly told me, but you might stay on the safe side.
 118
 119   So, people who are making ELinks binaries for systems with no OpenSSL in the
 120 base system and who decided to link OpenSSL against the ELinks binary may wish
 121 NOT to publish or distribute such an executable, as it's breaking GPL 2(b), if
 122 they like to have everything legally perfect (like the Debian people ;-).
 123
 124   As a semi-solution to this problem, GNUTLS support was introduced; if you want
 125 to distribute ELinks executables with HTTPS support, compile ELinks with the
 126 --with-gnutls configure option (assuming that you have GNUTLS 1.2.0 installed;
 127 we can't say about later versions since GNUTLS people seem to have strange taste
 128 wrt. backwards compatibility).
 129
 130   HOWEVER, beware that GNUTLS support in ELinks is not so well tested as
 131 OpenSSL, and shall be probably still considered experimental. Therfore, it's
 132 recommended to the users to give OpenSSL strong preference whenever possible.
 133 (Just to show the GNU ideologists how silly can they sometimes be, if not
 134 anything else. ;-)
 135
 136
 137 ##########
 138
 139   If you're upgrading from Links or older ELinks (0.4pre7 or older), you will
 140 notice that several things have changed.  First, the binary name is elinks, not
 141 links, now; however, the basic usage is almost the same and it still looks like
 142 the old (E)Links, so you probably want to make a links symlink pointing to
 143 elinks.
 144
 145   Then, note that configuration files were moved from /etc to /etc/elinks and
 146 from ~/.links to ~/.elinks, because the name and format of some of them was
 147 changed:
 148
 149   links.cfg became elinks.conf and you need to convert it with
 150 contrib/conv/conf-links2elinks.pl; html.cfg was merged into elinks.conf.
 151
 152   bookmarks are still bookmarks, but you need to convert it with
 153 old_to_new_bookmarks.sh.
 154
 155   links.his became gotohist and the format is the same.
 156
 157   history became globhist and the format is the same.
 158
 159   cookies are still cookies, but you need to convert it with tr " " "\t".
 160
 161
 162 ##########
 163
 164 vim: textwidth=80