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

The package contains portmanteau, a script that generates Spamassassin 
rules from rule definition files. Its purpose is to ease the maintenance of
rules that contain large numbers of alternates by storing their content
in a more readily edited form. It is a rules preprocessor whose default
configuration is set by a configuration file, portmanteau.conf.

portmanteau is a bash script that uses a gawk script to do the heavy lifting,
so it only needs to be installed to make it useful.

Installation
===========
1. Inspect and edit Makefile to ensure that it installs portmanteau and
   its manpage in places that suit your system.

2. Run 'sudo make install' to do the installation. This installs the 
   spamkiller program and its manpage.

3. Read the man page.

4. Decide where you'll keep the rule definition files, where the generated 
   output is to go and where you intend to run the portmanteau script from.
   edit portmanteau.conf to reflect these choices.

5. Decide where to keep portmanteau.conf and put it there.

Getting started
===============
The testdata directory contains a number of rule definitions that were
used to develop portmanteau. They are included both as regression test data
and as examples of rule definitions. Running the command:

      ./portmanteau testdata x.txt

should generate a set of rules in x.txt. Most of the definitions will report
errors as they run and write error details into the output file. This is 
intentional because most of the rule were written to check error handling.
The definitions in allused.def, caseless.def, meta.def, minimal.def 
tflags.def and wordlim.def should generate clean rules and serve as examples.

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