Basic Installation
==================


---------- WHAT YOU NEED IN ORDER TO BE ABLE TO COMPILE THE GUI: ----------

Quick-start:

   Debian stable (woody):
     * apt-get install libgtk2.0-dev
     * wget http://ftp.acc.umu.se/mirror/mirrors.evilgeniuses.org.uk/debian/backports/woody/gnome2.2/libgnet2.0-0_2.0.3-0jds1_i386.deb
     * dpkg -i libgnet2.0-0_2.0.3-0jds1_i386.deb
     * wget http://ftp.acc.umu.se/mirror/mirrors.evilgeniuses.org.uk/debian/backports/woody/gnome2.2/libgnet-dev_2.0.3-0jds1_i386.deb
     * dpkg -i libgnet-dev_2.0.3-0jds1_i386.deb

   Debian testing (sarge):
     * apt-get install libgtk2.0-dev libgnet2.0-0 libgnet-dev

   Debian unstable (sid):
     * apt-get install libgtk2.0-dev libgnet2.0-0 libgnet-dev

   Knoppix:
     * probably the same as Debian testing or unstable

   RedHat, Mandrake, SUSE, and other distros:
     * you need to fetch the following packages:
       glib2, glib2-devel, atk, atk-devel, pango, pango-devel, gtk2, gtk2-dev,
       and maybe xlibs-dev as well. Package names might vary. Make sure you get
       all of the above packages from ONE SOURCE.
       ALL distributions have these packages in their repository. If they are
       not there, then you just haven't found them yet.
     * you need to find a glib2-linked gnet2 and gnet2-devel somewhere, or
       install the above packages, and compile gnet2 from source.


More Details:

(1) libgnet - the gnet library (http://www.gnetlibrary.org)

   You will need the gnet library and its development files/headers installed
in order to be able to successfully compile and link the GUI.

   Look for packages called libgnet2.0-0 and libgnet-dev or gnet2/gnet2-dev or
similar for your distribution.

   Note that libgnet is based on the glib library (which gdk and gtk+ are based
on as well) and that there are currently two major versions of glib in
circulation, namely the ancient 1.2 series and the current 2.x series.

   Your gnet _must_ be linked against glib-2.0, otherwise the GUI won't work.
If you compile and install libgnet2 from source, you need to make sure you have
the glib2 header files available, and make sure it really links against glib2
and not the old one (it will use glib-2.x by default if it finds the header
files).


(2) gtk+/gdk/glib (http://www.gtk.org)

   You will also need the gtk+ library and the libraries it depends on (viz.
gdk and glib) AND THE CORRESPONDING DEVELOPMENT PACKAGES (usually called -dev
or -devel). You will now need to use the 2.x.x series of gtk+/gdk/glib for the
GUI.

   These libraries and the development files should be installed by default
on most newer systems. Packages should be called libgtk2.0-0 and libgtk2.0-dev
or gtk2 and gtk2-devel or similar.

   Gtk-2.x depends on quite a lot of other stuff (glib2, atk, pango, and a
whole bunch of other libraries (for image loaders and fonts stuff) so don't be
surprised if your package manager pulls in 20 MB worth of new packages ;)
(I hope for your sake that your distribution has a decent package manager...)


---------- INSTALLATION - SHORT VERSION: ----------

If you got the CVS version, do

  ./autogen.sh

to create the configure script (no need for that if you downloaded the source
code as a tarball).


If you got the source code as a tarball, unpack it with:

  tar xzf ed2-gtk-gui_0.x.y.tar.gz
  cd ed2k-gtk-gui-0.x.y/

Then do:

  ./configure
  make
  su (to become root)
  make install

The binary is then called 'ed2k_gui'.


---------- COMPILATION PARAMETERS ----------

You can disable the systray icon by doing

  ./configure --disable-systray

   (If you're on MacOSX, or you have the old gtk+-2.0 instead of the newer
gtk+-2.2, then the systray is disabled by default).

   If you run into problems with gettext/setlocale/etc. on FreeBSD (some
versions only apparently), try

  ./configure --disable-nls

(Better of course: Fix it and send a patch to make it work on your system)


---------- STARTING THE GUI  ----------

   The GUI binary is called 'ed2k_gui'. If you are using GNOME or KDE, you can
just type ALT-F2 and then type 'ed2k_gui' into the dialog that pops up. If you
are using something else, you probably know what to do ;)

   It appears that the pipe stuff is broken on some FreeBSD versions (100% cpu
usage, or constant outputting of 'received sth not an ed2k-link' or so).
You'll either have to manually disable the pipe stuff by commenting out the
pipe_create(); line in main.c, or fix it and send a patch :)


---------- UN-INSTALLATION ----------

If you install from source, there is usually no easy way to uninstall a
package.

If you still have the source dir around, you can just do

  make uninstall

just like you did 'make install'. If you don't have the source code around any
more, you need to get the source code again, run ./configure (with the right
prefix parameter if you used a prefix last time) again, and then do

  make uninstall

there ;)


---------- INSTALLATION - LONG VERSION: ----------

   The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation.  It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions.  Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, a file
`config.cache' that saves the results of its tests to speed up
reconfiguring, and a file `config.log' containing compiler output
(useful mainly for debugging `configure').

   If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release.  If at some point `config.cache'
contains results you don't want to keep, you may remove or edit it.

   The file `configure.in' is used to create `configure' by a program
called `autoconf'.  You only need `configure.in' if you want to change
it or regenerate `configure' using a newer version of `autoconf'.

The simplest way to compile this package is:

  1. `cd' to the directory containing the package's source code and type
     `./configure' to configure the package for your system.  If you're
     using `csh' on an old version of System V, you might need to type
     `sh ./configure' instead to prevent `csh' from trying to execute
     `configure' itself.

     Running `configure' takes a while.  While running, it prints some
     messages telling which features it is checking for.

  2. Type `make' to compile the package.

  3. Type `make install' to install the programs and any data files and
     documentation.

  4. You can remove the program binaries and object files from the
     source code directory by typing `make clean'.  

Compilers and Options
=====================

   Some systems require unusual options for compilation or linking that
the `configure' script does not know about.  You can give `configure'
initial values for variables by setting them in the environment.  Using
a Bourne-compatible shell, you can do that on the command line like
this:
     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure

Or on systems that have the `env' program, you can do it like this:
     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure

Compiling For Multiple Architectures
====================================

   You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory.  To do this, you must use a version of `make' that
supports the `VPATH' variable, such as GNU `make'.  `cd' to the
directory where you want the object files and executables to go and run
the `configure' script.  `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.

   If you have to use a `make' that does not supports the `VPATH'
variable, you have to compile the package for one architecture at a time
in the source code directory.  After you have installed the package for
one architecture, use `make distclean' before reconfiguring for another
architecture.

Installation Names
==================

   By default, `make install' will install the package's files in
`/usr/local/bin', `/usr/local/man', etc.  You can specify an
installation prefix other than `/usr/local' by giving `configure' the
option `--prefix=PATH'.

   You can specify separate installation prefixes for
architecture-specific files and architecture-independent files.  If you
give `configure' the option `--exec-prefix=PATH', the package will use
PATH as the prefix for installing programs and libraries.
Documentation and other data files will still use the regular prefix.

   If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.

Optional Features
=================

   Some packages pay attention to `--enable-FEATURE' options to
`configure', where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
is something like `gnu-as' or `x' (for the X Window System).  The
`README' should mention any `--enable-' and `--with-' options that the
package recognizes.

   For packages that use the X Window System, `configure' can usually
find the X include and library files automatically, but if it doesn't,
you can use the `configure' options `--x-includes=DIR' and
`--x-libraries=DIR' to specify their locations.

Specifying the System Type
==========================

   There may be some features `configure' can not figure out
automatically, but needs to determine by the type of host the package
will run on.  Usually `configure' can figure that out, but if it prints
a message saying it can not guess the host type, give it the
`--host=TYPE' option.  TYPE can either be a short name for the system
type, such as `sun4', or a canonical name with three fields:
     CPU-COMPANY-SYSTEM

See the file `config.sub' for the possible values of each field.  If
`config.sub' isn't included in this package, then this package doesn't
need to know the host type.

   If you are building compiler tools for cross-compiling, you can also
use the `--target=TYPE' option to select the type of system they will
produce code for and the `--build=TYPE' option to select the type of
system on which you are compiling the package.

Sharing Defaults
================

   If you want to set default values for `configure' scripts to share,
you can create a site shell script called `config.site' that gives
default values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/config.site' if it exists, then
`PREFIX/etc/config.site' if it exists.  Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.

Operation Controls
==================

   `configure' recognizes the following options to control how it
operates.

`--cache-file=FILE'
     Use and save the results of the tests in FILE instead of
     `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
     debugging `configure'.

`--help'
     Print a summary of the options to `configure', and exit.

`--quiet'
`--silent'
`-q'
     Do not print messages saying which checks are being made.

`--srcdir=DIR'
     Look for the package's source code in directory DIR.  Usually
     `configure' can determine that directory automatically.

`--version'
     Print the version of Autoconf used to generate the `configure'
     script, and exit.

`configure' also accepts some other, not widely useful, options.

