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