"SfR Fresh" - the SfR Freeware/Shareware Archive

Member "build/spamassassin/Readme.txt" of archive SpamAssassin-3.2.3.5-win32-src.zip:

    1  SpamAssassin for Win32 v3.2.3.5
    2 =================================
    3 Includes DCC v1.3.61 and Vipul's Razor v2.84
    4 
    5 
    6 SpamAssassin (http://spamassassin.apache.org/) is a free and powerful
    7 spam filter. This build includes support for online spam databases
    8 DCC (http://www.rhyolite.com/anti-spam/dcc/) and Razor/Cloudmark
    9 (http://razor.sf.net/).
   10 
   11 
   12 INSTALLATION
   13 ============
   14 
   15 
   16 Unpack the archive into any folder, keeping the file structure.
   17 
   18 If you are upgrading from the previous version, it is strongly recommended
   19 that you copy the file etc\dcc\map to "%USERPROFILE%\.spamassassin\map" to
   20 avoid the risk of the incompatibility of the formats.
   21 
   22 
   23 
   24 USAGE
   25 =====
   26 
   27 
   28 Full documentation is in "doc" subfolder. Here is a brief summary.
   29 
   30 spamassassin.exe takes incoming mail from STDIN and returns the
   31 filtered message to STDOUT. Thus, you could run it as follows:
   32 
   33   spamassassin.exe < file-input > file-output
   34 
   35 To capture debugging messages, you can run it like this:
   36 
   37   spamassassin.exe -D < file-input > file-output 2> file-debugging
   38 
   39 Note that spamd.exe and spamc.exe are native Windows applications, so
   40 they do not open a console window unless you redirect STDIN/STDOUT/STDERR.
   41 
   42 If you are planning to run the filter on a mail server, it is better
   43 to start spamd.exe daemon and then check individual mail messages with
   44 spamc.exe (this method reduces CPU load):
   45 
   46   spamd.exe --syslog="file-log"
   47 
   48   spamc.exe < file-input > file-output
   49 
   50 You can also run spamcc.exe instead of spamc.exe. The only difference
   51 between them is that spamcc.exe is a console application and command
   52 prompt will wait until it finishes, while spamc.exe is a native
   53 Windows application that does not open a console window. You can easily
   54 capture the exit code of spamcc.exe, while for spamc.exe it is tricky.
   55 
   56 Note that spamd.exe permanently resides in memory, therefore, you
   57 can shut it down only by ending 'spamd' process in Windows Task Manager.
   58 
   59 Also, you have to specify the log file or to redirect STDERR, otherwise
   60 spamd will not run. If you do not need the log, redirect STDERR to nul:
   61 
   62   spamd.exe 2> nul:
   63 
   64 Finally, remember that some of the online blacklists and databases that
   65 are free for personal use may request for paid subscription if your
   66 usage of their resources becomes high.
   67 
   68 
   69 ADVANCED CONFIGURATION
   70 ======================
   71 
   72 
   73 Again, read the documentation in the "doc" subfolder. For basic use
   74 you need no additional configuration, just run the programs.
   75 
   76 One of the most useful switches is -m, which sets the maximum number of messages
   77 that can be scanned simultaneously. The default value is five, however, if
   78 each message takes 30 seconds and you get over 10 messages per second, then
   79 obviously you need to increase the number, for example, -m 10.
   80 
   81 A few things that can be very useful:
   82 (1) configure "trusted" networks for SpamAssassin;
   83 (2) configure whitelists for SpamAssassin, DCC and Razor;
   84 (3) classify some of *your* mail as spam and not spam (over 200 messages
   85     in each group) and feed them into sa-learn, which you can download
   86     from my website as well.
   87 
   88 Locations of configuration files:
   89 
   90 SpamAssassin (global configuration): etc\spamassassin
   91 SpamAssassin (user files): %USERPROFILE%\.spamassassin
   92 DCC: %USERPROFILE%\.spamassassin
   93 Razor: %USERPROFILE%\.razor
   94 
   95 Here USERPROFILE environment variable is for the user who launches
   96 spamassassin or spamd.
   97 
   98 If you are running spamd/spamc, they ignore SpamAssassin user
   99 configuration file %USERPROFILE%\.spamassassin\user_prefs.
  100 
  101 
  102 RUNNING spamd AS A SERVICE
  103 ==========================
  104 
  105 
  106 In order for Windows to execute spamd automatically on startup, it
  107 should be configured to run as a Windows service. You can use the tools
  108 like NTRunner (http://www.winsite.com/bin/Info?500000023101) or
  109 Microsoft's instsrv.exe / srvany.exe, see examples at
  110 http://www.electrasoft.com/srvany/srvany.htm and at
  111 http://www.henry.it/xmail/xspamc/spamd_windows_service.htm
  112 
  113 
  114 KNOWN ISSUES
  115 ============
  116 
  117 
  118 Experimental DKIM and DomainKeys plugins occasionally consume too much time,
  119 which causes spamc to time out and the scan to cancel. Therefore, these plugins
  120 are disabled (commented out) by default. To enable them, edit the files v310.pre
  121 and v312.pre located in etc\spamassassin subfolder.
  122 
  123 
  124 HOME PAGE
  125 =========
  126 
  127 
  128 http://sawin32.sourceforge.net/
  129 
  130 You may consider downloading additional tools from this webpage:
  131 
  132 sa-learn - a utility that will allow you to train the Bayes filter
  133 sa-update - a utility that updates the spam-detecting rules