===========================================================================
              edonkey commmand line client for GNU/Linux
                  Copyright (c) 1999-2004 MetaMachine
===========================================================================
 
Homepage : http://www.edonkey.com
Forum    : http://forum.edonkey.com 

===========================================================================
                        Command line client usage
===========================================================================

The command line client now reads its config files from ~/.overnet or
~/.eDonkey2000, so you do not have to worry about your current working
directory any longer when you start it (unlike older versions).

Just start the command line client from the command line like this:

         % edonkeyclc
 
Then type '?' to get a list of commands.

Run

         % edonkeyclc --help

to see a list of command line options (you usually do not need to use
any of the command line options, unless you want to use a GUI or you
want to start the client from an init/boot script or so).

If you get an error on startup saying 'Can't listen for connections.',
change the listening port with the 'port' command to another port,
for example to 3662:

         > port 3662

 
===========================================================================
                         Graphical User Interfaces
===========================================================================

This command line client can be controlled via a Graphical User Interface 
(GUI, meaning an application with windows and buttons). At the time of 
writing (April 2004), the only working and up-to-date GUI controller for 
the command line client is ed2k-gtk-gui, which should work on all major 
*nix systems (Linux, MacOSX), and also on Microsoft Windows.

That way you can remote control a command line client running on the same 
machine or on a completely different machine. You could, for example,
remote control a command line client running on a Linux router in the 
basement from your main PC, or you could check from work how your downloads
at home are going. 

You can find out more about ed2k-gtk-gui at  

               http://ed2k-gtk-gui.sourceforge.net 

ed2k-gtk-gui works with both, the overnet and the edonkey2000 command line
clients.

If you want to remote control the command line client, you MUST set up an
'admin' username and password using the 'pass joe joepass' command, and you
MUST start the command line client with the '-g' command line option 
(otherwise it won't open the port it listens on for GUI connections, which
is usually TCP port 4663).

Note that at the time of writing (April 2004) the latest ed2k-gtk-gui version
(0.6.2) is not yet 100% adjusted to deal with a couple of new features of the
command line client. That should be fixed with the next version (0.6.3).

In the mean time, you should start the command line client manually from the
command line, with the -g option, then set up an admin username and password,
and then start the GUI (on Linux by pressing ALT-F2 in your desktop environment 
and typing 'ed2k_gui' into the window that pops up). Enter your admin username
and password into the 'Connect to' dialog there, leave the port at 4663, and
just hit the 'connect' or 'Go!' button. Do not make use of the 'Spawn' feature
for the time being (you can, it should work, but it might lead to some strange
messages).


===========================================================================
                         Help and Support
===========================================================================

Please visit our forums at

              http://forum.overnet.com    
      
for support with the command line client. The Linux/MacOSX/*nix forum can 
be found at http://forum.overnet.com/viewforum.php?f=21


 Now enjoy.

