GKrellM giFT Plugin
===================

Author: Tilman Sauerbeck, <tilman@code-monkey.de>
Web:	http://code-monkey.de/index.php?gkrellm-gift

Copyright (C) 2003 Tilman Sauerbeck.
This program is free software; you can redistribute it and/or modify
it under the terms of version 2 of the GNU General Public License as
published by the Free Software Foundation. See COPYING.

Description:
------------

GKrellM giFT monitors your active giFT transfers and their progress.
Each transfer is displayed in a panel showing the filename and the
percentage of transmitted bytes. In addition, there's a chart showing
the current download and upload speed.


Installation:
-------------

To install, just run the usual ./configure && make followed by
make install.

To compile it, you will need GTK+ 2.0/2.2, libgiFT (ships with giFT)
and GKrellM 2.1.23 or greater.


Configuration:
--------------

Using the plugin's config dialog, you can set a number of options:

* System to connect to: host and port. Should be self-explanatory. These
  describe the system on which the giFT daemon runs you want to connect to.
  When you first run the plugin, it will try to read ~/.giFT/ui/ui.conf
  to figure out these settings. If that file isn't
  readable, the default host and port will be used, which is
  localhost:1213.

* Transfer colors: These are the colors used to draw the text in the panels.

* Max. downloads/uploads to display: if there are more downloads/uploads than
  the value you set here, these transfers won't be shown until some other
  transfer finishes.

* Format string for chart label: Defines which information is
  displayed in the chart.

  Available variables/control characters include:
  * GKrellM's standard variables
  * $Sd: downloads speed
  * $Su: uploads speed
  * $Td: number of current downloads
  * $Tu: number of current uploads
  * $Tt: number of downloads and uploads
  * $Us: Number of users
  
* Both the transfer panels and the chart can be turned off.


Future Releases:
----------------

Future releases will probably feature the following:

	* ability to pause/resume and cancel transfers
	* ...


Themes:
-------

Themes can supply files called "icon_up.png" and "icon_down.png" (or with the
other valid extensions) in the "giFT" subdirectry to change to images
put in front of the transfer tabs.


Contact:
--------

Send bug reports, patches, feature suggestions etc to
tilman@code-monkey.de

