You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spamassassin.apache.org by fe...@apache.org on 2004/07/13 03:35:52 UTC
svn commit: rev 22860 - spamassassin/trunk
Author: felicity
Date: Mon Jul 12 18:35:51 2004
New Revision: 22860
Modified:
spamassassin/trunk/BUGS
spamassassin/trunk/INSTALL
spamassassin/trunk/INSTALL.VMS
spamassassin/trunk/README
Log:
a bunch of doco updates
Modified: spamassassin/trunk/BUGS
==============================================================================
--- spamassassin/trunk/BUGS (original)
+++ spamassassin/trunk/BUGS Mon Jul 12 18:35:51 2004
@@ -2,23 +2,7 @@
KNOWN BUGS:
-----------
-http://bugzilla.spamassassin.org/show_bug.cgi?id=286 :
-
- Doesn't yet handle checking multiple-attachment messages,
- where one part is qp and another is b64. Instead the qp will
- be simply stripped.
-
-http://bugzilla.spamassassin.org/show_bug.cgi?id=1478 :
-
- Razor support does not work on the Win32 platform,
- redirecting stdout and stderr incorrectly. To work-around,
- set its score to 0 like so: "score RAZOR2_CHECK 0"
-
-http://bugzilla.spamassassin.org/show_bug.cgi?id=1503 :
-
- The Razor tests will fail if you have not run server discovery, due to a
- failure to support "taint mode" inside the Razor code.
-
+- NONE! ;)
(See http://bugzilla.spamassassin.org/ for the SpamAssassin bug tracking
database, and to report a bug.)
Modified: spamassassin/trunk/INSTALL
==============================================================================
--- spamassassin/trunk/INSTALL (original)
+++ spamassassin/trunk/INSTALL Mon Jul 12 18:35:51 2004
@@ -27,27 +27,13 @@
make
make install [as root]
-To install as non-root into a directory named "sausr" under your home
-directory, do something like this:
-
- [unzip/untar the archive]
- cd Mail-SpamAssassin-*
- perl Makefile.PL PREFIX=~/sausr SYSCONFDIR=~/saetc
- [option: add -DSPAMC_SSL to $CFLAGS to build an SSL-enabled spamc]
- make
- make install
+To install as non-root, see the directions below.
If you are running AFS, you may also need to specify INSTALLSITELIB and
SITELIBEXP.
-This will install the SpamAssassin modules and rules below the ~/sausr
-and ~/saetc directories off your home directory. Please see the file
-PACKAGING, sections "Changing paths in the Makefile" and "Setting further
-options on the command line" for more informations on available command
-line variables.
-
Note that you can upgrade SpamAssassin using these instructions, as long
-as you take care to read the caveats at the top of this file. Upgrading
+as you take care to read the caveats in the file UPGRADES. Upgrading
will not delete your learnt Bayes data or local rule modifications.
If you're using SunOS 4.1.x, see
@@ -82,6 +68,9 @@
- Your home directory is /home/user
- The location of the procmail executable is /usr/bin/procmail
+Many more details of this process are at
+http://wiki.apache.org/spamassassin/SingleUserUnixInstall
+
1. Uncompress and extract the SpamAssassin archive, using "unzip" or "tar
xvfz", in a temporary directory.
@@ -92,7 +81,7 @@
3. Make SpamAssassin as normal, but using your home directory as the
target:
- perl Makefile.PL PREFIX=~/sausr SYSCONFDIR=~/saetc
+ perl Makefile.PL PREFIX=$HOME
make
make install
@@ -113,7 +102,7 @@
top of your .procmailrc file:
:0fw: spamassassin.lock
-| /home/user/sausr/bin/spamassassin
+| /home/user/bin/spamassassin
The above line filters all incoming mail through SpamAssassin and tags
probable spam with a unique header. If you would prefer to have spam
@@ -125,6 +114,9 @@
* ^X-Spam-Status: Yes
caughtspam
+Also, see the file procmailrc.example and
+http://wiki.apache.org/spamassassin/UsedViaProcmail
+
7. Now, you should be ready to send some test emails and ensure everything
works as expected. First, send yourself a test email that doesn't contain
anything suspicious. You should receive it normally, but there will be a
@@ -168,22 +160,14 @@
be able to find these through those mechanisms, too, if you prefer.
-Required Modules
-----------------
+Required Perl/Module Versions
+-----------------------------
-These modules are required for SpamAssassin to build and run:
+Perl 5.6.1, and its associated modules, are required for SpamAssassin
+3.0.0 and later.
- - ExtUtils::MakeMaker >= 5.45 (included in Perl 5.6.1 and later)
-
- The ExtUtils::MakeMaker module is required in version 5.45 or later.
- Without the proper version the build will fail to create the Makefile.
- This is included in Perl versions 5.6.1 and later.
-
- Version 6.16 or later is recommended (which is included in Perl 5.8.1
- and 5.6.2).
-
-
-These additional modules are required for SpamassAssin to run:
+In additional, the following non-standard modules are also required for
+SpamAssassin to run:
- Digest::SHA1 (from CPAN)
@@ -195,7 +179,7 @@
- HTML::Parser >= 3.24 (from CPAN)
- Version 3.29 or later is recommended.
+ Version 3.31 or later is recommended.
HTML is used for an ever-increasing amount of email so this dependency
is unavoidable. Run "perldoc -q html" for additional information.
@@ -218,7 +202,10 @@
This is a required module if you use spamd, and allow user
configurations to be used (ie: you don't use -x, -u, -q/--sql-config,
- -Q/--setuid-with-sql, --ldap-config, or --setuid-with-ldap).
+ -Q/--setuid-with-sql, --ldap-config, or --setuid-with-ldap). Third
+ party utilities may also require this module for the same
+ functionality. Storable is used to backup/restore the SpamAssassin
+ configuration in between message processing.
Optional Additional Modules
@@ -236,8 +223,8 @@
auto-whitelist. *Much* more efficient than the other standard Perl
database packages. Strongly recommended.
- There seems to be a bug in libdb 4.1.25, which is distributed by
- default on some versions of Linux. See
+ There seems to be a bug in libdb 4.1.25, which is
+ distributed by default on some versions of Linux. See
http://wiki.apache.org/spamassassin/DbFileSleepBug for details.
@@ -284,6 +271,7 @@
To use Razor with SpamAssassin, you will need to be using v2.40 or
higher. v2.61 or higher is recommended.
+ More info is at http://wiki.apache.org/spamassassin/UsingRazor
- DCC http://www.rhyolite.com/anti-spam/dcc/
@@ -341,6 +329,7 @@
and arrange to peer with the rest of the public servers, to reduce
their load.
+ More info is at http://wiki.apache.org/spamassassin/UsingDcc
- Pyzor http://pyzor.sourceforge.net/
@@ -361,6 +350,9 @@
python setup.py build
python setup.py install
+ For a single user installation, change the last line to
+ python setup.py install --home=$HOME
+
Note that your system might install the modules and scripts with
non-world-readable permissions. Correct this with a command such as:
@@ -374,6 +366,8 @@
Note that MIMEDefang users may need to set the 'pyzor_path'
configuration setting, since MIMEDefang does not set a PATH by
default.
+
+ More info is at http://wiki.apache.org/spamassassin/UsingPyzor
- Net::Ident (from CPAN)
Modified: spamassassin/trunk/INSTALL.VMS
==============================================================================
--- spamassassin/trunk/INSTALL.VMS (original)
+++ spamassassin/trunk/INSTALL.VMS Mon Jul 12 18:35:51 2004
@@ -30,6 +30,6 @@
- bug 1099 in the SA Bugzilla is being used to track progress.
- http://www.hughes-family.org/bugzilla/show_bug.cgi?id=1099
+ http://bugzilla.spamassassin.org/show_bug.cgi?id=1099
Modified: spamassassin/trunk/README
==============================================================================
--- spamassassin/trunk/README (original)
+++ spamassassin/trunk/README Mon Jul 12 18:35:51 2004
@@ -2,7 +2,8 @@
------------------------
SpamAssassin is a mail filter which attempts to identify spam using
-text analysis and several internet-based realtime blacklists.
+a variety of mechanisms including text analysis, Bayesian filtering,
+DNS blocklists, and collaborative filtering databases.
Using its rule base, it uses a wide range of heuristic tests on mail
headers and body text to identify "spam", also known as unsolicited
@@ -13,11 +14,14 @@
SpamAssassin typically differentiates successfully between spam and
non-spam in between 95% and 100% of cases, depending on what kind of
-mail you get.
+mail you get and your training of its Bayesian filter. Specifically,
+SpamAssassin has been shown to produce around 0.9% false negatives (spam
+that was missed) and around 0.1% false positives (ham incorrectly marked
+as spam). See the rules/STATISTICS*.txt files for more information.
SpamAssassin also includes support for reporting spam messages
-automatically, and/or manually, to collaborative filtering databases such
-as Vipul's Razor [1].
+automatically, and/or manually, to collaborative filtering databases
+such as Vipul's Razor [1].
[1]: http://razor.sourceforge.net/
@@ -26,11 +30,11 @@
which allows SpamAssassin to be used in spam-protection proxy SMTP or
POP/IMAP server, or a variety of different spam-blocking scenarios.
-In addition, Craig Hughes has contributed "spamd", a daemonized
-version of SpamAssassin, which runs persistently. Using "spamc", a
-lightweight C client, this allows an MTA to process large volumes of
-mail through SpamAssassin without having to fork/exec a perl
-interpreter for each one.
+In addition, "spamd", a daemonized version of SpamAssassin which
+runs persistently, is available. Using its counterpart, "spamc",
+a lightweight client written in C, an MTA can process large volumes of
+mail through SpamAssassin without having to fork/exec a perl interpreter
+for each message.
If you have questions about SpamAssassin, please check the Wiki[2] to
see if someone has already posted an answer to your question. (The
@@ -45,23 +49,15 @@
Please also be sure to read the man pages.
-SpamAssassin is an effort undergoing incubation at the Apache Software
-Foundation (ASF), sponsored by the Apache Board of
-Directors. Incubation is required of all newly accepted projects until
-a further review indicates that the infrastructure, communications,
-and decision making process have stabilized in a manner consistent
-with other successful ASF projects. While incubation status is not
-necessarily a reflection of the completeness or stability of the code,
-it does indicate that the project has yet to be fully endorsed by the
-ASF.
+SpamAssassin is a project of the Apache Software Foundation (ASF).
Upgrading SpamAssassin
----------------------
IMPORTANT: If you are upgrading from a previous major version of
-SpamAssassin, please be sure to read the notes in UPGRADE to find out what
-has changed in a non-backwards compatible way.
+SpamAssassin, please be sure to read the notes in UPGRADE to find out
+what has changed in a non-backwards compatible way.
Installing SpamAssassin
@@ -196,17 +192,17 @@
Learning
--------
-Since SpamAssassin now includes a Bayesian learning filter (in version
-2.50 on), it is worthwhile training SpamAssassin with your collection of
-non-spam and spam, if possible. This will make it more accurate for your
-incoming mail. Do this using the "sa-learn" tools, like so:
+SpamAssassin includes a Bayesian learning filter, so it is worthwhile
+training SpamAssassin with your collection of non-spam and spam,
+if possible. This will make it more accurate for your incoming mail.
+Do this using the "sa-learn" tools, like so:
sa-learn --spam ~/Mail/saved-spam-folder
sa-learn --ham ~/Mail/inbox
sa-learn --ham ~/Mail/other-nonspam-folder
Use as many mailboxes as you like. Note that SpamAssassin will remember
-what mails it's learnt from, so you can re-run this as often as you like.
+what mails it has learnt from, so you can re-run this as often as you like.
Locali[sz]ation
@@ -231,8 +227,7 @@
http://spamassassin.org/lists.html for the sign-up address and a link to
the archive of past messages.
-The FAQ is here: http://wiki.spamassassin.org/w/FrequentlyAskedQuestions
-
+Much more info is at http://wiki.apache.org/spamassassin/FrontPage
Commercial Tests
----------------
@@ -290,8 +285,8 @@
details.
The default address-list implementation,
-Mail::SpamAssassin::DBBasedAddrList, uses Berkeley DB files to store the
-addresses.
+Mail::SpamAssassin::DBBasedAddrList, uses Berkeley DB files to store
+the addresses.