	$Id: README,v 1.3 2002/09/04 13:13:30 crosser Exp $

	$Log: README,v $
	Revision 1.3  2002/09/04 13:13:30  crosser
	spellcheck and change version to 1.00
	
	Revision 1.2  2002/08/26 16:30:27  crosser
	description matches new syntax
	
	Revision 1.1  2002/08/25 14:02:14  crosser
	implement special characters
	include README
	make test script
	

	Copyright (c) 2002 Eugene Crosser

	You may distribute and/or use for any purpose modified or unmodified
	copies of this software if you preserve the copyright notice above.

	THIS SOFTWARE IS PROVIDED AS IS AND COME WITH NO WARRANTY OF ANY
	KIND, EITHER EXPRESSED OR IMPLIED.  IN NO EVENT WILL THE
	COPYRIGHT HOLDER BE LIABLE FOR ANY DAMAGES RESULTING FROM THE
	USE OF THIS SOFTWARE.

	Lean and mean smtp-contentfilter for Zmailer.  Designed to be
	low resource consuming.  Configurability, flexibility and even
	portability are sacrificed in sake of speed and size.


The package consists of two programs - 'rulecompile' and 'contentfilter'.
contentfilter program (by default installed in /usr/local/libexec) should
be specified in Zmailer's smtpserver.conf.  It uses precompiled version
of "forbidden patterns set" location of which is not run-time configurable
(but it is ./configure -time configurable, see "./configure --help").
The program is designed to be light and fast, therefore parsing of
source pattern definition is done by a separate program, 'rulecompile'.
The latter takes definition file name as is only command-line argument
('-' for the file name means stdin), and replaces (as gracefully as
possible) rulefile that is used by 'contentfilter' program.  Format of
the source file is described in the sample included with this distribution.

PLEASE BEWARE!  CONTENT FILTERING BY PATTERNS IS DANGEROUS!
For instance, you might want to filter spam or virus based on a specific
context in the body of the message.  Then you will ALSO filter spam
complains that people will be sending you!  This is less of an issue
if you filter by header or envelope fields.

To use filtering by envelope fields you must be familiar with the
format of Zmailer internal message representation.

Contact the author: crosser at average dot org
Zmailer web site: http://www.zmailer.org/


