

                    	    QClam 0.2 Readme


Author: Sergey A. Galin, 2004
Homepage: http://sageshome.net/oss/qclam.php
The program is distributed under GNU GPL License, ver. 2 or higher.

QClam is a simple program to plug ClamAV antivirus to your QMail mailbox. If 
has been tested with ClamAV version 0.65 and QMail 1.03. It runs from your 
~/.qmail file. It receives incoming messages from QMail and scans them using
clamscan; if a virus found, it returns 99 to QMail telling it that the message
should not be processed (and it just gets removed). If no virus found, or 
there was an error calling clamscan, QClam returns 0 to QMail and it delivers 
message as usually. QClam also writes results of scanning into log file: 
~/qclam.log

The main features of QClam are that it's written in C++ and doesn't require
any other software (except OS, QMail and ClamAV) to run; it can be installed
without root privileges; and its size is just a few kilobytes :)

PLEASE NOTE: all messages in which clamscan will find viruses WILL BE LOST!!!

Installation:
    $ su -c "make install"
    - this will compile qclam and install it as /usr/local/bin/qclam
    $ make install-home
    - this will install qclam as ~/bin/qclam
    
Then, edit your ~/.qmail file by adding a line:

|/path/to/qclam

Sample ~/.qmail file:


|/usr/local/bin/qclam
./Maildir/


You can also add additional QClam options like --clam, --log after 
"|/usr/local/bin/qclam ./Maildir/" command to customize path to your
clamscan scanner or log file. To get detailed, up-to-date help on these 
options, please use the following command:

qclam --help  




