Spamscan package
================
This package is released under the GPL. It is the copyright property of
Martin Gregorie, 2009

The package contains the following items:

spamscan        - An analysis program for locally defined Spamassassin rules.

ruleuse         - A wrapper shell script that examines local SA rule use
                  statistics using all available mail log files.

spamscan.conf   - A logwatch configuration for including spamscan reporting
                  in the daily logwatch report.

Installation
============
1. Check that the places Makefile will install executables and other
   files suits your installation. 

2. Run 'sudo make install' to do the installation.
   This installs scripts in /usr/local/bin and adds spamscan reporting
   to the daily Logwatch report.

Using spamscan
==============
This Perl script processes log entries made by spamd to analyse the 
performance of local rules:
  - the list of local rules is read from /etc/mail/spamassassin/local.cf
  - the specified (parts of) /var/log/maillog* are read and the spamd
    reporting line is analysed to accumulate counts of ham, spam and
    local rules that fired.
  - statistics are output. Options may be used to control the output.
    Run 'spamscan -?' for details.  

If it is incorporated in logwatch it reports the day's ham, spam and top 10
statistics.

As a convenience, the command 'ruleuse' will process all available mail 
logs and report ham, spam, the top ten rules and unused rules. The spamscan
options may be used to override this default.

The standard installation recipe in Makefile should automatically enable
its use as part of Logwatch's daily reporting.

Contact
=======
Contact me, Martin Gregorie via e-mail as <martin@gregorie.org> to report
problems or for assistance in configuring and using these tools.
