Introduction
------------
LinuxDC++ is a Linux port of the Direct Connect client DC++. Though it is
primarily aimed at Linux, it has been shown to work on other Unix-based
operating systems as well. It is written in C++ and makes use of GTK+ for the
user-interface. LinuxDC++ is free and open source software licensed under the
GPL.

Direct connect is a peer-to-peer file-sharing protocol. The most popular Windows
client implementing this protocol currently is DC++. Direct connect clients
connect to a central hub where they can view a list of clients or users
connected to them. Users can search for files and download them from other
clients, as well as chat with other users.

This readme contains only the basic information. For more detailed instructions,
read the manual in the wiki:

http://openfacts.berlios.de/index-en.phtml?title=Ldcpp_Manual


Dependencies:
-------------
scons >= 0.96
pkg-config
g++ >= 3.4
gtk+-2.0 >= 2.6
gthread-2.0 >= 2.4
libglade-2.0 >= 2.4
pthread
zlib
libbz2


Compiling:
----------
cd /path/to/linuxdcpp
scons

Scons will tell you if something's missing in a clear and human-readable way.
Hopefully. Fingers crossed. Knock on wood. Etc, etc.

For compile options, look in the main SConstruct file.


Installing:
-----------
With binreloc:
Using binreloc, which is the default, you can just copy the binary and the
pixmaps and glade directories to wherever you like. Then you can add the program
to your menu or create a symlink in /bin for easy access. As long as the binary
and the pixmaps and glade directories are in the same place it will find them.

Using an explicitly defined directory:
To install the program in a more traditional way by hard-coding data locations,
use scons PREFIX=/path/to/install/under to compile and
scons PREFIX=/path/to/install/under install to copy the files to the right
location.


Known problems:
------------------------
Utf8 locales are currently very buggy/not supported. If for example a lot of name
and description fields in the public hub list are empty you are suffering from this.
A workaround is to specify a non-utf8 locale when running the program, assuming
you have a non-utf8 locale on your system. For example, I'm from Sweden so my
utf8 locale would be sv_SE.UTF8. Starting the program like this:
prompt# LANG=sv_SE.ISO-8859-1 ./ldcpp would run ldcpp with a non-utf8 locale.

Codepage is a bit of a headache. Files with local chars in their filename are
sometimes rehashed on startup, messages in the hub and nicks in the wrong
codepage may not be shown, lots of pango warnings, etc.

Memory leaks.


License:
--------
The GPL (couldn't be any other, could it?)
See License.txt for details.


Contact:
--------
Website: linuxdcpp.berlios.de
IRC: #linuxdc++@freenode.org

