docs/INSTALL

   1
   2
   3                               -------
   4                               INSTALL
   5                               -------
   6
   7
   8  Requirements
   9 --------------
  10
  11   To compile aMule, you'll need at least the following packages:
  12     * zlib >= 1.1.4       (1.2.3 is recommended)
  13     * wxWidgets >= 2.8.0  (2.8.9 is recommended)
  14     * Crypto++ >= 5.1     (5.5.2 is recommended)
  15     * the perl File::Copy module
  16
  17   For aMuleWeb you'll also need:
  18     * a POSIX compliant regex library (like libgnurx or libregex, for most
  19       GNU systems it's part of the standard C library).
  20
  21   Optionally you may want to provide:
  22     * libgd (or gdlib) >= 2.0.0, to let cas generate statistics images;
  23     * libupnp >= 1.6.6 if you want to have UPnP support;
  24     * libpng >= 1.2.0 to let aMuleWeb generate nice statistics graphs;
  25     * libGeoIP >= 1.4.4 if you want colourful country flags and IP to country
  26       mappings in the GUI;
  27     * gettext >= 0.11.5 if you want to enable NLS (Native Language Support).
  28
  29   It is known to compile with GCC 3.2, 3.3, 3.4, 4.1, 4.2 and 4.3;
  30   Sun Studio 12 and MSVC. GCC 2.95 is not supported.
  31
  32   aMule requires a wxWidgets builds that supports unicode. Since wxWidgets
  33   does not support unicode with GTK1, it is not possible to make aMule use
  34   GTK1.
  35
  36   As Crypto++ is very sensitive to compiler defects, if you're compiling it
  37   from source be sure to always test your compilation with `cryptest.exe v'.
  38   (Yes, it's called cryptest.exe on all platforms.) Only when all tests
  39   passed may you safely go on with compiling aMule.
  40   Adding "-DCRYPTOPP_DISABLE_ASM -O1" to CXXFLAGS is known to resolve
  41   these problems.
  42
  43
  44  Compiling aMule
  45 -----------------
  46
  47   Compiling and installing aMule is as easy as running the usual
  48
  49     ./configure
  50     make
  51     make install
  52
  53   commands (if you have all the above requirements fulfilled, of course).
  54
  55   Solutions for Microsoft Visual Studio 2008 and the free Express Edition
  56   are included. Please see the readme file for more information.
  57
  58
  59  ADVANCED OPTIONS
  60 ------------------
  61
  62   These are some of the availabe configure options:
  63
  64     --disable-debug           disable additional debugging output
  65     --enable-optimize         enable code optimizing
  66     --enable-amulecmd         compile aMule command line client
  67     --enable-amule-gui        compile aMule remote GUI (EXPERIMENTAL)
  68     --enable-amule-daemon     compile aMule daemon version
  69     --enable-webserver        compile aMule WebServer
  70     --enable-cas              compile C aMule Statistics
  71     --enable-wxcas            compile aMule GUI Statistics
  72     --disable-ed2k            don't compile aMule ed2k links handler
  73     --enable-alc              compile aMuleLinkCreator GUI version
  74     --enable-alcc             compile aMuleLinkCreator for console
  75     --disable-monolithic      disable building of the monolithic aMule app
  76
  77   For a full list of available options run `./configure --help' from the
  78   aMule source directory.
  79
  80
  81  Links
  82 -------
  83
  84   Detailed information on compiling and installing aMule:
  85     http://www.amule.org/wiki/index.php/Main_Page
  86
  87   Forum to ask questions, report bugs, etc:
  88     http://forum.amule.org/