NAME

  rascan
  
DESCRIPTION

  Rascan is a rewrite of Inter7's simscan (http://www.inter7.com/?page=simscan)
  and will provide you with the following:
	  
  * Will (optionally) check for virus using ClamAV
	  
  * Will (optionally) pass your mail through SpamAssassin
	  
  * Will (optionally) add a footer to your messages
  
  The goals of this project are:
	  
  * Make it more runtime configurable, instead of having so many compile-time
    options.
	    
  * Make it simpler, removing functionality I didn't use
	  
  * Add a little extra, specifically a chance to add footers to messages using
    altermime
	    
  * Make it use bstrlib's string routines, because programming C I am a chicken.
  
  To use rascan, you need a qmail installation with the qmail-queue-custom-error
  and QMAILQUEUE patches, and run qmail-smtpd with the QMAILQUEUE variable 
  pointing to rascan.
	  

REQUIREMENTS
	
  * SpamAssassin in spamd mode (unless you disable it)
	  
  * ClamAV in clamd mode (unless you disable it)
	  
  * Qmail patched with the qmail-queue-custom-error patch
	  
  * ripmime (if you want to scan for viruses)

  * altermime (if you want to add footers)
	 
USAGE
	    
  rascan will take the email at the end of the DATA SMTP command and process it
  in the following ways:
	  
  * Unless the DISABLE_CLAMAV environment variable is set, the mail will be saved
    and examined using clamdscan. If there is a virus, the mail will not be accepted.
    If there is a problem running clamdscan, the mail will be temporarily
    rejected.
	    
    Keep in mind that rascan is running as an ordinary user, and your clamd may
    be running as another. That could cause permission troubles!
	    
  * Unless the DISABLE_SPAMASSASSIN environment variable is set, the mail will
    be processed via spamc, and the processed copy will be used from now on.
    This way your user can check on the SpamAssassin headers to filter his
    spam into another folder, or whatever he wants.
	    
  * If the EMAIL_FOOTER environment variable is set to the name of a file
    readable by rascan, the contents of that file will be added as a footer to the
    message before further processing.
    
    Keep in mind that for some specific messages, it may not be possible to add 
    the footer, or the footer may not be visible by the receiver.
	    
    This is done using altermime (http://www.pldaniels.com/altermime/).
	    
  After all this processing, the message will be passed to qmail-queue for delivery. 
  Rascan expects the real qmail-queue to be in /var/qmail/bin so be careful.
  
CONFIGURATION
		  
  Before you use rascan, you should run ragenver to create a file containing
  your ClamAV and SpamAssassin version numbers.
	  
  You can pass extra arguments to spamc through the SPAMC_ARGS environment
  variable (ej: SPAMC_ARGS="-d saserver")
	  
  By default, the mails will be saved and processed in a folder inside
  /var/qmail/rascan. You can change that by setting the RASCAN_DIR 
  environment variable (please be careful, ok? ;-).

LOGS

  If you have troubles, you can set the RASCAN_DEBUG environment variable to a 
  number. The larger the number, the more logs you get.
	  
  Rascan will usually log in the same place your qmail-smtpd is logging.

BUGS

  I know of none. But there are probably a few. If you find one, please tell
  me!

SEE ALSO
	
  Rascan Home Page: http://lateral.blogsite.org/
  Simscan: http://www.inter7.com/?page=simscan
  Altermime: http://www.pldaniels.com/altermime/
  bstrlib: http://bstring.sf.net/

COPYRIGHT

  Copyright © 2006 Roberto Alsina <ralsina@kde.org>
  Copyright © 2004-2005 Inter7 Internet Technologies, Inc.

  This is free software; see the source for copying conditions. There is
  NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR