README
------
(Last updated Dec 22, 2005)

1. Important Links

ClamAV		: http://www.clamav.net
ClamTk		: http://freshmeat.net/projects/clamtk/
Dag Wieers	: http://dag.wieers.com
Fedora Extras	: http://fedoraproject.org/wiki/Extras #for FC ClamAV rpms
Debian		: http://www.debian.org
Gtk2-Perl	: http://gtk2-perl.sourceforge.net

2. About

ClamTk is a frontend for ClamAV using Gtk2-perl. It is intended to be
an easy to use, lightweight scanner for Linux systems. It has been
ported to Fedora Core, Debian, SuSE, ALT Linux, Ubuntu, and Mandriva.

3. GUI

ClamTk started out using the Tk libraries (thus its name). I have
since switched to perl-Gtk2 (or Gtk2-perl, whatever). The Tk version
is still available on sourceforge.net. I'll go back to 
maintaining the Tk version if there is a demand for it. There are
advantages and disadvantages to both.

I'm also open to a name change, but that seems like too much effort.

4. Cross-distro

RPMs and .debs are available from clamtk.sourceforge.net and yum repos.
Check rpmfind.net or your local packager for others.

5. Installation

RPMs:
The easiest way to install ClamTk is to use the rpms.
For FC3 and FC4, Fedora Extras has any necessary dependencies.
As root (or better, use su - or sudo):
# yum install clamav clamav-update clamav-data clamav-lib
and:
# rpm -Uvh clamtk-*.rpm

To remove clamtk:
# rpm -e clamtk

SOURCE:
The tarball contains all the sources - you can also launch the perl script
with:
	a. # perl clamtk.pl
	b. # chmod +x clamtk.pl
	   # ./clamtk.pl

DEBs:
# dpkg -i clamtk-*.deb
Note that I remove a certain subroutine from the Debian binary because
it only affects Fedora.

To remove clamtk:
# dpkg --purge clamtk

6. Running ClamTk

	a. I would recommend launching ClamTk as root first, if only to 
	   ensure you have the latest virus signatures. The rpm version
	   of clamav insists on root doing this (I'm not complaining;
	   only pointing it out). The update feature is located under "Help"
	   - or you can use "ctrl-U". Since you shouldn't be logging in
	   as root anyway, open up another terminal window (or another tab
	   in the terminal window), type "su -", the root password, and
	   then type "clamtk". You'll notice that the icon next to
	   "Update Signatures" is now green instead of red, indicating
 	   that you can now update the signatures.

	b. Also consider the options under "Options" and "Actions".
	   Under "Scan Options" you can opt to save a log of your
	   scanning, show hidden files (those beginning with a "."),
	   and/or show ALL files (typically, only those files which are
   	   infected or otherwise not clean are shown). 

	   Under "Actions", you have the choice of having ClamTk
	   just report viruses (the default), quarantine them, or
	   delete them. Be very careful with the "delete" option!

	c. Information on items quarantined is available under the 
	   "Quarantine" option. This is another safe option, along with
	   the default.

	d. Scan a file by either clicking the icon (first on the left), or
	   going under "File".

	e. Scan a directory by either clicking the icon (second on the left),
	   or going under "File". Also available is the recursive scan, which
	   will descend to all directories within the selected directory.

	f. You can STOP the scan by clicking the stop button located on the
	   gui toolbar (red circle with the white X).

7. Afterwards

If you've opted to save the results, you can view them by selecting the
"View Histories" option under "View".

You can also remove saved histories by clicking the "Delete Histories",
located just beneath "View Histories" under "View".

Clear away the output by clicking the clear icon (looks like a broom) on the
gui toolbar, or select "Clear Output" under "View".

The "Quarantine" option allows you three options: "Status" (if you
currently have anything quarantined); "Maintenance"; and "Empty".
"Maintenance" gives you refined control over the quarantined files: you
may delete individual files or move them back to your home directory. This
is useful if a file is a false positive. "Empty" will clean out the
quarantine directory.

8. Locale/Internationalization

Not currently provided. Someday...

9. Limitations/Bugs

Probably a lot. Let me know, please.

One of the current issues that hopefully will be resolved is that
ClamAV rpms are not standardized. This isn't my fault (that I'm aware of),
but I feel it adds unnecessary confusion (as opposed to necessary
confusion :).

10. Other

For feature requests or bugs, it's best to email me. You can also go
to the Sourceforge project page and submit requests/problems there
(http://sourceforge.net/projects/clamtk).

Please note that version numbers mean absolutely nothing to me.
A new version means it goes up 1. Or .01, whichever. Because I
changed from Tk to Gtk2 I did move the major version number up 
significantly, but that was just to keep them separate.
Just pointing it out.

11. Thanks

	* Everyone who has contributed in one way or another to ClamTk
	* Dag, without whom rpms would likely not currently exist
	* Muppet and the gtk2-perl folks for their time and effort
	* Perlmonks.org for helping me learn Perl (and continuing
	  to do so!)
	* Ksnapshot for making snapshot-taking very easy

dave.nerd AT gmail DOT com
