Merge lp:~logan/ubuntu/raring/spamassassin/3.3.2-6ubuntu1 into lp:ubuntu/raring/spamassassin

[Logan Rosen]

[Sebastien Bacher (seb128)]

thanks for your work

=== removed directory '.pc/10_change_config_paths'
=== removed file '.pc/10_change_config_paths/INSTALL'
--- .pc/10_change_config_paths/INSTALL	2010-03-01 00:57:24 +0000
+++ .pc/10_change_config_paths/INSTALL	1970-01-01 00:00:00 +0000
@@ -1,474 +0,0 @@
-Upgrading SpamAssassin?
------------------------
-
-Please be sure to read the UPGRADE file for important changes that
-have been made since previous versions.  In particular, 3.3.0 no
-longer includes a default ruleset.
-
-
-Installing or Upgrading SpamAssassin
-------------------------------------
-
-Using CPAN via CPAN.pm:
-
-	perl -MCPAN -e shell                    [as root]
-	o conf prerequisites_policy ask
-	install Mail::SpamAssassin
-	quit
-
-Using Linux:
-
-	Debian unstable: apt-get install spamassassin
-	Gentoo: emerge mail-filter/spamassassin
-	Fedora: yum install spamassassin
-
-Alternatively download the tarfile, zipfile, and/or build your own RPM
-from http://spamassassin.apache.org/.  Building from tar/zip file is
-usually as simple as:
-
-	[unzip/untar the archive]
-	cd Mail-SpamAssassin-*
-	perl Makefile.PL
-	[option: add -DSPAMC_SSL to $CFLAGS to build an SSL-enabled spamc]
-	make
-	make install                            [as root]
-
-After installing SpamAssassin, you need to download and install the
-SpamAssassin ruleset using "sa-update".  See the "Installing Rules"
-section below.
-
-Please make sure to read this whole document before installing, especially
-the prerequisite information further down.
-
-To install as non-root, see the directions below.
-
-If you are running AFS, you may also need to specify INSTALLSITELIB and
-SITELIBEXP.
-
-Note that you can upgrade SpamAssassin using these instructions, as long
-as you take care to read the caveats in the file UPGRADE.   Upgrading
-will not delete your learnt Bayes data or local rule modifications.
-
-If you're using SunOS 4.1.x, see
-http://wiki.spamassassin.org/w/BuildingOnSunOS4 for build tips.
-
-
-Installing SpamAssassin for Personal Use (Not System-Wide)
-----------------------------------------------------------
-
-These steps assume the following, so substitute as necessary:
-  - Your UNIX login is "user"
-  - 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.
-
-2. change directory into it:
-
-	cd Mail-SpamAssassin-*
-
-3. Make SpamAssassin as normal, but using your home directory as the
-   target:
-
-	perl Makefile.PL PREFIX=$HOME
-	make
-	make install
-
-   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.
-
-4. Install the SpamAssassin ruleset using "sa-update":
-
-        $HOME/bin/sa-update
-
-   See the "Installing Rules" section below if you do not wish to download
-   the rules directly from the internet.
-
-5. If you already use procmail, skip to step 7.  If not, ensure procmail
-   is installed using "which procmail" or install it from www.procmail.org.
-
-6. Create a .forward file in your home directory containing the below
-   lines:
-
-"|IFS=' ' && exec /usr/bin/procmail -f- || exit 75 #user"
-
-7. Edit or create a .procmailrc file in your home directory containing the
-   below lines.  If you already have a .procmailrc file, add the lines to
-   the top of your .procmailrc file:
-
-:0fw: spamassassin.lock
-| /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
-   blocked and saved to a file called "caughtspam" in your home directory,
-   instead of passed through and tagged, append this directly below the above
-   lines:
-
-:0:
-* ^X-Spam-Status: Yes
-caughtspam
-
-Also, see the file procmailrc.example and
-http://wiki.apache.org/spamassassin/UsedViaProcmail
-
-8. 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 header containing "X-Spam-Status: No".  If you are only
-   tagging your spam, send yourself a copy of the GTUBE test string to
-   check to be sure it is marked as spam.  GTUBE is located in the
-   sample-spam.txt message distributed with SpamAssassin and also at:
-
-     http://spamassassin.apache.org/gtube/
-
-   If your test emails don't get through to you, immediately rename your
-   .forward file until you figure out cause of the the problem, so you
-   don't lose incoming email.
-
-   Note: one possible cause for this is the use of smrsh on the MTA system;
-   see http://wiki.spamassassin.org/w/ProcmailVsSmrsh for details.
-
-9. You can now customize SpamAssassin.  See README for more information.
-
-
-Installing Rules
-----------------
-
-Rules are normally installed by running a sa-update command.
-The version of sa-update program should match the version of SpamAssassin
-modules, so invoking sa-update should be performed only after installing
-or upgrading SpamAssassin code, not before.
-
-Installing rules from network is done with a single command:
-
-        sa-update
-
-This is normally run as root.
-
-If you wish to install rules from downloaded files, rather than "live" from
-the latest online ruleset, here is how to do it.
-
-Obtain all the following files:
-
-    Mail-SpamAssassin-rules-xxx.tgz
-    Mail-SpamAssassin-rules-xxx.tgz.asc
-    Mail-SpamAssassin-rules-xxx.tgz.md5
-    Mail-SpamAssassin-rules-xxx.tgz.sha1
-      (where xxx may look something like '3.3.0-rc1.r893295')
-
-Save them all to the current directory.
-Obtain a rules-signing public key:
-
-    curl -O http://spamassassin.apache.org/updates/GPG.KEY
-
-Import the signing key to the SpamAssassin gpg keyring, so that the rules
-files can be verified safely:
-
-    sa-update --import GPG.KEY
-
-Install rules from a compressed tar archive:
-
-    sa-update --install Mail-SpamAssassin-rules-xxx.tgz
-
-Note that the ".tgz.asc", ".tgz.md5" and ".tgz.sha1" files all need to
-be in the same directory, otherwise sa-update will fail.
-
-
-If the intended rules destination directory differs from a default location
-as assumed by sa-update and SpamAssassin, such as when running a content
-filter within a Unix jail or on an unusual installation, please supply the
-rules destination directory to sa-update through its option --updatedir,
-such as:
-
-    sa-update --updatedir /var/jail/var/db/spamassassin/3.003000
-
-
-CPAN
-----
-
-Most of the modules listed below are available via the Comprehensive Perl
-Archive Network (CPAN, see http://www.cpan.org/ for more information).
-While each module is different, most can be installed via a few simple
-commands such as:
-
-	$ perl -MCPAN -e shell
-	cpan> o conf prerequisites_policy ask
-	cpan> install Module::Name
-	cpan> quit
-
-If there are problems or questions regarding the installation any of the
-modules, please see the CPAN and relevant module's documentation for more
-information.  We can't provide documentation or installation support for
-third party modules.
-
-Additional information about the CPAN module is also available via
-"perldoc CPAN".
-
-Most Linux distributions also offer the CPAN modules in their own native
-formats (RPMs, Debian packages, etc.), so you should be able to find these
-through those mechanisms, too, if you prefer.
-
-
-Required Perl Interpreter
--------------------------
-
-Perl 5.8.1 or a later version is required.
-Preferred versions are 5.8.8, or 5.10.1 or later.
-
-Most of the functions might still work with Perl 5.6.1 or 5.6.2,
-but 5.6.* is no longer a supported version.
-
-
-Required Perl Modules
----------------------
-
-In addition to the modules associated with Perl, some additional modules
-need to be installed or upgraded depending on the version of Perl that you
-are running.
-
-You can get an immediate report on which of these modules you may need (or
-want) to upgrade, by running "perl build/check_dependencies" from the
-SpamAssassin build directory.
-
-The list of required modules that do not ship with Perl and must be
-installed:
-
-  - Digest::SHA1 (from CPAN),
-    or the newer Digest::SHA which is a perl base module since Perl 5.10.0
-
-    The Digest::SHA1 module is used as a cryptographic hash for some
-    tests and the Bayes subsystem if Digest::SHA module is not available.
-
-    An external perl module razor-agents-2.84 as used by a Razor2 plugin
-    seems to be the only remaining component depending on Digest::SHA1
-    (note that a packager may ship a patched version of razor-agents which
-    can use Digest::SHA instead)
-
-    Debian: apt-get install libdigest-sha1-perl
-    Gentoo: emerge dev-perl/Digest-SHA1
-    Fedora: yum install perl-Digest-SHA1
-
-  - HTML::Parser >= 3.43 (from CPAN)
-
-    HTML is used for an ever-increasing amount of email so this dependency
-    is unavoidable.  Run "perldoc -q html" for additional information.
-
-    Debian: apt-get install libhtml-parser-perl
-    Gentoo: emerge dev-perl/HTML-Parser
-    Fedora: yum install perl-HTML-Parser
-
-  - Net::DNS (from CPAN)
-
-    Used for all DNS-based tests (SBL, XBL, SpamCop, DSBL, etc.),
-    perform MX checks, used when manually reporting spam to SpamCop,
-    and used by sa-update to gather version information.
-
-    You need to make sure the Net::DNS version is sufficiently up-to-date:
-
-      - version 0.34 or higher on Unix systems
-      - version 0.46 or higher on Windows systems
-
-    Debian/Ubuntu: apt-get install libnet-dns-perl
-    Fedora: yum install perl-Net-DNS
-
-  - NetAddr::IP (from CPAN)
-
-    Used to parse IP addresses and IP address ranges for
-    "trusted_networks".
-
-    Debian/Ubuntu: apt-get install libnetaddr-ip-perl
-    Fedora: yum install perl-NetAddr-IP
-
-  - Time::HiRes (from CPAN)
-
-    Used by asynchronous DNS lookups to operate timeouts with subsecond
-    precision and to report processing times accurately.
-
-  - LWP (aka libwww-perl) (from CPAN)
-
-    This set of modules will include both the LWP::UserAgent and
-    HTTP::Date modules, used by sa-update to retrieve update archives.
-
-    Fedora: yum install perl-libwww-perl
-
-  - HTTP::Date (from CPAN)
-
-    Used by sa-update to deal with certain Date requests.
-
-  - IO::Zlib (from CPAN)
-
-    Used by sa-update to uncompress update archives.
-    Version 1.04 or later is required.
-
-    Fedora: yum install perl-IO-Zlib
-
-  - Archive::Tar (from CPAN)
-
-    Used by sa-update to expand update archives.
-    Version 1.23 or later is required.
-
-    Fedora: yum install perl-Archive-Tar
-
-
-Optional Modules
-----------------
-
-In addition, the following modules will be used for some checks, if
-available and the version is high enough.  If they are not available or if
-their version is too low, SpamAssassin will still work, just not as
-effectively because some of the spam-detection tests will have to be
-skipped.
-
-Note: SpamAssassin will not warn you if these are installed, but the
-version is too low for them to be used.
-
-  - MIME::Base64
-
-    This module is highly recommended to increase the speed with which
-    Base64 encoded messages/mail parts are decoded.
-
-
-  - DB_File (from CPAN, included in many distributions)
-
-    Used to store data on-disk, for the Bayes-style logic and
-    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
-    http://wiki.apache.org/spamassassin/DbFileSleepBug for details.
-
-
-  - Net::SMTP (from CPAN)
-
-    Used when manually reporting spam to SpamCop.
-
-
-  - Mail::SPF (from CPAN)
-
-    Used to check DNS Sender Policy Framework (SPF) records to fight email
-    address forgery and make it easier to identify spams.  This module
-    makes Mail::SPF::Query obsolete.
-
-    Net::DNS version 0.58 or higher is required.
-
-    Note that NetAddr::IP (required by Mail::SPF) versions up to and
-    including version 4.006 include a bug that will slow down the entire
-    perl interpreter.  NetAddr::IP version 4.007 or later fixes this.
-
-
-  - IP::Country::Fast (from CPAN)
-
-    Used by the RelayCountry plugin (not enabled by default) to determine
-    the domain country codes of each relay in the path of an email.
-
-
-  - Net::Ident (from CPAN)
-
-    If you plan to use the --auth-ident option to spamd, you will need
-    to install this module.
-
-
-  - IO::Socket::INET6 (from CPAN)
-
-    This is required if the first nameserver listed in your IP
-    configuration or /etc/resolv.conf file is available only via an IPv6
-    address.
-
-    Fedora: yum install perl-IO-Socket-INET6
-
-
-  - IO::Socket::SSL (from CPAN)
-
-    If you wish to use SSL encryption to communicate between spamc and
-    spamd (the --ssl option to spamd), you need to install this
-    module. (You will need the OpenSSL libraries and use the
-    ENABLE_SSL="yes" argument to Makefile.PL to build and run an SSL
-    compatibile spamc.)
-
-    Fedora: yum install perl-IO-Socket-SSL
-
-
-  - Compress::Zlib (from CPAN)
-
-    If you wish to use the optional zlib compression for communication
-    between spamc and spamd (the -z option to spamc), useful for
-    long-distance use of spamc over the internet, you need to install
-    this module.
-
-    Fedora: yum install perl-Compress-Zlib
-
-
-  - Mail::DKIM (from CPAN)
-
-    If this module is installed, and you enable the DKIM plugin,
-    SpamAssassin will perform DKIM lookups when a DKIM-Signature header is
-    present in the message headers.  Current versions of Mail::DKIM (0.20
-    or later) also perform Domain Key lookups on DomainKey-Signature headers,
-    without requiring the Mail::DomainKeys module, which is now obsolete.
-    Version 0.37 or later is preferred, the absolute minimal version is 0.31.
-    
-    Note that the Mail::DKIM module in turn requires the Digest::SHA module
-    and OpenSSL libraries.
-
-
-  - DBI *and* DBD driver/modules for your database (from CPAN)
-
-    If you intend to use SpamAssassin with an SQL database backend for
-    user configuration data, Bayes storage, or other storage, you will need
-    to have these installed; both the basic DBI module and the driver for
-    your database.
-
-
-  - Encode::Detect (from CPAN)
-
-    If you plan to use the normalize_charset config setting to detect
-    charsets and convert them into Unicode, you will need to install
-    this module.
-
-
-  - Apache::Test (from CPAN)
-
-    If you plan to run the Apache2 version of spamd in the
-    "spamd-apache2" directory, you will need to install this
-    module.
-
-
-  - Apache 2 and mod_perl
-
-    If you plan to run the Apache2 version of spamd in the "spamd-apache2"
-    directory, you will need to ensure these are installed.
-
-    Ubuntu: sudo apt-get install apache2 libapache2-mod-perl2
-
-
-  - Razor2
-
-    If you plan to use Vipul's Razor, note that versions up to and
-    including version 2.82 include a bug that will slow down the entire
-    perl interpreter.  Version 2.83 or later fixes this.
-
-    If you do not plan to use this plugin, be sure to comment out
-    its loadplugin line in "/etc/mail/spamassassin/v310.pre".
-
-
-What Next?
-----------
-
-Take a look at the USAGE document for more information on how to use
-SpamAssassin.
-
-The SpamAssassin Wiki <http://wiki.spamassassin.org/> contains
-information on custom plugins, extensions, and other optional modules
-included with SpamAssassin.
-
-
-(end of INSTALL)
-
-// vim:tw=74:

=== removed file '.pc/10_change_config_paths/README'
--- .pc/10_change_config_paths/README	2010-03-01 00:57:24 +0000
+++ .pc/10_change_config_paths/README	1970-01-01 00:00:00 +0000
@@ -1,354 +0,0 @@
-Welcome to SpamAssassin!
-------------------------
-
-What SpamAssassin Is
---------------------
-
-SpamAssassin is a mail filter which attempts to identify spam using
-a variety of mechanisms including text analysis, Bayesian filtering,
-DNS blocklists, and collaborative filtering databases.
-
-SpamAssassin is a project of the Apache Software Foundation (ASF).
-
-
-What SpamAssassin Is Not
-------------------------
-
-SpamAssassin is not a program to delete spam, route spam and ham to
-separate mailboxes or folders, or send bounces when you receive spam.
-Those are mail routing functions, and SpamAssassin is not a mail
-router.  SpamAssassin is a mail filter or classifier.  It will examine
-each message presented to it, and assign a score indicating the
-likelihood that the mail is spam.  An external program must then
-examine this score and do any routing the user wants done.  There are
-many programs that will easily perform these functions after examining
-the score assigned by SpamAssassin.
-
-
-How SpamAssassin Works
-----------------------
-
-SpamAssassin uses a wide range of heuristic tests on mail headers and
-body text to identify "spam", also known as unsolicited commercial
-email.
-
-Once identified, the mail can then be optionally tagged as spam for
-later filtering using the user's own mail user-agent application.
-
-SpamAssassin typically differentiates successfully between spam and
-non-spam in between 95% and 100% of cases, depending on what kind of mail
-you get and your training of its Bayesian filter.  Specifically,
-SpamAssassin has been shown to produce around 1.5% false negatives (spam
-that was missed) and around 0.06% false positives (ham incorrectly marked
-as spam).  See the rules/STATISTICS*.txt files for more information.
-
-SpamAssassin also includes plugins to support reporting spam messages
-automatically or manually to collaborative filtering databases such as
-Pyzor, DCC, and Vipul's Razor.
-
-The distribution provides "spamassassin", a command line tool to
-perform filtering, along with the "Mail::SpamAssassin" module set
-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, "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.
-
-
-Questions? Need Help?
----------------------
-
-If you have questions about SpamAssassin, please check the Wiki[1] to
-see if someone has already posted an answer to your question. (The
-Wiki doubles as a FAQ.) Failing that, post a message to the
-spamassassin-users mailing list[2]. If you've found a bug (and you're
-sure it's a bug after checking the Wiki), please file a report in our
-Bugzilla[3].
-
-	[1]: http://wiki.apache.org/spamassassin/
-	[2]: http://wiki.apache.org/spamassassin/MailingLists
-	[3]: http://issues.apache.org/SpamAssassin/
-
-Please also be sure to read the man pages.
-
-
-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.
-
-
-Installing SpamAssassin
------------------------
-
-See the INSTALL file.
-
-
-Customising SpamAssassin
-------------------------
-
-These are the configuration files installed by SpamAssassin.  The commands
-that can be used therein are listed in the POD documentation for the
-Mail::SpamAssassin::Conf class (run the following command to read it:
-"perldoc Mail::SpamAssassin::Conf").  Note: The following directories are
-the standard defaults that people use.  There is an explanation of all the
-default locations that SpamAssassin will look at the end.
-
-  - /usr/share/spamassassin/*.cf:
-
-	Distributed configuration files, with all defaults.  Do not modify
-	these, as they are overwritten when you upgrade.
-
-  - /var/lib/spamassassin/*/*.cf:
-
-        Local state directory; updated rulesets, overriding the
-        distributed configuration files, downloaded using "sa-update". Do
-        not modify these, as they are overwritten when you run
-        "sa-update".
-
-  - /etc/mail/spamassassin/*.cf:
-
-  	Site config files, for system admins to create, modify, and
-	add local rules and scores to.  Modifications here will be
-	appended to the config loaded from the above directory.
-
-  - /etc/mail/spamassassin/*.pre:
-
-        Plugin control files, installed from the distribution. These are
-        used to control what plugins are loaded.  Modifications here will
-        be loaded before any configuration loaded from the above
-        directories.
-        
-        You want to modify these files if you want to load additional
-        plugins, or inhibit loading a plugin that is enabled by default.
-        If the files exist in /etc/mail/spamassassin, they will not
-        be overwritten during future installs.
-
-  - /usr/share/spamassassin/user_prefs.template:
-
-	Distributed default user preferences. Do not modify this, as it is
-	overwritten when you upgrade.
-
-  - /etc/mail/spamassassin/user_prefs.template:
-
-	Default user preferences, for system admins to create, modify, and
-	set defaults for users' preferences files.  Takes precedence over
-	the above prefs file, if it exists.
-
-        Do not put system-wide settings in here; put them in a file in the
-        "/etc/mail/spamassassin" directory ending in ".cf". This file is
-        just a template, which will be copied to a user's home directory
-        for them to change.
-
-  - $USER_HOME/.spamassassin:
-
-  	User state directory.  Used to hold spamassassin state, such
-	as a per-user automatic whitelist, and the user's preferences
-	file.
-
-  - $USER_HOME/.spamassassin/user_prefs:
-
-  	User preferences file.  If it does not exist, one of the
-	default prefs file from above will be copied here for the
-	user to edit later, if they wish.
-
-	Unless you're using spamd, there is no difference in
-	interpretation between the rules file and the preferences file, so
-	users can add new rules for their own use in the
-	"~/.spamassassin/user_prefs" file, if they like.  (spamd disables
-	this for security and increased speed.)
-
-  - $USER_HOME/.spamassassin/bayes*
-
-	Statistics databases used for Bayesian filtering.  If they do
-	not exist, they will be created by SpamAssassin.
-
-	Spamd users may wish to create a shared set of bayes databases;
-	the "bayes_path" and "bayes_file_mode" configuration settings
-	can be used to do this.
-
-	See "perldoc sa-learn" for more documentation on how
-	to train this.
-
-File Locations:
-
-SpamAssassin will look in a number of areas to find the default
-configuration files that are used.  The "__*__" text are variables
-whose value you can see by looking at the first several lines of the
-"spamassassin" or "spamd" scripts.
-
-They are set on install time and can be overridden with the Makefile.PL
-command line options DATADIR (for __def_rules_dir__) and CONFDIR (for
-__local_rules_dir__).  If none of these options were given, FHS-compliant
-locations based on the PREFIX (which becomes __prefix__) are chosen.
-These are:
-
-  __prefix__    __def_rules_dir__              __local_rules_dir__
-  -------------------------------------------------------------------------
-  /usr          /usr/share/spamassassin        /etc/mail/spamassassin
-  /usr/local    /usr/local/share/spamassassin  /etc/mail/spamassassin
-  /opt/$DIR     /opt/$DIR/share/spamassassin   /etc/opt/mail/spamassassin
-  $DIR          $DIR/share/spamassassin        $DIR/etc/mail/spamassassin
-
-The files themselves are then looked for in these paths:
-
-  - Distributed Configuration Files
-        '__def_rules_dir__'
-        '__prefix__/share/spamassassin'
-        '/usr/local/share/spamassassin'
-        '/usr/share/spamassassin'
-
-  - Site Configuration Files
-        '__local_rules_dir__'
-        '__prefix__/etc/mail/spamassassin'
-        '__prefix__/etc/spamassassin'
-        '/usr/local/etc/spamassassin'
-        '/usr/pkg/etc/spamassassin'
-        '/usr/etc/spamassassin'
-        '/etc/mail/spamassassin'
-        '/etc/spamassassin'
-
-  - Default User Preferences File
-        '__local_rules_dir__/user_prefs.template'
-        '__prefix__/etc/mail/spamassassin/user_prefs.template'
-        '__prefix__/share/spamassassin/user_prefs.template'
-        '/etc/spamassassin/user_prefs.template'
-        '/etc/mail/spamassassin/user_prefs.template'
-        '/usr/local/share/spamassassin/user_prefs.template'
-        '/usr/share/spamassassin/user_prefs.template'
-
-
-In addition, the "Distributed Configuration Files" location is overridden
-by a "Local State Directory", used to store an updated copy of the
-ruleset:
-
-  __prefix__    __local_state_dir__
-  -------------------------------------------------------------------------
-  /usr          /var/lib/spamassassin/__version__
-  /usr/local    /var/lib/spamassassin/__version__
-  /opt/$DIR     /var/opt/spamassassin/__version__
-  $DIR          $DIR/var/spamassassin/__version__
-
-This is normally written to by the "sa-update" script.  "__version__" is
-replaced by a representation of the version number, so that multiple
-versions of SpamAssassin will not interfere with each other's rulesets.
-
-
-After installation, try "perldoc Mail::SpamAssassin::Conf" to see what
-can be set. Common first-time tweaks include:
-
-  - required_score
-
-	Set this higher to make SpamAssassin less sensitive.
-        If you are installing SpamAssassin system-wide, this is
-        **strongly** recommended!
-
-        Statistics on how many false positives to expect at various
-        different thresholds are available in the "STATISTICS.txt" file in
-        the "rules" directory.
-
-  - rewrite_header, add_header
-
-        These options affect the way messages are tagged as spam or
-	non-spam. This makes it easy to identify incoming mail.
-
-  - ok_locales
-
-	If you expect to receive mail in non-ISO-8859 character sets (ie.
-	Chinese, Cyrillic, Japanese, Korean, or Thai) then set this.
-
-
-Learning
---------
-
-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
-
-
-If these are mail folders in mbox format, use the --mbox switch, for
-Maildirs use a trailing slash, like Maildir/cur/.
-
-Use as many mailboxes as you like.  Note that SpamAssassin will remember
-what mails it has learnt from, so you can re-run this as often as you like.
-
-
-Locali[sz]ation
----------------
-
-All text displayed to users is taken from the configuration files.  This
-means that you can translate messages, test descriptions, and templates
-into other languages.
-
-If you do so, we would *really* appreciate it if you could contribute
-these translations, so that they can be added to the
-distribution. Please file a bug in our Bugzilla[4], and attach your
-translations. You will, of course, be credited for this work!
-
-	[4]: http://issues.apache.org/SpamAssassin/
-
-
-Disabled code
--------------
-
-There are some tests and code in SpamAssassin that are turned off by
-default: experimental code, slow code, or code that depends on
-non-open-source software or services that are not always free.  These
-disabled tests include:
-
-  - DCC: depends on non-open-source software (disabled in init.pre)
-  - MAPS: commercial service (disabled in 50_scores.cf)
-  - TextCat: slow (disabled in init.pre)
-  - various optional plugins, disabled for speed (disabled in *.pre)
-
-To turn on tests disabled in 50_scores.cf, simply assign them a non-zero
-score, e.g. by adding score lines to your ~/.spamassassin/user_prefs file.
-
-To turn on tests disabled by commenting out the required plugin in
-init.pre, you need to uncomment the loadplugin line and make sure the
-prerequisites for proper operation of the plugin are present.
-
-
-Automatic Whitelist System
---------------------------
-
-SpamAssassin includes automatic whitelisting; The current iteration is
-considerably more complex than the original version.  The way it works is
-by tracking for each sender address the average score of messages so far
-seen from there.  Then, it combines this long-term average score for the
-sender with the score for the particular message being evaluated, after
-all other rules have been applied.
-
-This functionality is on by default, and is enabled or disabled with the
-"use_auto_whitelist" option.
-
-A system-wide auto-whitelist can be used, by setting the
-auto_whitelist_path and auto_whitelist_file_mode configuration commands
-appropriately, e.g.
-
-    auto_whitelist_path        /var/spool/spamassassin/auto-whitelist
-    auto_whitelist_file_mode   0666
-
-The spamassassin -W and -R command line flags provide an API to add and
-remove entries 'manually', if you so desire.  They operate based on an
-input mail message, to allow them to be set up as aliases which users can
-simply forward their mails to.  See the spamassassin manual page for more
-details.
-
-The default address-list implementation,
-Mail::SpamAssassin::DBBasedAddrList, uses Berkeley DB files to store
-the addresses.
-
-(end of README)
-
-// vim:tw=74:

=== removed file '.pc/10_change_config_paths/UPGRADE'
--- .pc/10_change_config_paths/UPGRADE	2010-03-01 00:57:24 +0000
+++ .pc/10_change_config_paths/UPGRADE	1970-01-01 00:00:00 +0000
@@ -1,309 +0,0 @@
-Note for Users Upgrading to SpamAssassin 3.3.0
------------------------------------------------
-
-- Rules are no longer included with SpamAssassin "out of the box".  You will
-  need to immediately run "sa-update", or download the additional rules .tgz
-  package and run "sa-update --install" with it, to get a ruleset.
-
-- The BETA label has been taken off of the SpamAssassin SQL support.  Please
-  be aware that occasional changes may still be made to this area of the
-  code.  You should be sure to read this upgrade document each time you
-  install a new version to determine if any SQL updates need to be made to
-  your local installation.
-
-- The DKIM plugin is now enabled by default for new installs, if the perl
-  module Mail::DKIM is installed.  However, installation of SpamAssassin
-  will not overwrite existing .pre configuration files, so to use DKIM when
-  upgrading from a previous release that did not use DKIM, a directive:
-
-    loadplugin Mail::SpamAssassin::Plugin::DKIM
-
-  will need to be uncommented in file "v312.pre", or added to some
-  other .pre file, such as local.pre.
-
-
-Note for Users Upgrading to SpamAssassin 3.2.0
------------------------------------------------
-
-- The "127/8" network, including 127.0.0.1, is now always implicitly part of
-  "trusted_networks" and "internal_networks".  It's impossible to remove these
-  from the trusted/internal sets, since if you cannot trust the host where
-  SpamAssassin is running, you cannot trust SpamAssassin itself.  If you
-  previously had "trusted_networks" and "internal_networks" lines listing those
-  hosts, you should now remove them, otherwise a minor (non-lint-error) warning
-  will be output.
-
-- For ISPs -- version 3.2.0 now includes a new way to specify Mail Submission
-  Agents, relay hosts which accept mail from your own users and authenticates
-  them appropriately.  See the Mail::SpamAssassin::Conf manual page for the
-  "msa_networks" setting.
-
-
-Note for Users Upgrading to SpamAssassin 3.1.0
------------------------------------------------
-
-- A significant amount of core functionality has been moved into
-  plugins.  These include, AWL (auto-whitelist), DCC, Pyzor, Razor2,
-  SpamCop reporting and TextCat.  For information on configuring these
-  plugins please refer to their individual documentation:
-  perldoc Mail::SpamAssassin::Plugin::* (ie AWL, DCC, etc)
-
-- There are now multiple files read to enable plugins in the
-  /etc/mail/spamassassin directory; previously only one, "init.pre" was
-  read.  Now both "init.pre", "v310.pre", and any other files ending
-  in ".pre" will be read.  As future releases are made, new plugins
-  will be added to new files named according to the release they're
-  added in.
-
-- Due to license restrictions the DCC and Razor2 plugins are disabled
-  by default.  We encourage you to read the appropriate license
-  yourself and decide if you are able to re-enable the plugins for
-  your site.
-
-- The use_auto_whitelist config option has been moved to a user config
-  option, this allows individual users to turn on or off whitelisting
-  regardless of what is set in the system config.  If you would like to
-  disable AWL (auto-whitelist) on a site-wide basis, then you can comment
-  out the plugin in "v310.pre".
-
-- The bayes_auto_learn_threshold_* config options for bayes have moved
-  to a plugin.  In general the default should work just fine however
-  if you are interested in changing these values you should see:
-  perldoc Mail::SpamAssassin::Plugin::AutoLearnThreshold
-
-- The AWL support for NDBM_File databases has been dropped, due to a
-  bug in that package which renders it useless (bug 4353).  It appears
-  that SDBM_File, the package which will be used instead, is fully
-  compatible with NDBM however, so this should be unnoticeable.
-
-- The prefork algorithm for spamd has been changed.  In this version spamd
-  will attempt to keep a small number of "hot" child processes as busy as
-  possible, and keep any others as idle as possible, using something
-  similar to the Apache httpd server scaling algorithm. This reduces
-  memory usage and swapping. You can use the --round-robin switch for
-  spamd to disable this scaling algorithm, and the behaviour seen in the
-  3.0.x versions will be used instead, where all processes receive an
-  equal load and no scaling takes place.
-
-- As of 3.1.0, in addition to the generic BayesSQL support (via
-  Mail::SpamAssassin::BayesStore::SQL) usable by multiple database
-  drivers there is now specific support for MySQL 4.1+ and
-  PostgreSQL.  This support is based on non-standard features present
-  in both database servers that allow for various performance boosts.
-
-  If you were using the previous BayesSQL support with MySQL, and
-  already have MySQL 4.1+ installed you can begin using the new module
-  immediately by replacing the bayes_store_module line in your
-  configuration with:  Mail::SpamAssassin::BayesStore::MySQL
-
-  We do however recommend that you switch your MySQL tables over to
-  InnoDB for better data integrity and multi user support.  You can
-  most often do this via a simple ALTER TABLE command, refer to the
-  MySQL documentation for more information.
-
-  If you were previously using PostgreSQL for your bayes database then
-  we STRONGLY recommend switching to the PostgreSQL specific backend:
-  Mail::SpamAssassin::BayesStore::PgSQL
-  To switch to this backend you should first run sa-learn --backup to
-  make a backup of your existing data and then drop and recreate the
-  database following the instructions in sql/README.bayes.  Then you
-  can restore the database with sa-learn --restore.  If you have
-  multiple users then you will have to run --backup and --restore for
-  each user to fully restore the database.
-
-- See http://wiki.apache.org/spamassassin/UpgradeTo310 for a
-  supplementary list of upgrade notes.  It will be updated with any
-  upgrade notes not captured in this document.
-
-- Finally, this document is likely not complete.  Other configuration
-  options/arguments may have changed from older versions, etc.  It would
-  be good to double-check any custom configuration options to make sure
-  they're still valid.  This could be as simple as running "spamassassin
-  --lint", or more complex, as required by the environment.
-
-
-Note for Users Upgrading to SpamAssassin 3.0.x
-----------------------------------------------
-
-- The SpamAssassin 2.6x release series was the last set of releases to
-  officially support perl versions earlier than perl 5.6.1.  If you are
-  using an earlier version of perl, you will need to upgrade before you
-  can use the 3.0.0 version of SpamAssassin.  You will also want to make
-  sure that you have the appropriate versions of required and optional
-  modules as they may have changed from old versions.  The INSTALL
-  document has the modules and version requirements listed.
-
-- See http://wiki.apache.org/spamassassin/UpgradeTo300 for a
-  supplementary list of upgrade notes.  It will be updated with any
-  upgrade notes not captured in this document.
-
-- SpamAssassin 3.0.0 has a significantly different API (Application Program
-  Interface) from the 2.x series of code.  This means that if you use
-  SpamAssassin through a third-party utility (milter, etc,) you need to make
-  sure you have an updated version which supports 3.0.0.  See
-  http://wiki.apache.org/spamassassin/UpgradeTo300 for information about
-  third-party software.
-
-- The --auto-whitelist, --whitelist and -a options for "spamd" and
-  "spamassassin" to turn on the auto-whitelist have been removed and
-  replaced by the "use_auto_whitelist" configuration option which is
-  also now turned on by default.
-
-- The --virtual-config switch for spamd had to be dropped, due to licensing
-  issues.  It is replaced by the --virtual-config-dir switch.
-
-- The "rewrite_subject" and "subject_tag" configuration options were
-  deprecated and are now removed. Instead, using "rewrite_header Subject
-  [your desired setting]".  e.g.
-
-    rewrite_subject 1
-    subject_tag ****SPAM(_SCORE_)****
-
-  becomes
-
-    rewrite_header Subject ****SPAM(_SCORE_)****
-
-- The "sa-learn --rebuild" command has been deprecated; please use
-  "sa-learn --sync" instead.  The --rebuild option will remain temporarily
-  for backwards compatability.
-
-- The Bayesian storage modules have been completely re-written and now
-  include Berkeley DB (DBM) storage as well as SQL based storage (see
-  sql/README.bayes for more information).  In addition, a new format
-  has been introduced for the bayes database that stores tokens in fixed
-  length hashes (Bayes v3).  All DBM databases should be automatically
-  converted to this new format the first time they are opened for write.
-  You can manually perform the upgrade by running "sa-learn --sync"
-  from the command line.
-
-  Due to the database format change, you will want to do something like
-  this when upgrading:
-
-  - stop running spamassassin/spamd (ie: you don't want it to be running
-    during the upgrade)
-  - run "sa-learn --rebuild", this will sync your journal.  if you skip
-    this step, any data from the journal will be lost when the DB is
-    upgraded.
-  - upgrade SA to 3.0.0
-  - run "sa-learn --sync", which will cause the db format to be upgraded.
-    if you want to see what is going on, you can add the "-D" option.
-  - test the new database by running some sample mails through
-    SpamAssassin, and/or at least running "sa-learn --dump" to make sure
-    the data looks valid.
-  - start running spamassassin/spamd again
-
-  If, instead of uprading your Bayes database, you want to wipe it and
-  start fresh, you can run "sa-learn --clear" to safely remove your
-  Bayes database files.  If the --clear command issues an error then
-  you can simply delete the Bayes database files ("bayes_*") while SA
-  is not running; SpamAssassin will recreate them in the current
-  format when it runs.
-
-- "spamd" now has a default max-children setting of 5; no more than 5
-  child scanner processes will be run in parallel.  Previously, there was
-  no default limit unless you specified the "-m" switch when starting
-  spamd.
-
-- If you are using a UNIX machine with all database files on local disks,
-  and no sharing of those databases across NFS filesystems, you can use a
-  more efficient, but non-NFS-safe, locking mechanism.   Do this by adding
-  the line "lock_method flock" to the /etc/mail/spamassassin/local.cf
-  file. This is strongly recommended if you're not using NFS, as it is
-  much faster than the NFS-safe locker.
-
-- Please note that the use of the following commandline parameters for
-  spamassassin and spamd have been deprecated and may be removed in
-  upcoming versions of SpamAssassin.  Please discontinue usage of these
-  options:
-
-    in the 2.6x series:		--add-from, --pipe, -F, --stop-at-threshold,
-    				-S, -P (spamassassin only)
-    in the 3.0.x series:	--auto-whitelist, -a, --whitelist-factory, -M,
-    				--warning-from, -w, --log-to-mbox, -l
-
-- user_scores_sql_table is no longer supported.  If you need to use a table
-  name, other than the default, create a custom query using the
-  user_scores_sql_custom_query config option.
-
-- SpamAssassin runs in "taint mode" by default for improved security.
-  Certain third-party modules may be incompatible with taint mode.
-
-- 2.6x deprecated the use of the "check_bayes_db" script, and it
-  has been removed in 3.0.0.  Please see the sa-learn man/pod
-  documentation for more info.
-
-- Finally, this document is likely not complete.  Other configuration
-  options/arguments may have changed from older versions, etc.  It would
-  be good to double-check any custom configuration options to make sure
-  they're still valid.  This could be as simple as running "spamassassin
-  --lint", or more complex, as required by the environment.
-
-  An example: "require_version <version>" hasn't changed itself, but the
-  internal version representation is now "x.yyyzzz" instead of "x.yz"
-  which could cause issues if "require_version 3.00" is expected to work
-  (it won't, it needs to be "require_version 3.000000").
-
-
-Note for Users Upgrading from SpamAssassin 2.5x
------------------------------------------------
-
-- Due to major reliability shortcomings in the database support libraries
-  other than DB_File, we now require that the DB_File module be installed
-  to use SpamAssassin's Bayes rules.
-
-  SpamAssassin will still work without DB_File installed, but the Bayes
-  support will be disabled.
-
-  If you install DB_File and wish to import old Bayes database data, each
-  user with a Bayes db should run "sa-learn --import" to copy old entries
-  from the other formats into a new DB_File file.
-
-  Due to the database library change, and the change to the database
-  format itself, you will want to do something like this when upgrading:
-
-  - stop running spamassassin/spamd (ie: you don't want it to be running
-    during the upgrade)
-  - run "sa-learn --rebuild", this will sync your journal.  if you skip
-    this step, any data from the journal will be lost when the DB is
-    upgraded.
-  - install DB_File module if necessary
-  - upgrade SA to 3.0.0
-  - if you were using another database module previously, run "sa-learn
-    --import" to migrate the data into new DB_File files
-  - run "sa-learn --sync", which will cause the db format to be upgraded.
-    if you want to see what is going on, you can add the "-D" option.
-  - test the new database by running some sample mails through
-    SpamAssassin, and/or at least running "sa-learn --dump" to make sure
-    the data looks valid.
-  - start running spamassassin/spamd again
-
-  Obviously the steps will be different depending on your environment, but
-  you get the idea. :)
-
-
-Note For Users Upgrading From SpamAssassin 2.3x or 2.4x
--------------------------------------------------------
-
-- SpamAssassin no longer includes code to handle local mail delivery, as
-  it was not reliable enough, compared to procmail.  So now, if you relied
-  on spamassassin to write the mail into your mail folder, you'll have to
-  change your setup to use procmail as detailed below.  If you used
-  spamassassin to filter your mail and then something else wrote it into a
-  folder for you, then you should be fine.
-
-- Support for versions of the optional Mail::Audit module is no longer
-  included.
-
-- The default mode of tagging (which used to be ***SPAM*** in the subject
-  line) no longer takes place.  Instead the message is rewritten. If an
-  incoming message is tagged as spam, instead of modifying the original
-  message, SpamAssassin will create a new report message and attach the
-  original message as a message/rfc822 MIME part (ensuring the original
-  message is completely preserved and easier to recover).  If you do not
-  want to modify the body of incoming spam, use the "report_safe" option.
-  The "report_header" and "defang_mime" options have been removed as a
-  result.
-
-(end of UPGRADE)
-
-//vim:tw=74:

=== removed file '.pc/10_change_config_paths/USAGE'
--- .pc/10_change_config_paths/USAGE	2010-03-01 00:57:24 +0000
+++ .pc/10_change_config_paths/USAGE	1970-01-01 00:00:00 +0000
@@ -1,248 +0,0 @@
-
-Important Note For Users Upgrading From Earlier Versions
---------------------------------------------------------
-
-SpamAssassin no longer includes code to handle local mail delivery, as it
-was not reliable enough, compared to procmail.  So now, if you relied on
-spamassassin to write the mail into your mail folder, you'll have to
-change your setup to use procmail as detailed below.
-
-If you used spamassassin to filter your mail and then something else wrote
-it into a folder for you, then you should be fine.
-
-Steps to take for every installation:
-
-  - Install Mail::SpamAssassin on your mail server, as per the INSTALL
-    document.
-
-  - Test it:
-
-      spamassassin -t < sample-nonspam.txt > nonspam.out
-      spamassassin -t < sample-spam.txt > spam.out
-
-    Verify (using a text viewer, ie. "less" or "notepad") that nonspam.out
-    has not been tagged as spam, and that spam.out has.  The files should
-    contain the full text and headers of the messages, the "spam.out"
-    message should contain the header "X-Spam-Flag: YES" and be annotated
-    with a report from SpamAssassin, and there should be no errors when you
-    run the commands.
-
-    Even though sample-nonspam.txt is not spam, nonspam.out will
-    contain a SpamAssassin report anyway.  This is a side-effect of
-    the "-t" (test) switch.  However, there should be less than 5
-    points accumulated; when the "-t" switch is not in use, the report
-    text would not be added. For more verbose (debugging) output, add
-    the "-D" switch.
-
-    If the commands do not work, DO NOT PROCEED TO THE NEXT STEP, as you
-    will lose mail!
-
-
-
-If you use KMail:
-
-  - http://kmail.kde.org/tools.html mentions:
-
-    The filter setup is the work of five minutes (if that!) if you have a
-    working spamassassin set up.
-
-    The filter in question is "<any header><matches regexp> ."
-
-    The action is "<pipe through> spamassassin"
-
-    Then, in the advanced options, uncheck the "If this filter matches,
-    stop processing here" box. If you keep this filter at the top, it will
-    analyze any incoming mail, decide whether it's spam or not, and flag
-    it accordingly.
-
-    [Then add] a second filter behind it, which searches for the added
-    spam-flags and diverts them into a specific spam folder. [...]
-
-
-
-If you use procmail, or haven't decided on any of the above examples:
-
-  - Make a backup of your .procmailrc (if you already have one).
-
-      cp ~/.procmailrc ~/.procmailrc.bak
-
-  - add the line from procmailrc.example to ~/.procmailrc, at the top of
-    the file before any existing recipes.
-
-    That'll process all mail through SA, and refile spam messages to
-    a folder called "caughtspam" in your home directory.
-
-  - Send yourself a mail message, and ensure it gets to you.  If it does
-    not, copy your old backed-up .procmailrc file back into place and ask
-    your sysadmin for help!  Here's commands to do that:
-
-      cp ~/.procmailrc.bak ~/.procmailrc
-      echo "Help!" | mail root
-
-
-
-If you want to use SpamAssassin site-wide:
-
-  - take a look at the notes on the Wiki website, currently at
-    <http://wiki.apache.org/spamassassin/UsingSiteWide>.  You will probably
-    want to use 'spamd' (see below).   You may want to investigate the
-    new Apache mod_perl module, in the 'spamd-apache2' directory, too.
-
-  - *PLEASE* let your users know you've installed it, and how to turn it
-    off!   This is our #1 tech support query, and the users are usually
-    pretty frustrated once it reaches that stage.
-
-  - *PLEASE* consider setting it up as "off by default" for most accounts,
-    and let users opt-in to using it.  Quite a few folks prefer not to
-    have their mail filtered, presumably because they don't use their
-    email address publically and do not get much spam.
-
-  - Note that procmail users adding spamc to /etc/procmailrc should 
-    add the line 'DROPPRIVS=yes' at the top of the file.
-
-
-The Auto-Whitelist
-------------------
-
-The auto-whitelist is enabled using the 'use_auto_whitelist' option.
-(See http://wiki.apache.org/spamassassin/AutoWhitelist for details on
-how it works, if you're curious.)
-
-
-Other Installation Notes
-------------------------
-
-  
-  - Hashcash is a useful system; it requires that senders exercise a
-    CPU-intensive task before they can send mail to you, so we give that
-    some bonus points.  However, it requires that you list what addresses
-    you expect to receive mail for, by adding 'hashcash_accept' lines to
-    your ~/.spamassassin/user_prefs or /etc/mail/spamassassin/local.cf
-    files.  See the Mail::SpamAssassin::Plugin::Hashcash manual page for
-    details on how to specify these.
-
-
-  - SpamAssassin now uses a temporary file in /tmp (or $TMPDIR, if that's
-    set in the environment) for Pyzor and DCC checks.  Make sure that this
-    directory is either (a) not writable by other users, or (b) not shared
-    over NFS, for security.
-
-
-  - You can create your own system-wide rules files in
-    /etc/mail/spamassassin; their filenames should end in ".cf".  Multiple
-    files will be read, and SpamAssassin will not overwrite these files
-    when installing a new version.
-
-
-  - You should not modify the files in /usr/share/spamassassin; these
-    will be overwritten when you upgrade.  Any changes you make in
-    files in the /etc/mail/spamassassin directory,  however, will
-    override these files.
-
-
-  - Rules can be turned off by setting their scores to 0 in a
-    configuration or user-preference file.
-
-
-  - Speakers of Chinese, Japanese, Korean or Arabic may find it useful to
-    turn off the rules listed at the end of the "user_prefs.template"
-    file; we've found out that these rules are still triggering on
-    non-spam CJK mails.
-
-
-  - If you have an unusual network configuration, you should probably
-    set 'trusted_networks'.  This allows SpamAssassin to determine where
-    your internal network ends and the internet begins, and allows DNS
-    checks to be more accurate. If your mail host is NATed, you will
-    almost certainly need to set 'trusted_networks' to get correct
-    results.
-
-
-  - A very handy new feature is SPF support, which allows you to check
-    that the message sender is permitted by their domain to send from the
-    IP address used.  This has the potential to greatly cut down on mail
-    forgery.  (see http://spf.pobox.com/ for more details.)
-
-
-  - MDaemon users should add this line to their "local.cf" file:
-
-      report_safe_copy_headers X-MDRcpt-To X-MDRemoteIP X-MDaemon-Deliver-To
-
-    Otherwise, MDaemon's internal delivery will fail when SpamAssassin
-    rewrites a message as spam.
-
-
-  - The distribution includes 'spamd', a daemonized version of
-    SpamAssassin which runs persistently.  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. Take a look in the
-    'spamd' and 'spamc' directories for more details.
-
-
-  - The distribution also includes 'spamd-apache2', a mod_perl module
-    allowing the Apache HTTP server to be used as a platform for a
-    daemonized SpamAssassin, in an upwardly-compatible fashion from
-    'spamd'.  If you don't require some of the spamd features it does not
-    implement (such as switching UIDs to read per-user configuration from
-    user home directories), this may be much faster than spamd.  Take a
-    look at the 'spamd-apache2' directory for details.
-
-
-  - spamc can now be built as a shared library for use with milters or
-    to link into other existing programs; simply run "make libspamc.so"
-    to build this.
-
-
-  - If you get spammed, it is helpful to everyone else if you re-run
-    spamassassin with the "-r" option to report the message in question as
-    "verified spam".  This will add it to Vipul's Razor, DCC and Pyzor,
-    assuming you've set these up appropriately.
-
-      spamassassin -r < spam-message
-
-    If you use mutt as your mail reader, this macro will bind the X key to
-    report a spam message.
-
-      macro index X "| spamassassin -r"
-
-    This is, of course, optional -- but you'll get lots of good-netizen
-    karma. ;)
-
-
-  - Quite often, if you've been on the internet for a while, you'll have
-    accumulated a few old email accounts that nowadays get nothing but
-    spam.  You can set these up as spam traps using SpamAssassin; see the
-    ''SPAM TRAPPING'' section of the spamassassin manual page for details.
-
-    If you don't want to go to the bother of setting up a system yourself
-    to do this, take a look here [1] for a simple forwarding-based
-    alternative.
-
-      [1]: http://wiki.apache.org/spamassassin/SpamTrapping
-
-
-  - Scores and other user preferences can now be loaded from, and Bayes
-    and auto-whitelist data can be stored in, an SQL database; see the
-    'sql' subdirectory for more details.
-
-    If you are setting up a large 'spamd' system-wide installation, with
-    Bayes and/or auto-whitelists, we strongly recommend using SQL as
-    storage.  It has proven more reliable than the default DB_File storage
-    backend at several large sites.
-
-
-  - If you are running SpamAssassin under a disk quota, or are setting up
-    'spamd' with users with disk quotas, be warned that the DB_File
-    database module used by SpamAssassin for Bayes and AWL storage seems
-    to be unreliable in the face of quotas (bug 3796). In this situation,
-    we recommend using SQL storage for those databases, instead of DB_File.
-
-
-  - Lots more ways to integrate SpamAssassin can be read at
-    http://wiki.SpamAssassin.org/ .
-
-
-(end of USAGE)
-
-// vim:tw=74:

=== removed directory '.pc/10_change_config_paths/ldap'
=== removed file '.pc/10_change_config_paths/ldap/README'
--- .pc/10_change_config_paths/ldap/README	2010-03-01 00:57:24 +0000
+++ .pc/10_change_config_paths/ldap/README	1970-01-01 00:00:00 +0000
@@ -1,116 +0,0 @@
-
-Using SpamAssassin With An LDAP Server
---------------------------------------
-
-SpamAssassin can now load users' score files from an LDAP server.  The concept
-here is to have a web application (PHP/perl/ASP/etc.) that will allow users to
-be able to update their local preferences on how SpamAssassin will filter their
-e-mail.  The most common use for a system like this would be for users to be
-able to update the white list of addresses (whitelist_from) without the need
-for them to update their $HOME/.spamassassin/user_prefs file.  It is also quite
-common for users listed in /etc/passwd to not have a home directory,
-therefore, the only way to have their own local settings would be through a
-database or LDAP server.
-
-SpamAssassin will check the global configuration file (ie. any file matching
-/etc/mail/spamassassin/*.cf) for the following settings:
-
-  user_scores_dsn ldap://host:port/dc=basedn,dc=de?attr?scope?uid=__USERNAME__
-  user_scores_ldap_username	bind dn
-  user_scores_ldap_password	password
-
-The first option, user_scores_dsn, describes the data source name that will be
-used to create the connection to your LDAP server. You have to write the DSN as
-an LDAP URL, the components being the host and port to connect to, the base DN
-for the search, the scope of the search (base, one or sub), the single
-attribute being the multivalued attribute used to hold the configuration data
-(space separated pairs of key and value, just as in a file) and finally the
-filter being the expression used to filter out the wanted username. Note that
-the filter expression uses the literal text __USERNAME__ as a placeholder for
-the username (SpamAssassin will use a s///g statement to replace it with the
-actual username).
-
-Examples:
-
-  ldap://localhost:389/dc=koehntopp,dc=de?spamassassin?sub?uid=__USERNAME__
-  ldap://localhost:389/o=stooges?spamassassin?sub?uid=__USERNAME__
-
-
-If the user_scores_dsn option does not exist, SpamAssassin will not attempt
-to use an LDAP server for retrieving users' preferences. Note that this will
-NOT look for test rules, only local scores, whitelist_from(s), and
-required_score.
-
-Requirements
-------------
-
-In order for SpamAssassin to work with your LDAP database, you must have
-the perl Net::LDAP module installed. You'll also need the URI module.
-
-In order for spamd to use the LDAP driver, you will have to start spamd
-with the additional parameters '--ldap-config -x'.
-
-Each user that wants to utilise the SpamAssassin LDAP driver must add
-the 'spamassassin' attribute in their object (either manually or via the
-web interface of your making/choice) like this (see the file sa_test.ldif
-in this directory for a full database example):
-
-  spamassassin: add_header all Foo LDAP read
-
-Database Schema
----------------
-
-You can use any schema extension to your user entries with SpamAssassin,
-as long as the attribute is multivalued and correctly named in your LDAP url.
-We are currently using a <customername>spamassassin field that is part of
-our inetOrgPerson subclass.
-
-Here's an example for openldap's /etc/openldap/schema/inetorgperson.schema :
-
-  # SpamAssassin
-  # see http://SpamAssassin.org/ .
-  attributetype ( 2.16.840.1.113730.3.1.217
-          NAME 'spamassassin'
-          DESC 'SpamAssassin user preferences settings'
-	  EQUALITY caseExactMatch
-	  SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 )
-
-(don't forget to add "$ spamassassin" to the objectclass MAY clause.)
-
-
-Testing SpamAssassin/LDAP
--------------------------
-
-To test your LDAP setup, and debug any possible problems, you should start
-spamd with the -D option, which will keep spamd in the foreground, and will
-output debug message to the terminal. You should then test spamd with a
-message by calling spamc.  You can use the sample-spam.txt file with the
-following command:
-
-  cat sample-spam.txt | spamc
-
-Watch the debug output from spamd and look for the following debug line:
-
-  retrieving LDAP prefs for <username>: <value>
-
-If you do not see the above text, then the LDAP query was not successful, and
-you should see any error messages reported. <username> should be the user
-that was passed to spamd and is usually the user executing spamc.
-
-If you need to set up LDAP, a good guide is here:
-http://yolinux.com/TUTORIALS/LinuxTutorialLDAP.html
-
-To test LDAP support using the SpamAssassin test suite, you need to
-perform a little bit of manual configuration first.  See the file
-"ldap/README.testing" for details.
-
-
-******
-NB:  This should be considered BETA, and the interface or overall
-operation of LDAP support may change at any time with future releases of SA.
-******
-
-Please send any comments to <kris at koehntopp.de> and file bugs via
-<http://issues.apache.org/SpamAssassin/>.
-
-Kristian Köhntopp

=== removed directory '.pc/10_change_config_paths/lib'
=== removed directory '.pc/10_change_config_paths/lib/Mail'
=== removed directory '.pc/10_change_config_paths/lib/Mail/SpamAssassin'
=== removed file '.pc/10_change_config_paths/lib/Mail/SpamAssassin/Conf.pm'
--- .pc/10_change_config_paths/lib/Mail/SpamAssassin/Conf.pm	2011-05-14 12:06:12 +0000
+++ .pc/10_change_config_paths/lib/Mail/SpamAssassin/Conf.pm	1970-01-01 00:00:00 +0000
@@ -1,4035 +0,0 @@
-# <@LICENSE>
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements.  See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to you under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License.  You may obtain a copy of the License at:
-# 
-#     http://www.apache.org/licenses/LICENSE-2.0
-# 
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-# </@LICENSE>
-
-=head1 NAME
-
-Mail::SpamAssassin::Conf - SpamAssassin configuration file
-
-=head1 SYNOPSIS
-
-  # a comment
-
-  rewrite_header Subject          *****SPAM*****
-
-  full PARA_A_2_C_OF_1618         /Paragraph .a.{0,10}2.{0,10}C. of S. 1618/i
-  describe PARA_A_2_C_OF_1618     Claims compliance with senate bill 1618
-
-  header FROM_HAS_MIXED_NUMS      From =~ /\d+[a-z]+\d+\S*@/i
-  describe FROM_HAS_MIXED_NUMS    From: contains numbers mixed in with letters
-
-  score A_HREF_TO_REMOVE          2.0
-
-  lang es describe FROM_FORGED_HOTMAIL Forzado From: simula ser de hotmail.com
-
-  lang pt_BR report O programa detetor de Spam ZOE [...]
-
-=head1 DESCRIPTION
-
-SpamAssassin is configured using traditional UNIX-style configuration files,
-loaded from the C</usr/share/spamassassin> and C</etc/mail/spamassassin>
-directories.
-
-The following web page lists the most important configuration settings
-used to configure SpamAssassin; novices are encouraged to read it first:
-
-  http://wiki.apache.org/spamassassin/ImportantInitialConfigItems
-
-=head1 FILE FORMAT
-
-The C<#> character starts a comment, which continues until end of line.
-B<NOTE:> if the C<#> character is to be used as part of a rule or
-configuration option, it must be escaped with a backslash.  i.e.: C<\#>
-
-Whitespace in the files is not significant, but please note that starting a
-line with whitespace is deprecated, as we reserve its use for multi-line rule
-definitions, at some point in the future.
-
-Currently, each rule or configuration setting must fit on one-line; multi-line
-settings are not supported yet.
-
-File and directory paths can use C<~> to refer to the user's home
-directory, but no other shell-style path extensions such as globing or
-C<~user/> are supported.
-
-Where appropriate below, default values are listed in parentheses.
-
-=head1 USER PREFERENCES
-
-The following options can be used in both site-wide (C<local.cf>) and
-user-specific (C<user_prefs>) configuration files to customize how
-SpamAssassin handles incoming email messages.
-
-=cut
-
-package Mail::SpamAssassin::Conf;
-
-use strict;
-use warnings;
-use bytes;
-use re 'taint';
-
-use Mail::SpamAssassin::Util;
-use Mail::SpamAssassin::NetSet;
-use Mail::SpamAssassin::Constants qw(:sa);
-use Mail::SpamAssassin::Conf::Parser;
-use Mail::SpamAssassin::Logger;
-use Mail::SpamAssassin::Util::TieOneStringHash;
-use Mail::SpamAssassin::Util qw(untaint_var);
-use File::Spec;
-
-use vars qw{
-  @ISA $VERSION
-  $CONF_TYPE_STRING $CONF_TYPE_BOOL
-  $CONF_TYPE_NUMERIC $CONF_TYPE_HASH_KEY_VALUE
-  $CONF_TYPE_ADDRLIST $CONF_TYPE_TEMPLATE
-  $CONF_TYPE_STRINGLIST $CONF_TYPE_IPADDRLIST
-  $CONF_TYPE_NOARGS
-  $INVALID_VALUE $MISSING_REQUIRED_VALUE
-  @MIGRATED_SETTINGS
-  $COLLECT_REGRESSION_TESTS
-
-$TYPE_HEAD_TESTS $TYPE_HEAD_EVALS
-$TYPE_BODY_TESTS $TYPE_BODY_EVALS $TYPE_FULL_TESTS $TYPE_FULL_EVALS
-$TYPE_RAWBODY_TESTS $TYPE_RAWBODY_EVALS $TYPE_URI_TESTS $TYPE_URI_EVALS
-$TYPE_META_TESTS $TYPE_RBL_EVALS $TYPE_EMPTY_TESTS
-};
-
-@ISA = qw();
-
-# odd => eval test.  Not constants so they can be shared with Parser
-# TODO: move to Constants.pm?
-$TYPE_HEAD_TESTS    = 0x0008;
-$TYPE_HEAD_EVALS    = 0x0009;
-$TYPE_BODY_TESTS    = 0x000a;
-$TYPE_BODY_EVALS    = 0x000b;
-$TYPE_FULL_TESTS    = 0x000c;
-$TYPE_FULL_EVALS    = 0x000d;
-$TYPE_RAWBODY_TESTS = 0x000e;
-$TYPE_RAWBODY_EVALS = 0x000f;
-$TYPE_URI_TESTS     = 0x0010;
-$TYPE_URI_EVALS     = 0x0011;
-$TYPE_META_TESTS    = 0x0012;
-$TYPE_RBL_EVALS     = 0x0013;
-$TYPE_EMPTY_TESTS   = 0x0014;
-
-my @rule_types = ("body_tests", "uri_tests", "uri_evals",
-                  "head_tests", "head_evals", "body_evals", "full_tests",
-                  "full_evals", "rawbody_tests", "rawbody_evals",
-		  "rbl_evals", "meta_tests");
-
-$VERSION = 'bogus';     # avoid CPAN.pm picking up version strings later
-
-# these are variables instead of constants so that other classes can
-# access them; if they're constants, they'd have to go in Constants.pm
-# TODO: move to Constants.pm?
-$CONF_TYPE_STRING           =  1;
-$CONF_TYPE_BOOL             =  2;
-$CONF_TYPE_NUMERIC          =  3;
-$CONF_TYPE_HASH_KEY_VALUE   =  4;
-$CONF_TYPE_ADDRLIST         =  5;
-$CONF_TYPE_TEMPLATE         =  6;
-$CONF_TYPE_NOARGS           =  7;
-$CONF_TYPE_STRINGLIST       =  8;
-$CONF_TYPE_IPADDRLIST       =  9;
-$MISSING_REQUIRED_VALUE     = -99999999999999;
-$INVALID_VALUE              = -99999999999998;
-
-# set to "1" by the test suite code, to record regression tests
-# $Mail::SpamAssassin::Conf::COLLECT_REGRESSION_TESTS = 1;
-
-# search for "sub new {" to find the start of the code
-###########################################################################
-
-sub set_default_commands {
-  my($self) = @_;
-
-  # see "perldoc Mail::SpamAssassin::Conf::Parser" for details on this fmt.
-  # push each config item like this, to avoid a POD bug; it can't just accept
-  # ( { ... }, { ... }, { ...} ) otherwise POD parsing dies.
-  my @cmds;
-
-=head2 SCORING OPTIONS
-
-=over 4
-
-=item required_score n.nn (default: 5)
-
-Set the score required before a mail is considered spam.  C<n.nn> can
-be an integer or a real number.  5.0 is the default setting, and is
-quite aggressive; it would be suitable for a single-user setup, but if
-you're an ISP installing SpamAssassin, you should probably set the
-default to be more conservative, like 8.0 or 10.0.  It is not
-recommended to automatically delete or discard messages marked as
-spam, as your users B<will> complain, but if you choose to do so, only
-delete messages with an exceptionally high score such as 15.0 or
-higher. This option was previously known as C<required_hits> and that
-name is still accepted, but is deprecated.
-
-=cut
-
-  push (@cmds, {
-    setting => 'required_score',
-    aliases => ['required_hits'],       # backwards compat
-    default => 5,
-    type => $CONF_TYPE_NUMERIC,
-  });
-
-=item score SYMBOLIC_TEST_NAME n.nn [ n.nn n.nn n.nn ]
-
-Assign scores (the number of points for a hit) to a given test.
-Scores can be positive or negative real numbers or integers.
-C<SYMBOLIC_TEST_NAME> is the symbolic name used by SpamAssassin for
-that test; for example, 'FROM_ENDS_IN_NUMS'.
-
-If only one valid score is listed, then that score is always used
-for a test.
-
-If four valid scores are listed, then the score that is used depends
-on how SpamAssassin is being used. The first score is used when
-both Bayes and network tests are disabled (score set 0). The second
-score is used when Bayes is disabled, but network tests are enabled
-(score set 1). The third score is used when Bayes is enabled and
-network tests are disabled (score set 2). The fourth score is used
-when Bayes is enabled and network tests are enabled (score set 3).
-
-Setting a rule's score to 0 will disable that rule from running.
-
-If any of the score values are surrounded by parenthesis '()', then
-all of the scores in the line are considered to be relative to the
-already set score.  ie: '(3)' means increase the score for this
-rule by 3 points in all score sets.  '(3) (0) (3) (0)' means increase
-the score for this rule by 3 in score sets 0 and 2 only.
-
-If no score is given for a test by the end of the configuration,
-a default score is assigned: a score of 1.0 is used for all tests,
-except those whose names begin with 'T_' (this is used to indicate a
-rule in testing) which receive 0.01.
-
-Note that test names which begin with '__' are indirect rules used
-to compose meta-match rules and can also act as prerequisites to
-other rules.  They are not scored or listed in the 'tests hit'
-reports, but assigning a score of 0 to an indirect rule will disable
-it from running.
-
-=cut
-
-  push (@cmds, {
-    setting => 'score',
-    is_frequent => 1,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      my($rule, @scores) = split(/\s+/, $value);
-      unless (defined $value && $value !~ /^$/ &&
-		(scalar @scores == 1 || scalar @scores == 4)) {
-	info("config: score: requires a symbolic rule name and 1 or 4 scores");
-	return $MISSING_REQUIRED_VALUE;
-      }
-
-      # Figure out if we're doing relative scores, remove the parens if we are
-      my $relative = 0;
-      foreach (@scores) {
-        local ($1);
-        if (s/^\((-?\d+(?:\.\d+)?)\)$/$1/) {
-	  $relative = 1;
-	}
-	unless (/^-?\d+(?:\.\d+)?$/) {
-	  info("config: score: the non-numeric score ($_) is not valid, " .
-	    "a numeric score is required");
-	  return $INVALID_VALUE;
-	}
-      }
-
-      if ($relative && !exists $self->{scoreset}->[0]->{$rule}) {
-        info("config: score: relative score without previous setting in " .
-	  "configuration");
-        return $INVALID_VALUE;
-      }
-
-      # If we're only passed 1 score, copy it to the other scoresets
-      if (@scores) {
-        if (@scores != 4) {
-          @scores = ( $scores[0], $scores[0], $scores[0], $scores[0] );
-        }
-
-        # Set the actual scoreset values appropriately
-        for my $index (0..3) {
-          my $score = $relative ?
-            $self->{scoreset}->[$index]->{$rule} + $scores[$index] :
-            $scores[$index];
-
-          $self->{scoreset}->[$index]->{$rule} = $score + 0.0;
-        }
-      }
-    }
-  });
-
-=back
-
-=head2 WHITELIST AND BLACKLIST OPTIONS
-
-=over 4
-
-=item whitelist_from [e-mail]
-
-Used to whitelist sender addresses which send mail that is often tagged
-(incorrectly) as spam.
-
-Use of this setting is not recommended, since it blindly trusts the message,
-which is routinely and easily forged by spammers and phish senders. The
-recommended solution is to instead use C<whitelist_auth> or other authenticated
-whitelisting methods, or C<whitelist_from_rcvd>.
-
-Whitelist and blacklist addresses are now file-glob-style patterns, so
-C<[e-mail]>, C<*@isp.com>, or C<*.domain.net> will all work.
-Specifically, C<*> and C<?> are allowed, but all other metacharacters are not.
-Regular expressions are not used for security reasons.
-
-Multiple addresses per line, separated by spaces, is OK.  Multiple
-C<whitelist_from> lines is also OK.
-
-The headers checked for whitelist addresses are as follows: if C<Resent-From>
-is set, use that; otherwise check all addresses taken from the following
-set of headers:
-
-	Envelope-Sender
-	Resent-Sender
-	X-Envelope-From
-	From
-
-In addition, the "envelope sender" data, taken from the SMTP envelope data
-where this is available, is looked up.  See C<envelope_sender_header>.
-
-e.g.
-
-  whitelist_from [e-mail] [e-mail]
-  whitelist_from *@example.com
-
-=cut
-
-  push (@cmds, {
-    setting => 'whitelist_from',
-    type => $CONF_TYPE_ADDRLIST,
-  });
-
-=item unwhitelist_from [e-mail]
-
-Used to override a default whitelist_from entry, so for example a distribution
-whitelist_from can be overridden in a local.cf file, or an individual user can
-override a whitelist_from entry in their own C<user_prefs> file.
-The specified email address has to match exactly the address previously
-used in a whitelist_from line.
-
-e.g.
-
-  unwhitelist_from [e-mail] [e-mail]
-  unwhitelist_from *@example.com
-
-=cut
-
-  push (@cmds, {
-    command => 'unwhitelist_from',
-    setting => 'whitelist_from',
-    type => $CONF_TYPE_ADDRLIST,
-    code => \&Mail::SpamAssassin::Conf::Parser::remove_addrlist_value
-  });
-
-=item whitelist_from_rcvd [e-mail] sourceforge.net
-
-Works similarly to whitelist_from, except that in addition to matching
-a sender address, a relay's rDNS name must match too for the whitelisting
-rule to fire. The first parameter is an address to whitelist, and the
-second is a string to match the relay's rDNS.
-
-This string is matched against the reverse DNS lookup used during the handover
-from the internet to your internal network's mail exchangers.  It can
-either be the full hostname, or the domain component of that hostname.  In
-other words, if the host that connected to your MX had an IP address that
-mapped to 'sendinghost.spamassassin.org', you should specify
-C<sendinghost.spamassassin.org> or just C<spamassassin.org> here.
-
-Note that this requires that C<internal_networks> be correct.  For simple cases,
-it will be, but for a complex network you may get better results by setting that
-parameter.
-
-It also requires that your mail exchangers be configured to perform DNS
-reverse lookups on the connecting host's IP address, and to record the
-result in the generated Received: header.
-
-e.g.
-
-  whitelist_from_rcvd [e-mail]  example.com
-  whitelist_from_rcvd *@axkit.org      sergeant.org
-
-=item def_whitelist_from_rcvd [e-mail] sourceforge.net
-
-Same as C<whitelist_from_rcvd>, but used for the default whitelist entries
-in the SpamAssassin distribution.  The whitelist score is lower, because
-these are often targets for spammer spoofing.
-
-=cut
-
-  push (@cmds, {
-    setting => 'whitelist_from_rcvd',
-    type => $CONF_TYPE_ADDRLIST,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      unless (defined $value && $value !~ /^$/) {
-	return $MISSING_REQUIRED_VALUE;
-      }
-      unless ($value =~ /^\S+\s+\S+$/) {
-	return $INVALID_VALUE;
-      }
-      $self->{parser}->add_to_addrlist_rcvd ('whitelist_from_rcvd',
-                                        split(/\s+/, $value));
-    }
-  });
-
-  push (@cmds, {
-    setting => 'def_whitelist_from_rcvd',
-    type => $CONF_TYPE_ADDRLIST,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      unless (defined $value && $value !~ /^$/) {
-	return $MISSING_REQUIRED_VALUE;
-      }
-      unless ($value =~ /^\S+\s+\S+$/) {
-	return $INVALID_VALUE;
-      }
-      $self->{parser}->add_to_addrlist_rcvd ('def_whitelist_from_rcvd',
-                                        split(/\s+/, $value));
-    }
-  });
-
-=item whitelist_allows_relays [e-mail]
-
-Specify addresses which are in C<whitelist_from_rcvd> that sometimes
-send through a mail relay other than the listed ones. By default mail
-with a From address that is in C<whitelist_from_rcvd> that does not match
-the relay will trigger a forgery rule. Including the address in
-C<whitelist_allows_relay> prevents that.
-
-Whitelist and blacklist addresses are now file-glob-style patterns, so
-C<[e-mail]>, C<*@isp.com>, or C<*.domain.net> will all work.
-Specifically, C<*> and C<?> are allowed, but all other metacharacters are not.
-Regular expressions are not used for security reasons.
-
-Multiple addresses per line, separated by spaces, is OK.  Multiple
-C<whitelist_allows_relays> lines is also OK.
-
-The specified email address does not have to match exactly the address
-previously used in a whitelist_from_rcvd line as it is compared to the
-address in the header.
-
-e.g.
-
-  whitelist_allows_relays [e-mail] [e-mail]
-  whitelist_allows_relays *@example.com
-
-=cut
-
-  push (@cmds, {
-    setting => 'whitelist_allows_relays',
-    type => $CONF_TYPE_ADDRLIST,
-  });
-
-=item unwhitelist_from_rcvd [e-mail]
-
-Used to override a default whitelist_from_rcvd entry, so for example a
-distribution whitelist_from_rcvd can be overridden in a local.cf file,
-or an individual user can override a whitelist_from_rcvd entry in
-their own C<user_prefs> file.
-
-The specified email address has to match exactly the address previously
-used in a whitelist_from_rcvd line.
-
-e.g.
-
-  unwhitelist_from_rcvd [e-mail] [e-mail]
-  unwhitelist_from_rcvd *@axkit.org
-
-=cut
-
-  push (@cmds, {
-    setting => 'unwhitelist_from_rcvd',
-    type => $CONF_TYPE_ADDRLIST,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      unless (defined $value && $value !~ /^$/) {
-	return $MISSING_REQUIRED_VALUE;
-      }
-      unless ($value =~ /^(?:\S+(?:\s+\S+)*)$/) {
-	return $INVALID_VALUE;
-      }
-      $self->{parser}->remove_from_addrlist_rcvd('whitelist_from_rcvd',
-                                        split (/\s+/, $value));
-      $self->{parser}->remove_from_addrlist_rcvd('def_whitelist_from_rcvd',
-                                        split (/\s+/, $value));
-    }
-  });
-
-=item blacklist_from [e-mail]
-
-Used to specify addresses which send mail that is often tagged (incorrectly) as
-non-spam, but which the user doesn't want.  Same format as C<whitelist_from>.
-
-=cut
-
-  push (@cmds, {
-    setting => 'blacklist_from',
-    type => $CONF_TYPE_ADDRLIST,
-  });
-
-=item unblacklist_from [e-mail]
-
-Used to override a default blacklist_from entry, so for example a
-distribution blacklist_from can be overridden in a local.cf file, or
-an individual user can override a blacklist_from entry in their own
-C<user_prefs> file. The specified email address has to match exactly
-the address previously used in a blacklist_from line.
-
-
-e.g.
-
-  unblacklist_from [e-mail] [e-mail]
-  unblacklist_from *@spammer.com
-
-=cut
-
-
-  push (@cmds, {
-    command => 'unblacklist_from',
-    setting => 'blacklist_from',
-    type => $CONF_TYPE_ADDRLIST,
-    code => \&Mail::SpamAssassin::Conf::Parser::remove_addrlist_value
-  });
-
-
-=item whitelist_to [e-mail]
-
-If the given address appears as a recipient in the message headers
-(Resent-To, To, Cc, obvious envelope recipient, etc.) the mail will
-be whitelisted.  Useful if you're deploying SpamAssassin system-wide,
-and don't want some users to have their mail filtered.  Same format
-as C<whitelist_from>.
-
-There are three levels of To-whitelisting, C<whitelist_to>, C<more_spam_to>
-and C<all_spam_to>.  Users in the first level may still get some spammish
-mails blocked, but users in C<all_spam_to> should never get mail blocked.
-
-The headers checked for whitelist addresses are as follows: if C<Resent-To> or
-C<Resent-Cc> are set, use those; otherwise check all addresses taken from the
-following set of headers:
-
-        To
-        Cc
-        Apparently-To
-        Delivered-To
-        Envelope-Recipients
-        Apparently-Resent-To
-        X-Envelope-To
-        Envelope-To
-        X-Delivered-To
-        X-Original-To
-        X-Rcpt-To
-        X-Real-To
-
-=item more_spam_to [e-mail]
-
-See above.
-
-=item all_spam_to [e-mail]
-
-See above.
-
-=cut
-
-  push (@cmds, {
-    setting => 'whitelist_to',
-    type => $CONF_TYPE_ADDRLIST,
-  });
-  push (@cmds, {
-    setting => 'more_spam_to',
-    type => $CONF_TYPE_ADDRLIST,
-  });
-  push (@cmds, {
-    setting => 'all_spam_to',
-    type => $CONF_TYPE_ADDRLIST,
-  });
-
-=item blacklist_to [e-mail]
-
-If the given address appears as a recipient in the message headers
-(Resent-To, To, Cc, obvious envelope recipient, etc.) the mail will
-be blacklisted.  Same format as C<blacklist_from>.
-
-=cut
-
-  push (@cmds, {
-    setting => 'blacklist_to',
-    type => $CONF_TYPE_ADDRLIST,
-  });
-
-=item whitelist_auth [e-mail]
-
-Used to specify addresses which send mail that is often tagged (incorrectly) as
-spam.  This is different from C<whitelist_from> and C<whitelist_from_rcvd> in
-that it first verifies that the message was sent by an authorized sender for
-the address, before whitelisting.
-
-Authorization is performed using one of the installed sender-authorization
-schemes: SPF (using C<Mail::SpamAssassin::Plugin::SPF>), or DKIM (using
-C<Mail::SpamAssassin::Plugin::DKIM>).  Note that those plugins must be active,
-and working, for this to operate.
-
-Using C<whitelist_auth> is roughly equivalent to specifying duplicate
-C<whitelist_from_spf>, C<whitelist_from_dk>, and C<whitelist_from_dkim> lines
-for each of the addresses specified.
-
-e.g.
-
-  whitelist_auth [e-mail] [e-mail]
-  whitelist_auth *@example.com
-
-=item def_whitelist_auth [e-mail]
-
-Same as C<whitelist_auth>, but used for the default whitelist entries
-in the SpamAssassin distribution.  The whitelist score is lower, because
-these are often targets for spammer spoofing.
-
-=cut
-
-  push (@cmds, {
-    setting => 'whitelist_auth',
-    type => $CONF_TYPE_ADDRLIST,
-  });
-
-  push (@cmds, {
-    setting => 'def_whitelist_auth',
-    type => $CONF_TYPE_ADDRLIST,
-  });
-
-=item unwhitelist_auth [e-mail]
-
-Used to override a C<whitelist_auth> entry. The specified email address has to
-match exactly the address previously used in a C<whitelist_auth> line.
-
-e.g.
-
-  unwhitelist_auth [e-mail] [e-mail]
-  unwhitelist_auth *@example.com
-
-=cut
-
-  push (@cmds, {
-    command => 'unwhitelist_auth',
-    setting => 'whitelist_auth',
-    type => $CONF_TYPE_ADDRLIST,
-    code => \&Mail::SpamAssassin::Conf::Parser::remove_addrlist_value
-  });
-
-=back
-
-=head2 BASIC MESSAGE TAGGING OPTIONS
-
-=over 4
-
-=item rewrite_header { subject | from | to } STRING
-
-By default, suspected spam messages will not have the C<Subject>,
-C<From> or C<To> lines tagged to indicate spam. By setting this option,
-the header will be tagged with C<STRING> to indicate that a message is
-spam. For the From or To headers, this will take the form of an RFC 2822
-comment following the address in parantheses. For the Subject header,
-this will be prepended to the original subject. Note that you should
-only use the _REQD_ and _SCORE_ tags when rewriting the Subject header
-if C<report_safe> is 0. Otherwise, you may not be able to remove
-the SpamAssassin markup via the normal methods.  More information
-about tags is explained below in the B<TEMPLATE TAGS> section.
-
-Parentheses are not permitted in STRING if rewriting the From or To headers.
-(They will be converted to square brackets.)
-
-If C<rewrite_header subject> is used, but the message being rewritten
-does not already contain a C<Subject> header, one will be created.
-
-A null value for C<STRING> will remove any existing rewrite for the specified
-header.
-
-=cut
-
-  push (@cmds, {
-    setting => 'rewrite_header',
-    type => $CONF_TYPE_HASH_KEY_VALUE,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      my($hdr, $string) = split(/\s+/, $value, 2);
-      $hdr = ucfirst(lc($hdr));
-
-      if ($hdr =~ /^$/) {
-	return $MISSING_REQUIRED_VALUE;
-      }
-      # We only deal with From, Subject, and To ...
-      elsif ($hdr =~ /^(?:From|Subject|To)$/) {
-	unless (defined $string && $string =~ /\S/) {
-	  delete $self->{rewrite_header}->{$hdr};
-	  return;
-	}
-
-	if ($hdr ne 'Subject') {
-          $string =~ tr/()/[]/;
-	}
-        $self->{rewrite_header}->{$hdr} = $string;
-        return;
-      }
-      else {
-	# if we get here, note the issue, then we'll fail through for an error.
-	info("config: rewrite_header: ignoring $hdr, not From, Subject, or To");
-	return $INVALID_VALUE;
-      }
-    }
-  });
-
-=item add_header { spam | ham | all } header_name string
-
-Customized headers can be added to the specified type of messages (spam,
-ham, or "all" to add to either).  All headers begin with C<X-Spam->
-(so a C<header_name> Foo will generate a header called X-Spam-Foo).
-header_name is restricted to the character set [A-Za-z0-9_-].
-
-The order of C<add_header> configuration options is preserved, inserted
-headers will follow this order of declarations. When combining C<add_header>
-with C<clear_headers> and C<remove_header>, keep in mind that C<add_header>
-appends a new header to the current list, after first removing any existing
-header fields of the same name. Note also that C<add_header>, C<clear_headers>
-and C<remove_header> may appear in multiple .cf files, which are interpreted
-in alphabetic order.
-
-C<string> can contain tags as explained below in the B<TEMPLATE TAGS> section.
-You can also use C<\n> and C<\t> in the header to add newlines and tabulators
-as desired.  A backslash has to be written as \\, any other escaped chars will
-be silently removed.
-
-All headers will be folded if fold_headers is set to C<1>. Note: Manually
-adding newlines via C<\n> disables any further automatic wrapping (ie:
-long header lines are possible). The lines will still be properly folded
-(marked as continuing) though.
-
-You can customize existing headers with B<add_header> (only the specified
-subset of messages will be changed).
-
-See also C<clear_headers> and C<remove_header> for removing headers.
-
-Here are some examples (these are the defaults, note that Checker-Version can
-not be changed or removed):
-
-  add_header spam Flag _YESNOCAPS_
-  add_header all Status _YESNO_, score=_SCORE_ required=_REQD_ tests=_TESTS_ autolearn=_AUTOLEARN_ version=_VERSION_
-  add_header all Level _STARS(*)_
-  add_header all Checker-Version SpamAssassin _VERSION_ (_SUBVERSION_) on _HOSTNAME_
-
-=cut
-
-  push (@cmds, {
-    setting => 'add_header',
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      local ($1,$2,$3);
-      if ($value !~ /^(ham|spam|all)\s+([A-Za-z0-9_-]+)\s+(.*?)\s*$/) {
-        return $INVALID_VALUE;
-      }
-
-      my ($type, $name, $hline) = ($1, $2, $3);
-      if ($hline =~ /^"(.*)"$/) {
-        $hline = $1;
-      }
-      my @line = split(
-                  /\\\\/,     # split at double backslashes,
-                  $hline."\n" # newline needed to make trailing backslashes work
-                );
-      foreach (@line) {
-        s/\\t/\t/g; # expand tabs
-        s/\\n/\n/g; # expand newlines
-        s/\\.//g;   # purge all other escapes
-      };
-      $hline = join("\\", @line);
-      chop($hline);  # remove dummy newline again
-      if (($type eq "ham") || ($type eq "all")) {
-        $self->{headers_ham} =
-          [ grep { lc($_->[0]) ne lc($name) } @{$self->{headers_ham}} ];
-        push(@{$self->{headers_ham}}, [$name, $hline]);
-      }
-      if (($type eq "spam") || ($type eq "all")) {
-        $self->{headers_spam} =
-          [ grep { lc($_->[0]) ne lc($name) } @{$self->{headers_spam}} ];
-        push(@{$self->{headers_spam}}, [$name, $hline]);
-      }
-    }
-  });
-
-=item remove_header { spam | ham | all } header_name
-
-Headers can be removed from the specified type of messages (spam, ham,
-or "all" to remove from either).  All headers begin with C<X-Spam->
-(so C<header_name> will be appended to C<X-Spam->).
-
-See also C<clear_headers> for removing all the headers at once.
-
-Note that B<X-Spam-Checker-Version> is not removable because the version
-information is needed by mail administrators and developers to debug
-problems.  Without at least one header, it might not even be possible to
-determine that SpamAssassin is running.
-
-=cut
-
-  push (@cmds, {
-    setting => 'remove_header',
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      local ($1,$2);
-      if ($value !~ /^(ham|spam|all)\s+([A-Za-z0-9_-]+)\s*$/) {
-        return $INVALID_VALUE;
-      }
-
-      my ($type, $name) = ($1, $2);
-      return if ( $name eq "Checker-Version" );
-
-      $name = lc($name);
-      if (($type eq "ham") || ($type eq "all")) {
-        $self->{headers_ham} =
-          [ grep { lc($_->[0]) ne $name } @{$self->{headers_ham}} ];
-      }
-      if (($type eq "spam") || ($type eq "all")) {
-        $self->{headers_spam} =
-          [ grep { lc($_->[0]) ne $name } @{$self->{headers_spam}} ];
-      }
-    }
-  });
-
-=item clear_headers
-
-Clear the list of headers to be added to messages.  You may use this
-before any B<add_header> options to prevent the default headers from being
-added to the message.
-
-C<add_header>, C<clear_headers> and C<remove_header> may appear in multiple
-.cf files, which are interpreted in alphabetic order, so C<clear_headers>
-in a later file will remove all added headers from previously interpreted
-configuration files, which may or may not be desired.
-
-Note that B<X-Spam-Checker-Version> is not removable because the version
-information is needed by mail administrators and developers to debug
-problems.  Without at least one header, it might not even be possible to
-determine that SpamAssassin is running.
-
-=cut
-
-  push (@cmds, {
-    setting => 'clear_headers',
-    type => $CONF_TYPE_NOARGS,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      unless (!defined $value || $value eq '') {
-        return $INVALID_VALUE;
-      }
-      my @h = grep { lc($_->[0]) eq "checker-version" }
-                   @{$self->{headers_ham}};
-      $self->{headers_ham}  = !@h ? [] : [ $h[0] ];
-      $self->{headers_spam} = !@h ? [] : [ $h[0] ];
-    }
-  });
-
-=item report_safe ( 0 | 1 | 2 )	(default: 1)
-
-if this option is set to 1, if an incoming message is tagged as spam,
-instead of modifying the original message, SpamAssassin will create a
-new report message and attach the original message as a message/rfc822
-MIME part (ensuring the original message is completely preserved, not
-easily opened, and easier to recover).
-
-If this option is set to 2, then original messages will be attached with
-a content type of text/plain instead of message/rfc822.  This setting
-may be required for safety reasons on certain broken mail clients that
-automatically load attachments without any action by the user.  This
-setting may also make it somewhat more difficult to extract or view the
-original message.
-
-If this option is set to 0, incoming spam is only modified by adding
-some C<X-Spam-> headers and no changes will be made to the body.  In
-addition, a header named B<X-Spam-Report> will be added to spam.  You
-can use the B<remove_header> option to remove that header after setting
-B<report_safe> to 0.
-
-See B<report_safe_copy_headers> if you want to copy headers from
-the original mail into tagged messages.
-
-=cut
-
-  push (@cmds, {
-    setting => 'report_safe',
-    default => 1,
-    type => $CONF_TYPE_NUMERIC,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      if ($value eq '') {
-        return $MISSING_REQUIRED_VALUE;
-      }
-      elsif ($value !~ /^[012]$/) {
-        return $INVALID_VALUE;
-      }
-
-      $self->{report_safe} = $value+0;
-      if (! $self->{report_safe} &&
-          ! (grep { lc($_->[0]) eq "report" } @{$self->{headers_spam}}) ) {
-        push(@{$self->{headers_spam}}, ["Report", "_REPORT_"]);
-      }
-    }
-  });
-
-=back
-
-=head2 LANGUAGE OPTIONS
-
-=over 4
-
-=item ok_locales xx [ yy zz ... ]		(default: all)
-
-This option is used to specify which locales are considered OK for
-incoming mail.  Mail using the B<character sets> that are allowed by
-this option will not be marked as possibly being spam in a foreign
-language.
-
-If you receive lots of spam in foreign languages, and never get any non-spam in
-these languages, this may help.  Note that all ISO-8859-* character sets, and
-Windows code page character sets, are always permitted by default.
-
-Set this to C<all> to allow all character sets.  This is the default.
-
-The rules C<CHARSET_FARAWAY>, C<CHARSET_FARAWAY_BODY>, and
-C<CHARSET_FARAWAY_HEADERS> are triggered based on how this is set.
-
-Examples:
-
-  ok_locales all         (allow all locales)
-  ok_locales en          (only allow English)
-  ok_locales en ja zh    (allow English, Japanese, and Chinese)
-
-Note: if there are multiple ok_locales lines, only the last one is used.
-
-Select the locales to allow from the list below:
-
-=over 4
-
-=item en	- Western character sets in general
-
-=item ja	- Japanese character sets
-
-=item ko	- Korean character sets
-
-=item ru	- Cyrillic character sets
-
-=item th	- Thai character sets
-
-=item zh	- Chinese (both simplified and traditional) character sets
-
-=back
-
-=cut
-
-  push (@cmds, {
-    setting => 'ok_locales',
-    default => 'all',
-    type => $CONF_TYPE_STRING,
-  });
-
-=item normalize_charset ( 0 | 1)        (default: 0)
-
-Whether to detect character sets and normalize message content to
-Unicode.  Requires the Encode::Detect module, HTML::Parser version
-3.46 or later, and Perl 5.8.5 or later.
-
-=cut
-
-  push (@cmds, {
-    setting => 'normalize_charset',
-    default => 0,
-    type => $CONF_TYPE_BOOL,
-    code => sub {
-	my ($self, $key, $value, $line) = @_;
-	unless (defined $value && $value !~ /^$/) {
-	    return $MISSING_REQUIRED_VALUE;
-	}
-	return undef if $value == 0;
-	return $INVALID_VALUE unless $value == 1;
-
-	unless ($] > 5.008004) {
-	    $self->{parser}->lint_warn("config: normalize_charset requires Perl 5.8.5 or later");
-	    return $INVALID_VALUE;
-	}
-	require HTML::Parser;
-	unless ($HTML::Parser::VERSION >= 3.46) {
-	    $self->{parser}->lint_warn("config: normalize_charset requires HTML::Parser 3.46 or later");
-	    return $INVALID_VALUE;
-	}
-	unless (eval 'require Encode::Detect::Detector') {
-	    $self->{parser}->lint_warn("config: normalize_charset requires Encode::Detect");
-	    return $INVALID_VALUE;
-	}
-	unless (eval 'require Encode') {
-	    $self->{parser}->lint_warn("config: normalize_charset requires Encode");
-	    return $INVALID_VALUE;
-	}
-
-	$self->{normalize_charset} = 1;
-    }
-  });
-
-
-=back
-
-=head2 NETWORK TEST OPTIONS
-
-=over 4
-
-=item trusted_networks ip.add.re.ss[/mask] ...   (default: none)
-
-What networks or hosts are 'trusted' in your setup.  B<Trusted> in this case
-means that relay hosts on these networks are considered to not be potentially
-operated by spammers, open relays, or open proxies.  A trusted host could
-conceivably relay spam, but will not originate it, and will not forge header
-data. DNS blacklist checks will never query for hosts on these networks. 
-
-See C<http://wiki.apache.org/spamassassin/TrustPath> for more information.
-
-MXes for your domain(s) and internal relays should B<also> be specified using
-the C<internal_networks> setting. When there are 'trusted' hosts that
-are not MXes or internal relays for your domain(s) they should B<only> be
-specified in C<trusted_networks>.
-
-If a C</mask> is specified, it's considered a CIDR-style 'netmask', specified
-in bits.  If it is not specified, but less than 4 octets are specified with a
-trailing dot, that's considered a mask to allow all addresses in the remaining
-octets.  If a mask is not specified, and there is not trailing dot, then just
-the single IP address specified is used, as if the mask was C</32>.
-
-If a network or host address is prefaced by a C<!> the network or host will be
-excluded (or included) in a first listed match fashion.
-
-Note: 127/8 and ::1 are always included in trusted_networks, regardless of
-your config.
-
-Examples:
-
-   trusted_networks 192.168/16            # all in 192.168.*.*
-   trusted_networks 212.17.35.15          # just that host
-   trusted_networks !10.0.1.5 10.0.1/24   # all in 10.0.1.* but not 10.0.1.5
-   trusted_networks DEAD:BEEF::/32        # all in that ipv6 prefix
-
-This operates additively, so a C<trusted_networks> line after another one
-will append new entries to the list of trusted networks.  To clear out the
-existing entries, use C<clear_trusted_networks>.
-
-If C<trusted_networks> is not set and C<internal_networks> is, the value
-of C<internal_networks> will be used for this parameter.
-
-If neither C<trusted_networks> or C<internal_networks> is set, a basic
-inference algorithm is applied.  This works as follows:
-
-=over 4
-
-=item *
-
-If the 'from' host has an IP address in a private (RFC 1918) network range,
-then it's trusted
-
-=item *
-
-If there are authentication tokens in the received header, and
-the previous host was trusted, then this host is also trusted
-
-=item *
-
-Otherwise this host, and all further hosts, are consider untrusted.
-
-=back
-
-=cut
-
-  push (@cmds, {
-    setting => 'trusted_networks',
-    type => $CONF_TYPE_IPADDRLIST,
-  });
-
-=item clear_trusted_networks
-
-Empty the list of trusted networks.
-
-=cut
-
-  push (@cmds, {
-    setting => 'clear_trusted_networks',
-    type => $CONF_TYPE_NOARGS,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      unless (!defined $value || $value eq '') {
-        return $INVALID_VALUE;
-      }
-      $self->{trusted_networks} = $self->new_netset();
-      $self->{trusted_networks_configured} = 0;
-    }
-  });
-
-=item internal_networks ip.add.re.ss[/mask] ...   (default: none)
-
-What networks or hosts are 'internal' in your setup.   B<Internal> means
-that relay hosts on these networks are considered to be MXes for your
-domain(s), or internal relays.  This uses the same format as
-C<trusted_networks>, above.
-
-This value is used when checking 'dial-up' or dynamic IP address
-blocklists, in order to detect direct-to-MX spamming.
-
-Trusted relays that accept mail directly from dial-up connections
-(i.e. are also performing a role of mail submission agents - MSA)
-should not be listed in C<internal_networks>. List them only in
-C<trusted_networks>.
-
-If C<trusted_networks> is set and C<internal_networks> is not, the value
-of C<trusted_networks> will be used for this parameter.
-
-If neither C<trusted_networks> nor C<internal_networks> is set, no addresses
-will be considered local; in other words, any relays past the machine where
-SpamAssassin is running will be considered external.
-
-Every entry in C<internal_networks> must appear in C<trusted_networks>; in
-other words, C<internal_networks> is always a subset of the trusted set.
-
-Note: 127/8 and ::1 are always included in internal_networks, regardless of
-your config.
-
-=cut
-
-  push (@cmds, {
-    setting => 'internal_networks',
-    type => $CONF_TYPE_IPADDRLIST,
-  });
-
-=item clear_internal_networks
-
-Empty the list of internal networks.
-
-=cut
-
-  push (@cmds, {
-    setting => 'clear_internal_networks',
-    type => $CONF_TYPE_NOARGS,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      unless (!defined $value || $value eq '') {
-        return $INVALID_VALUE;
-      }
-      $self->{internal_networks} = $self->new_netset();
-      $self->{internal_networks_configured} = 0;
-    }
-  });
-
-=item msa_networks ip.add.re.ss[/mask] ...   (default: none)
-
-The networks or hosts which are acting as MSAs in your setup (but not also as
-MX relays).  B<MSA> means that the relay hosts on these networks accept mail
-from your own users and authenticates them appropriately.  These relays
-will never accept mail from hosts that aren't authenticated in some way.
-Examples of authentication include, IP lists, SMTP AUTH, POP-before-SMTP, etc.
-
-All relays found in the message headers after the MSA relay will take
-on the same trusted and internal classifications as the MSA relay itself,
-as defined by your I<trusted_networks> and I<internal_networks> configuration.
-
-For example, if the MSA relay is trusted and internal so will all of the
-relays that precede it.
-
-When using msa_networks to identify an MSA it is recommended that you treat
-that MSA as both trusted and internal.  When an MSA is not included in
-msa_networks you should treat the MSA as trusted but not internal, however
-if the MSA is also acting as an MX or intermediate relay you must always
-treat it as both trusted and internal and ensure that the MSA includes
-visible auth tokens in its Received header to identify submission clients.
-
-B<Warning:> Never include an MSA that also acts as an MX (or is also an
-intermediate relay for an MX) or otherwise accepts mail from
-non-authenticated users in msa_networks.  Doing so will result in unknown
-external relays being trusted.
-
-=cut
-
-  push (@cmds, {
-    setting => 'msa_networks',
-    type => $CONF_TYPE_IPADDRLIST,
-  });
-
-=item clear_msa_networks
-
-Empty the list of msa networks.
-
-=cut
-
-  push (@cmds, {
-    setting => 'clear_msa_networks',
-    type => $CONF_TYPE_NOARGS,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      unless (!defined $value || $value eq '') {
-        return $INVALID_VALUE;
-      }
-      $self->{msa_networks} = Mail::SpamAssassin::NetSet->new(); # not new_netset
-      $self->{msa_networks_configured} = 0;
-    }
-  });
-
-=item originating_ip_headers header ...   (default: X-Yahoo-Post-IP X-Originating-IP X-Apparently-From X-SenderIP)
-
-A list of header field names from which an originating IP address can
-be obtained. For example, webmail servers may record a client IP address
-in X-Originating-IP.
-
-These IP addresses are virtually appended into the Received: chain, so they
-are used in RBL checks where appropriate.
-
-Currently the IP addresses are not added into X-Spam-Relays-* header fields,
-but they may be in the future.
-
-=cut
-
-  push (@cmds, {
-    setting => 'originating_ip_headers',
-    default => [],
-    type => $CONF_TYPE_STRINGLIST,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      unless (defined $value && $value !~ /^$/) {
-	return $MISSING_REQUIRED_VALUE;
-      }
-      foreach my $hfname (split(/\s+/, $value)) {
-        # avoid duplicates, consider header field names case-insensitive
-        push(@{$self->{originating_ip_headers}}, $hfname)
-          if !grep(lc($_) eq lc($hfname), @{$self->{originating_ip_headers}});
-      }
-    }
-  });
-
-=item clear_originating_ip_headers
-
-Empty the list of 'originating IP address' header field names.
-
-=cut
-
-  push (@cmds, {
-    setting => 'clear_originating_ip_headers',
-    type => $CONF_TYPE_NOARGS,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      unless (!defined $value || $value eq '') {
-        return $INVALID_VALUE;
-      }
-      $self->{originating_ip_headers} = [];
-    }
-  });
-
-=item always_trust_envelope_sender ( 0 | 1 )   (default: 0)
-
-Trust the envelope sender even if the message has been passed through one or
-more trusted relays.  See also C<envelope_sender_header>.
-
-=cut
-
-  push (@cmds, {
-    setting => 'always_trust_envelope_sender',
-    default => 0,
-    type => $CONF_TYPE_BOOL,
-  });
-
-=item skip_rbl_checks ( 0 | 1 )   (default: 0)
-
-Turning on the skip_rbl_checks setting will disable the DNSEval plugin,
-which implements Real-time Block List (or: Blackhole List) (RBL) lookups.
-
-By default, SpamAssassin will run RBL checks. Individual blocklists may
-be disabled selectively by setting a score of a corresponding rule to 0.
-
-See also a related configuration parameter skip_uribl_checks,
-which controls the URIDNSBL plugin (documented in the URIDNSBL man page).
-
-=cut
-
-  push (@cmds, {
-    setting => 'skip_rbl_checks',
-    default => 0,
-    type => $CONF_TYPE_BOOL,
-  });
-
-=item dns_available { yes | test[: name1 name2...] | no }   (default: test)
-
-By default, SpamAssassin will query some default hosts on the internet to
-attempt to check if DNS is working or not. The problem is that it can
-introduce some delay if your network connection is down, and in some cases it
-can wrongly guess that DNS is unavailable because the test connections failed.
-SpamAssassin includes a default set of 13 servers, among which 3 are picked
-randomly.
-
-You can however specify your own list by specifying
-
-  dns_available test: domain1.tld domain2.tld domain3.tld
-
-Please note, the DNS test queries for NS records.
-
-=cut
-
-  push (@cmds, {
-    setting => 'dns_available',
-    default => 'test',
-    type => $CONF_TYPE_STRING,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      if ($value =~ /^test(?::\s+.+)?$/) {
-        $self->{dns_available} = $value;
-      }
-      elsif ($value =~ /^(?:yes|1)$/) {
-        $self->{dns_available} = 'yes';
-      }
-      elsif ($value =~ /^(?:no|0)$/) {
-        $self->{dns_available} = 'no';
-      }
-      else {
-        return $INVALID_VALUE;
-      }
-    }
-  });
-
-=item dns_test_interval n   (default: 600 seconds)
-
-If dns_available is set to 'test' (which is the default), the dns_test_interval
-time in number of seconds will tell SpamAssassin how often to retest for working DNS.
-
-=cut
-
-  push (@cmds, {
-    setting => 'dns_test_interval',
-    default => 600,
-    type => $CONF_TYPE_NUMERIC,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      if ($value !~ /^\d+$/) { return $INVALID_VALUE; }
-      $self->{dns_test_interval} = $value;
-    }
-  });
-
-=item dns_options rotate    (default: empty)
-
-If set to 'rotate', this causes SpamAssassin to choose a DNS server at random
-from all servers listed in C</etc/resolv.conf> every 'dns_test_interval'
-seconds, effectively spreading the load over all currently available DNS
-servers when there are many spamd workers. 
-
-=cut
-
-  push (@cmds, {
-    setting => 'dns_options',
-    type => $CONF_TYPE_HASH_KEY_VALUE,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      my $allowed_opts = "rotate";
-      
-      foreach my $option (split (/\s+/, $value)) {
-        if ($allowed_opts !~ /^$option$/) { return $INVALID_VALUE; }
-        else { $self->{dns_options}->{$option} = 1; }
-      }
-    }
-  });
-
-=back
-
-=head2 LEARNING OPTIONS
-
-=over 4
-
-=item use_learner ( 0 | 1 )		(default: 1)
-
-Whether to use any machine-learning classifiers with SpamAssassin, such as the
-default 'BAYES_*' rules.  Setting this to 0 will disable use of any and all
-human-trained classifiers.
-
-=cut
-
-  push (@cmds, {
-    setting => 'use_learner',
-    default => 1,
-    type => $CONF_TYPE_BOOL,
-  });
-
-=item use_bayes ( 0 | 1 )		(default: 1)
-
-Whether to use the naive-Bayesian-style classifier built into
-SpamAssassin.  This is a master on/off switch for all Bayes-related
-operations.
-
-=cut
-
-  push (@cmds, {
-    setting => 'use_bayes',
-    default => 1,
-    type => $CONF_TYPE_BOOL,
-  });
-
-=item use_bayes_rules ( 0 | 1 )		(default: 1)
-
-Whether to use rules using the naive-Bayesian-style classifier built
-into SpamAssassin.  This allows you to disable the rules while leaving
-auto and manual learning enabled.
-
-=cut
-
-  push (@cmds, {
-    setting => 'use_bayes_rules',
-    default => 1,
-    type => $CONF_TYPE_BOOL,
-  });
-
-=item bayes_auto_learn ( 0 | 1 )      (default: 1)
-
-Whether SpamAssassin should automatically feed high-scoring mails (or
-low-scoring mails, for non-spam) into its learning systems.  The only
-learning system supported currently is a naive-Bayesian-style classifier.
-
-See the documentation for the
-C<Mail::SpamAssassin::Plugin::AutoLearnThreshold> plugin module
-for details on how Bayes auto-learning is implemented by default.
-
-=cut
-
-  push (@cmds, {
-    setting => 'bayes_auto_learn',
-    default => 1,
-    type => $CONF_TYPE_BOOL,
-  });
-
-=item bayes_ignore_header header_name
-
-If you receive mail filtered by upstream mail systems, like
-a spam-filtering ISP or mailing list, and that service adds
-new headers (as most of them do), these headers may provide
-inappropriate cues to the Bayesian classifier, allowing it
-to take a "short cut". To avoid this, list the headers using this
-setting.  Example:
-
-        bayes_ignore_header X-Upstream-Spamfilter
-        bayes_ignore_header X-Upstream-SomethingElse
-
-=cut
-
-  push (@cmds, {
-    setting => 'bayes_ignore_header',
-    default => [],
-    type => $CONF_TYPE_STRINGLIST,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      if ($value eq '') {
-        return $MISSING_REQUIRED_VALUE;
-      }
-      push (@{$self->{bayes_ignore_headers}}, split(/\s+/, $value));
-    }
-  });
-
-=item bayes_ignore_from [e-mail]
-
-Bayesian classification and autolearning will not be performed on mail
-from the listed addresses.  Program C<sa-learn> will also ignore the
-listed addresses if it is invoked using the C<--use-ignores> option.
-One or more addresses can be listed, see C<whitelist_from>.
-
-Spam messages from certain senders may contain many words that
-frequently occur in ham.  For example, one might read messages from a
-preferred bookstore but also get unwanted spam messages from other
-bookstores.  If the unwanted messages are learned as spam then any
-messages discussing books, including the preferred bookstore and
-antiquarian messages would be in danger of being marked as spam.  The
-addresses of the annoying bookstores would be listed.  (Assuming they
-were halfway legitimate and didn't send you mail through myriad
-affiliates.)
-
-Those who have pieces of spam in legitimate messages or otherwise
-receive ham messages containing potentially spammy words might fear
-that some spam messages might be in danger of being marked as ham.
-The addresses of the spam mailing lists, correspondents, etc.  would
-be listed.
-
-=cut
-
-  push (@cmds, {
-    setting => 'bayes_ignore_from',
-    type => $CONF_TYPE_ADDRLIST,
-  });
-
-=item bayes_ignore_to [e-mail]
-
-Bayesian classification and autolearning will not be performed on mail
-to the listed addresses.  See C<bayes_ignore_from> for details.
-
-=cut
-
-  push (@cmds, {
-    setting => 'bayes_ignore_to',
-    type => $CONF_TYPE_ADDRLIST,
-  });
-
-=item bayes_min_ham_num			(Default: 200)
-
-=item bayes_min_spam_num		(Default: 200)
-
-To be accurate, the Bayes system does not activate until a certain number of
-ham (non-spam) and spam have been learned.  The default is 200 of each ham and
-spam, but you can tune these up or down with these two settings.
-
-=cut
-
-  push (@cmds, {
-    setting => 'bayes_min_ham_num',
-    default => 200,
-    type => $CONF_TYPE_NUMERIC,
-  });
-  push (@cmds, {
-    setting => 'bayes_min_spam_num',
-    default => 200,
-    type => $CONF_TYPE_NUMERIC,
-  });
-
-=item bayes_learn_during_report         (Default: 1)
-
-The Bayes system will, by default, learn any reported messages
-(C<spamassassin -r>) as spam.  If you do not want this to happen, set
-this option to 0.
-
-=cut
-
-  push (@cmds, {
-    setting => 'bayes_learn_during_report',
-    default => 1,
-    type => $CONF_TYPE_BOOL,
-  });
-
-=item bayes_sql_override_username
-
-Used by BayesStore::SQL storage implementation.
-
-If this options is set the BayesStore::SQL module will override the set
-username with the value given.  This could be useful for implementing global or
-group bayes databases.
-
-=cut
-
-  push (@cmds, {
-    setting => 'bayes_sql_override_username',
-    default => '',
-    type => $CONF_TYPE_STRING,
-  });
-
-=item bayes_use_hapaxes		(default: 1)
-
-Should the Bayesian classifier use hapaxes (words/tokens that occur only
-once) when classifying?  This produces significantly better hit-rates, but
-increases database size by about a factor of 8 to 10.
-
-=cut
-
-  push (@cmds, {
-    setting => 'bayes_use_hapaxes',
-    default => 1,
-    type => $CONF_TYPE_BOOL,
-  });
-
-=item bayes_journal_max_size		(default: 102400)
-
-SpamAssassin will opportunistically sync the journal and the database.
-It will do so once a day, but will sync more often if the journal file
-size goes above this setting, in bytes.  If set to 0, opportunistic
-syncing will not occur.
-
-=cut
-
-  push (@cmds, {
-    setting => 'bayes_journal_max_size',
-    default => 102400,
-    type => $CONF_TYPE_NUMERIC,
-  });
-
-=item bayes_expiry_max_db_size		(default: 150000)
-
-What should be the maximum size of the Bayes tokens database?  When expiry
-occurs, the Bayes system will keep either 75% of the maximum value, or
-100,000 tokens, whichever has a larger value.  150,000 tokens is roughly
-equivalent to a 8Mb database file.
-
-=cut
-
-  push (@cmds, {
-    setting => 'bayes_expiry_max_db_size',
-    default => 150000,
-    type => $CONF_TYPE_NUMERIC,
-  });
-
-=item bayes_auto_expire       		(default: 1)
-
-If enabled, the Bayes system will try to automatically expire old tokens
-from the database.  Auto-expiry occurs when the number of tokens in the
-database surpasses the bayes_expiry_max_db_size value.
-
-=cut
-
-  push (@cmds, {
-    setting => 'bayes_auto_expire',
-    default => 1,
-    type => $CONF_TYPE_BOOL,
-  });
-
-=item bayes_learn_to_journal  	(default: 0)
-
-If this option is set, whenever SpamAssassin does Bayes learning, it
-will put the information into the journal instead of directly into the
-database.  This lowers contention for locking the database to execute
-an update, but will also cause more access to the journal and cause a
-delay before the updates are actually committed to the Bayes database.
-
-=cut
-
-  push (@cmds, {
-    setting => 'bayes_learn_to_journal',
-    default => 0,
-    type => $CONF_TYPE_BOOL,
-  });
-
-=back
-
-=head2 MISCELLANEOUS OPTIONS
-
-=over 4
-
-=item time_limit n   (default: 300)
-
-Specifies a limit on elapsed time in seconds that SpamAssassin is allowed
-to spend before providing a result. The value may be fractional and must
-not be negative, zero is interpreted as unlimited. The default is 300
-seconds for consistency with the spamd default setting of --timeout-child .
-
-This is a best-effort advisory setting, processing will not be abruptly
-aborted at an arbitrary point in processing when the time limit is exceeded,
-but only on reaching one of locations in the program flow equipped with a
-time test. Currently equipped with the test are the main checking loop,
-asynchronous DNS lookups, plugins which are calling external programs.
-Rule evaluation is guarded by starting a timer (alarm) on each set of
-compiled rules.
-
-When a message is passed to Mail::SpamAssassin::parse, a deadline time
-is established as a sum of current time and the C<time_limit> setting.
-
-This deadline may also be specified by a caller through an option
-'master_deadline' in $suppl_attrib on a call to parse(), possibly providing
-a more accurate deadline taking into account past and expected future
-processing of a message in a mail filtering setup. If both the config
-option as well as a 'master_deadline' option in a call are provided,
-the shorter time limit of the two is used (since version 3.3.2).
-Note that spamd (and possibly third-party callers of SpamAssassin) will
-supply the 'master_deadline' option in a call based on its --timeout-child
-option (or equivalent), unlike the command line C<spamassassin>, which has
-no such command line option.
-
-When a time limit is exceeded, most of the remaining tests will be skipped,
-as well as auto-learning. Whatever tests fired so far will determine the
-final score. The behaviour is similar to short-circuiting with attribute 'on',
-as implemented by a Shortcircuit plugin. A synthetic hit on a rule named
-TIME_LIMIT_EXCEEDED with a near-zero default score is generated, so that
-the report will reflect the event. A score for TIME_LIMIT_EXCEEDED may
-be provided explicitly in a configuration file, for example to achieve
-whitelisting or blacklisting effect for messages with long processing times.
-
-The C<time_limit> option is a useful protection against excessive processing
-time on certain degenerate or unusually long or complex mail messages, as well
-as against some DoS attacks. It is also needed in time-critical pre-queue
-filtering setups (e.g. milter, proxy, integration with MTA), where message
-processing must finish before a SMTP client times out.  RFC 5321 prescribes
-in section 4.5.3.2.6 the 'DATA Termination' time limit of 10 minutes,
-although it is not unusual to see some SMTP clients abort sooner on waiting
-for a response. A sensible C<time_limit> for a pre-queue filtering setup is
-maybe 50 seconds, assuming that clients are willing to wait at least a minute.
-
-=cut
-
-  push (@cmds, {
-    setting => 'time_limit',
-    default => 300,
-    type => $CONF_TYPE_NUMERIC,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      if ($value !~ /^\d+(?:\.\d*)?$/) { return $INVALID_VALUE }
-      $value = 0+$value;
-      if ($value < 0) { return $INVALID_VALUE }
-      $self->{time_limit} = $value;
-    }
-  });
-
-=item lock_method type
-
-Select the file-locking method used to protect database files on-disk. By
-default, SpamAssassin uses an NFS-safe locking method on UNIX; however, if you
-are sure that the database files you'll be using for Bayes and AWL storage will
-never be accessed over NFS, a non-NFS-safe locking system can be selected.
-
-This will be quite a bit faster, but may risk file corruption if the files are
-ever accessed by multiple clients at once, and one or more of them is accessing
-them through an NFS filesystem.
-
-Note that different platforms require different locking systems.
-
-The supported locking systems for C<type> are as follows:
-
-=over 4
-
-=item I<nfssafe> - an NFS-safe locking system
-
-=item I<flock> - simple UNIX C<flock()> locking
-
-=item I<win32> - Win32 locking using C<sysopen (..., O_CREAT|O_EXCL)>.
-
-=back
-
-nfssafe and flock are only available on UNIX, and win32 is only available
-on Windows.  By default, SpamAssassin will choose either nfssafe or
-win32 depending on the platform in use.
-
-=cut
-
-  push (@cmds, {
-    setting => 'lock_method',
-    default => '',
-    type => $CONF_TYPE_STRING,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      if ($value !~ /^(nfssafe|flock|win32)$/) {
-        return $INVALID_VALUE;
-      }
-      
-      $self->{lock_method} = $value;
-      # recreate the locker
-      $self->{main}->create_locker();
-    }
-  });
-
-=item fold_headers ( 0 | 1 )        (default: 1)
-
-By default, headers added by SpamAssassin will be whitespace folded.
-In other words, they will be broken up into multiple lines instead of
-one very long one and each continuation line will have a tabulator
-prepended to mark it as a continuation of the preceding one.
-
-The automatic wrapping can be disabled here.  Note that this can generate very
-long lines.  RFC 2822 required that header lines do not exceed 998 characters
-(not counting the final CRLF).
-
-=cut
-
-  push (@cmds, {
-    setting => 'fold_headers',
-    default => 1,
-    type => $CONF_TYPE_BOOL,
-  });
-
-=item report_safe_copy_headers header_name ...
-
-If using C<report_safe>, a few of the headers from the original message
-are copied into the wrapper header (From, To, Cc, Subject, Date, etc.)
-If you want to have other headers copied as well, you can add them
-using this option.  You can specify multiple headers on the same line,
-separated by spaces, or you can just use multiple lines.
-
-=cut
-
-  push (@cmds, {
-    setting => 'report_safe_copy_headers',
-    default => [],
-    type => $CONF_TYPE_STRINGLIST,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      if ($value eq '') {
-        return $MISSING_REQUIRED_VALUE;
-      }
-      push(@{$self->{report_safe_copy_headers}}, split(/\s+/, $value));
-    }
-  });
-
-=item envelope_sender_header Name-Of-Header
-
-SpamAssassin will attempt to discover the address used in the 'MAIL FROM:'
-phase of the SMTP transaction that delivered this message, if this data has
-been made available by the SMTP server.  This is used in the C<EnvelopeFrom>
-pseudo-header, and for various rules such as SPF checking.
-
-By default, various MTAs will use different headers, such as the following:
-
-    X-Envelope-From
-    Envelope-Sender
-    X-Sender
-    Return-Path
-
-SpamAssassin will attempt to use these, if some heuristics (such as the header
-placement in the message, or the absence of fetchmail signatures) appear to
-indicate that they are safe to use.  However, it may choose the wrong headers
-in some mailserver configurations.  (More discussion of this can be found
-in bug 2142 and bug 4747 in the SpamAssassin BugZilla.)
-
-To avoid this heuristic failure, the C<envelope_sender_header> setting may be
-helpful.  Name the header that your MTA or MDA adds to messages containing the
-address used at the MAIL FROM step of the SMTP transaction.
-
-If the header in question contains C<E<lt>> or C<E<gt>> characters at the start
-and end of the email address in the right-hand side, as in the SMTP
-transaction, these will be stripped.
-
-If the header is not found in a message, or if it's value does not contain an
-C<@> sign, SpamAssassin will issue a warning in the logs and fall back to its
-default heuristics.
-
-(Note for MTA developers: we would prefer if the use of a single header be
-avoided in future, since that precludes 'downstream' spam scanning.
-C<http://wiki.apache.org/spamassassin/EnvelopeSenderInReceived> details a
-better proposal, storing the envelope sender at each hop in the C<Received>
-header.)
-
-example:
-
-    envelope_sender_header X-SA-Exim-Mail-From
-
-=cut
-
-  push (@cmds, {
-    setting => 'envelope_sender_header',
-    default => undef,
-    type => $CONF_TYPE_STRING,
-  });
-
-=item describe SYMBOLIC_TEST_NAME description ...
-
-Used to describe a test.  This text is shown to users in the detailed report.
-
-Note that test names which begin with '__' are reserved for meta-match
-sub-rules, and are not scored or listed in the 'tests hit' reports.
-
-Also note that by convention, rule descriptions should be limited in
-length to no more than 50 characters.
-
-=cut
-
-  push (@cmds, {
-    command => 'describe',
-    setting => 'descriptions',
-    is_frequent => 1,
-    type => $CONF_TYPE_HASH_KEY_VALUE,
-  });
-
-=item report_charset CHARSET		(default: unset)
-
-Set the MIME Content-Type charset used for the text/plain report which
-is attached to spam mail messages.
-
-=cut
-
-  push (@cmds, {
-    setting => 'report_charset',
-    default => '',
-    type => $CONF_TYPE_STRING,
-  });
-
-=item report ...some text for a report...
-
-Set the report template which is attached to spam mail messages.  See the
-C<10_default_prefs.cf> configuration file in C</usr/share/spamassassin> for an
-example.
-
-If you change this, try to keep it under 78 columns. Each C<report>
-line appends to the existing template, so use C<clear_report_template>
-to restart.
-
-Tags can be included as explained above.
-
-=cut
-
-  push (@cmds, {
-    command => 'report',
-    setting => 'report_template',
-    default => '',
-    type => $CONF_TYPE_TEMPLATE,
-  });
-
-=item clear_report_template
-
-Clear the report template.
-
-=cut
-
-  push (@cmds, {
-    command => 'clear_report_template',
-    setting => 'report_template',
-    type => $CONF_TYPE_NOARGS,
-    code => \&Mail::SpamAssassin::Conf::Parser::set_template_clear
-  });
-
-=item report_contact ...text of contact address...
-
-Set what _CONTACTADDRESS_ is replaced with in the above report text.
-By default, this is 'the administrator of that system', since the hostname
-of the system the scanner is running on is also included.
-
-=cut
-
-  push (@cmds, {
-    setting => 'report_contact',
-    default => 'the administrator of that system',
-    type => $CONF_TYPE_STRING,
-  });
-
-=item report_hostname ...hostname to use...
-
-Set what _HOSTNAME_ is replaced with in the above report text.
-By default, this is determined dynamically as whatever the host running
-SpamAssassin calls itself.
-
-=cut
-
-  push (@cmds, {
-    setting => 'report_hostname',
-    default => '',
-    type => $CONF_TYPE_STRING,
-  });
-
-=item unsafe_report ...some text for a report...
-
-Set the report template which is attached to spam mail messages which contain a
-non-text/plain part.  See the C<10_default_prefs.cf> configuration file in
-C</usr/share/spamassassin> for an example.
-
-Each C<unsafe-report> line appends to the existing template, so use
-C<clear_unsafe_report_template> to restart.
-
-Tags can be used in this template (see above for details).
-
-=cut
-
-  push (@cmds, {
-    command => 'unsafe_report',
-    setting => 'unsafe_report_template',
-    default => '',
-    type => $CONF_TYPE_TEMPLATE,
-  });
-
-=item clear_unsafe_report_template
-
-Clear the unsafe_report template.
-
-=cut
-
-  push (@cmds, {
-    command => 'clear_unsafe_report_template',
-    setting => 'unsafe_report_template',
-    type => $CONF_TYPE_NOARGS,
-    code => \&Mail::SpamAssassin::Conf::Parser::set_template_clear
-  });
-
-=back
-
-=head1 RULE DEFINITIONS AND PRIVILEGED SETTINGS
-
-These settings differ from the ones above, in that they are considered
-'privileged'.  Only users running C<spamassassin> from their procmailrc's or
-forward files, or sysadmins editing a file in C</etc/mail/spamassassin>, can
-use them.   C<spamd> users cannot use them in their C<user_prefs> files, for
-security and efficiency reasons, unless C<allow_user_rules> is enabled (and
-then, they may only add rules from below).
-
-=over 4
-
-=item allow_user_rules ( 0 | 1 )		(default: 0)
-
-This setting allows users to create rules (and only rules) in their
-C<user_prefs> files for use with C<spamd>. It defaults to off, because
-this could be a severe security hole. It may be possible for users to
-gain root level access if C<spamd> is run as root. It is NOT a good
-idea, unless you have some other way of ensuring that users' tests are
-safe. Don't use this unless you are certain you know what you are
-doing. Furthermore, this option causes spamassassin to recompile all
-the tests each time it processes a message for a user with a rule in
-his/her C<user_prefs> file, which could have a significant effect on
-server load. It is not recommended.
-
-Note that it is not currently possible to use C<allow_user_rules> to modify an
-existing system rule from a C<user_prefs> file with C<spamd>.
-
-=cut
-
-  push (@cmds, {
-    setting => 'allow_user_rules',
-    is_priv => 1,
-    default => 0,
-    type => $CONF_TYPE_BOOL,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      if ($value eq '') {
-        return $MISSING_REQUIRED_VALUE;
-      }
-      elsif ($value !~ /^[01]$/) {
-        return $INVALID_VALUE;
-      }
-
-      $self->{allow_user_rules} = $value+0;
-      dbg("config: " . ($self->{allow_user_rules} ? "allowing":"not allowing") . " user rules!");
-    }
-  });
-
-=item redirector_pattern	/pattern/modifiers
-
-A regex pattern that matches both the redirector site portion, and
-the target site portion of a URI.
-
-Note: The target URI portion must be surrounded in parentheses and
-      no other part of the pattern may create a backreference.
-
-Example: http://chkpt.zdnet.com/chkpt/whatever/spammer.domain/yo/dude
-
-  redirector_pattern	/^https?:\/\/(?:opt\.)?chkpt\.zdnet\.com\/chkpt\/\w+\/(.*)$/i
-
-=cut
-
-  push (@cmds, {
-    setting => 'redirector_pattern',
-    is_priv => 1,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      if ($value eq '') {
-	return $MISSING_REQUIRED_VALUE;
-      }
-      elsif (!$self->{parser}->is_delimited_regexp_valid("redirector_pattern", $value)) {
-	return $INVALID_VALUE;
-      }
-
-      # convert to qr// while including modifiers
-      local ($1,$2,$3);
-      $value =~ /^m?(\W)(.*)(?:\1|>|}|\)|\])(.*?)$/;
-      my $pattern = $2;
-      $pattern = "(?".$3.")".$pattern if $3;
-      $pattern = qr/$pattern/;
-
-      push @{$self->{main}->{conf}->{redirector_patterns}}, $pattern;
-      # dbg("config: adding redirector regex: " . $value);
-    }
-  });
-
-=item header SYMBOLIC_TEST_NAME header op /pattern/modifiers	[if-unset: STRING]
-
-Define a test.  C<SYMBOLIC_TEST_NAME> is a symbolic test name, such as
-'FROM_ENDS_IN_NUMS'.  C<header> is the name of a mail header field,
-such as 'Subject', 'To', 'From', etc.  Header field names are matched
-case-insensitively (conforming to RFC 5322 section 1.2.2), except for
-all-capitals metaheader fields such as ALL, MESSAGEID, ALL-TRUSTED.
-
-Appending a modifier C<:raw> to a header field name will inhibit decoding of
-quoted-printable or base-64 encoded strings, and will preserve all whitespace
-inside the header string.  The C<:raw> may also be applied to pseudo-headers
-e.g. C<ALL:raw> will return a pristine (unmodified) header section.
-
-Appending a modifier C<:addr> to a header field name will cause everything
-except the first email address to be removed from the header field.  It is
-mainly applicable to header fields 'From', 'Sender', 'To', 'Cc' along with
-their 'Resent-*' counterparts, and the 'Return-Path'.
-
-Appending a modifier C<:name> to a header field name will cause everything
-except the first display name to be removed from the header field.  It is
-mainly applicable to header fields 'From' and 'Resent-From'.
-
-It is syntactically permitted to append more than one modifier to a header
-field name, although currently most combinations achieve no additional effect,
-for example C<From:addr:raw> or C<From:raw:addr> is currently the same as
-C<From:addr> .
-
-=over 4
-
-=item example@foo
-
-=item example@foo (Foo Blah)
-
-=item example@foo, example@bar
-
-=item display: example@foo (Foo Blah), example@bar ;
-
-=item Foo Blah <example@foo>
-
-=item "Foo Blah" <example@foo>
-
-=item "'Foo Blah'" <example@foo>
-
-=back
-
-Appending C<:name> to the header name will cause everything except
-the first real name to be removed from the header.  For example,
-all of the following will result in "Foo Blah"
-
-=over 4
-
-=item example@foo (Foo Blah)
-
-=item example@foo (Foo Blah), example@bar
-
-=item display: example@foo (Foo Blah), example@bar ;
-
-=item Foo Blah <example@foo>
-
-=item "Foo Blah" <example@foo>
-
-=item "'Foo Blah'" <example@foo>
-
-=back
-
-There are several special pseudo-headers that can be specified:
-
-=over 4
-
-=item C<ALL> can be used to mean the text of all the message's headers.
-Note that all whitespace inside the headers, at line folds, is currently
-compressed into a single space (' ') character. To obtain a pristine
-(unmodified) header section, use C<ALL:raw> - the :raw modifier is documented
-above.
-
-=item C<ToCc> can be used to mean the contents of both the 'To' and 'Cc'
-headers.
-
-=item C<EnvelopeFrom> is the address used in the 'MAIL FROM:' phase of the SMTP
-transaction that delivered this message, if this data has been made available
-by the SMTP server.  See C<envelope_sender_header> for more information
-on how to set this.
-
-=item C<MESSAGEID> is a symbol meaning all Message-Id's found in the message;
-some mailing list software moves the real 'Message-Id' to 'Resent-Message-Id'
-or to 'X-Message-Id', then uses its own one in the 'Message-Id' header.
-The value returned for this symbol is the text from all 3 headers, separated
-by newlines.
-
-=item C<X-Spam-Relays-Untrusted>, C<X-Spam-Relays-Trusted>,
-C<X-Spam-Relays-Internal> and C<X-Spam-Relays-External> represent a portable,
-pre-parsed representation of the message's network path, as recorded in the
-Received headers, divided into 'trusted' vs 'untrusted' and 'internal' vs
-'external' sets.  See C<http://wiki.apache.org/spamassassin/TrustedRelays> for
-more details.
-
-=back
-
-C<op> is either C<=~> (contains regular expression) or C<!~> (does not contain
-regular expression), and C<pattern> is a valid Perl regular expression, with
-C<modifiers> as regexp modifiers in the usual style.   Note that multi-line
-rules are not supported, even if you use C<x> as a modifier.  Also note that
-the C<#> character must be escaped (C<\#>) or else it will be considered to be
-the start of a comment and not part of the regexp.
-
-If the C<[if-unset: STRING]> tag is present, then C<STRING> will
-be used if the header is not found in the mail message.
-
-Test names must not start with a number, and must contain only
-alphanumerics and underscores.  It is suggested that lower-case characters
-not be used, and names have a length of no more than 22 characters,
-as an informal convention.  Dashes are not allowed.
-
-Note that test names which begin with '__' are reserved for meta-match
-sub-rules, and are not scored or listed in the 'tests hit' reports.
-Test names which begin with 'T_' are reserved for tests which are
-undergoing QA, and these are given a very low score.
-
-If you add or modify a test, please be sure to run a sanity check afterwards
-by running C<spamassassin --lint>.  This will avoid confusing error
-messages, or other tests being skipped as a side-effect.
-
-=item header SYMBOLIC_TEST_NAME exists:name_of_header
-
-Define a header existence test.  C<name_of_header> is the name of a
-header field to test for existence.  This is just a very simple version
-of the above header tests.
-
-=item header SYMBOLIC_TEST_NAME eval:name_of_eval_method([arguments])
-
-Define a header eval test.  C<name_of_eval_method> is the name of
-a method on the C<Mail::SpamAssassin::EvalTests> object.  C<arguments>
-are optional arguments to the function call.
-
-=item header SYMBOLIC_TEST_NAME eval:check_rbl('set', 'zone' [, 'sub-test'])
-
-Check a DNSBL (a DNS blacklist or whitelist).  This will retrieve Received:
-headers from the message, extract the IP addresses, select which ones are
-'untrusted' based on the C<trusted_networks> logic, and query that DNSBL
-zone.  There's a few things to note:
-
-=over 4
-
-=item duplicated or private IPs
-
-Duplicated IPs are only queried once and reserved IPs are not queried.
-Private IPs are those listed in
-<http://www.iana.org/assignments/ipv4-address-space>,
-<http://duxcw.com/faq/network/privip.htm>,
-<http://duxcw.com/faq/network/autoip.htm>, or
-<ftp://ftp.rfc-editor.org/in-notes/rfc3330.txt> as private.
-
-=item the 'set' argument
-
-This is used as a 'zone ID'.  If you want to look up a multiple-meaning zone
-like NJABL or SORBS, you can then query the results from that zone using it;
-but all check_rbl_sub() calls must use that zone ID.
-
-Also, if more than one IP address gets a DNSBL hit for a particular rule, it
-does not affect the score because rules only trigger once per message.
-
-=item the 'zone' argument
-
-This is the root zone of the DNSBL, ending in a period.
-
-=item the 'sub-test' argument
-
-This optional argument behaves the same as the sub-test argument in
-C<check_rbl_sub()> below.
-
-=item selecting all IPs except for the originating one
-
-This is accomplished by placing '-notfirsthop' at the end of the set name.
-This is useful for querying against DNS lists which list dialup IP
-addresses; the first hop may be a dialup, but as long as there is at least
-one more hop, via their outgoing SMTP server, that's legitimate, and so
-should not gain points.  If there is only one hop, that will be queried
-anyway, as it should be relaying via its outgoing SMTP server instead of
-sending directly to your MX (mail exchange).
-
-=item selecting IPs by whether they are trusted
-
-When checking a 'nice' DNSBL (a DNS whitelist), you cannot trust the IP
-addresses in Received headers that were not added by trusted relays.  To
-test the first IP address that can be trusted, place '-firsttrusted' at the
-end of the set name.  That should test the IP address of the relay that
-connected to the most remote trusted relay.
-
-Note that this requires that SpamAssassin know which relays are trusted.  For
-simple cases, SpamAssassin can make a good estimate.  For complex cases, you
-may get better results by setting C<trusted_networks> manually.
-
-In addition, you can test all untrusted IP addresses by placing '-untrusted'
-at the end of the set name.   Important note -- this does NOT include the 
-IP address from the most recent 'untrusted line', as used in '-firsttrusted'
-above.  That's because we're talking about the trustworthiness of the
-IP address data, not the source header line, here; and in the case of 
-the most recent header (the 'firsttrusted'), that data can be trusted.
-See the Wiki page at C<http://wiki.apache.org/spamassassin/TrustedRelays>
-for more information on this.
-
-=item Selecting just the last external IP
-
-By using '-lastexternal' at the end of the set name, you can select only
-the external host that connected to your internal network, or at least
-the last external host with a public IP.
-
-=back
-
-=item header SYMBOLIC_TEST_NAME eval:check_rbl_txt('set', 'zone')
-
-Same as check_rbl(), except querying using IN TXT instead of IN A records.
-If the zone supports it, it will result in a line of text describing
-why the IP is listed, typically a hyperlink to a database entry.
-
-=item header SYMBOLIC_TEST_NAME eval:check_rbl_sub('set', 'sub-test')
-
-Create a sub-test for 'set'.  If you want to look up a multi-meaning zone
-like relays.osirusoft.com, you can then query the results from that zone
-using the zone ID from the original query.  The sub-test may either be an
-IPv4 dotted address for RBLs that return multiple A records or a
-non-negative decimal number to specify a bitmask for RBLs that return a
-single A record containing a bitmask of results, a SenderBase test
-beginning with "sb:", or (if none of the preceding options seem to fit) a
-regular expression.
-
-Note: the set name must be exactly the same for as the main query rule,
-including selections like '-notfirsthop' appearing at the end of the set
-name.
-
-=cut
-
-  push (@cmds, {
-    setting => 'header',
-    is_frequent => 1,
-    is_priv => 1,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      local ($1,$2);
-      if ($value =~ /^(\S+)\s+(?:rbl)?eval:(.*)$/) {
-        my ($name, $fn) = ($1, $2);
-
-        if ($fn =~ /^check_(?:rbl|dns)/) {
-          $self->{parser}->add_test ($name, $fn, $TYPE_RBL_EVALS);
-        }
-        else {
-          $self->{parser}->add_test ($name, $fn, $TYPE_HEAD_EVALS);
-        }
-      }
-      elsif ($value =~ /^(\S+)\s+exists:([!-9;-\176]+)$/) {
-        # RFC 5322 section 3.6.8, ftext printable US-ASCII ch not including ":"
-        $self->{parser}->add_test ($1, "defined($2)", $TYPE_HEAD_TESTS);
-        $self->{descriptions}->{$1} = "Found a $2 header";
-      }
-      else {
-	my @values = split(/\s+/, $value, 2);
-	if (@values != 2) {
-	  return $MISSING_REQUIRED_VALUE;
-	}
-        $self->{parser}->add_test (@values, $TYPE_HEAD_TESTS);
-      }
-    }
-  });
-
-=item body SYMBOLIC_TEST_NAME /pattern/modifiers
-
-Define a body pattern test.  C<pattern> is a Perl regular expression.  Note:
-as per the header tests, C<#> must be escaped (C<\#>) or else it is considered
-the beginning of a comment.
-
-The 'body' in this case is the textual parts of the message body;
-any non-text MIME parts are stripped, and the message decoded from
-Quoted-Printable or Base-64-encoded format if necessary.  The message
-Subject header is considered part of the body and becomes the first
-paragraph when running the rules.  All HTML tags and line breaks will
-be removed before matching.
-
-=item body SYMBOLIC_TEST_NAME eval:name_of_eval_method([args])
-
-Define a body eval test.  See above.
-
-=cut
-
-  push (@cmds, {
-    setting => 'body',
-    is_frequent => 1,
-    is_priv => 1,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      local ($1,$2);
-      if ($value =~ /^(\S+)\s+eval:(.*)$/) {
-        $self->{parser}->add_test ($1, $2, $TYPE_BODY_EVALS);
-      }
-      else {
-	my @values = split(/\s+/, $value, 2);
-	if (@values != 2) {
-	  return $MISSING_REQUIRED_VALUE;
-	}
-        $self->{parser}->add_test (@values, $TYPE_BODY_TESTS);
-      }
-    }
-  });
-
-=item uri SYMBOLIC_TEST_NAME /pattern/modifiers
-
-Define a uri pattern test.  C<pattern> is a Perl regular expression.  Note: as
-per the header tests, C<#> must be escaped (C<\#>) or else it is considered
-the beginning of a comment.
-
-The 'uri' in this case is a list of all the URIs in the body of the email,
-and the test will be run on each and every one of those URIs, adjusting the
-score if a match is found. Use this test instead of one of the body tests
-when you need to match a URI, as it is more accurately bound to the start/end
-points of the URI, and will also be faster.
-
-=cut
-
-# we don't do URI evals yet - maybe later
-#    if (/^uri\s+(\S+)\s+eval:(.*)$/) {
-#      $self->{parser}->add_test ($1, $2, $TYPE_URI_EVALS);
-#      next;
-#    }
-  push (@cmds, {
-    setting => 'uri',
-    is_priv => 1,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      my @values = split(/\s+/, $value, 2);
-      if (@values != 2) {
-        return $MISSING_REQUIRED_VALUE;
-      }
-      $self->{parser}->add_test (@values, $TYPE_URI_TESTS);
-    }
-  });
-
-=item rawbody SYMBOLIC_TEST_NAME /pattern/modifiers
-
-Define a raw-body pattern test.  C<pattern> is a Perl regular expression.
-Note: as per the header tests, C<#> must be escaped (C<\#>) or else it is
-considered the beginning of a comment.
-
-The 'raw body' of a message is the raw data inside all textual parts. The
-text will be decoded from base64 or quoted-printable encoding, but HTML
-tags and line breaks will still be present.  Multiline expressions will
-need to be used to match strings that are broken by line breaks.
-
-=item rawbody SYMBOLIC_TEST_NAME eval:name_of_eval_method([args])
-
-Define a raw-body eval test.  See above.
-
-=cut
-
-  push (@cmds, {
-    setting => 'rawbody',
-    is_frequent => 1,
-    is_priv => 1,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      local ($1,$2);
-      if ($value =~ /^(\S+)\s+eval:(.*)$/) {
-        $self->{parser}->add_test ($1, $2, $TYPE_RAWBODY_EVALS);
-      } else {
-	my @values = split(/\s+/, $value, 2);
-	if (@values != 2) {
-	  return $MISSING_REQUIRED_VALUE;
-	}
-        $self->{parser}->add_test (@values, $TYPE_RAWBODY_TESTS);
-      }
-    }
-  });
-
-=item full SYMBOLIC_TEST_NAME /pattern/modifiers
-
-Define a full message pattern test.  C<pattern> is a Perl regular expression.
-Note: as per the header tests, C<#> must be escaped (C<\#>) or else it is
-considered the beginning of a comment.
-
-The full message is the pristine message headers plus the pristine message
-body, including all MIME data such as images, other attachments, MIME
-boundaries, etc.
-
-=item full SYMBOLIC_TEST_NAME eval:name_of_eval_method([args])
-
-Define a full message eval test.  See above.
-
-=cut
-
-  push (@cmds, {
-    setting => 'full',
-    is_priv => 1,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      local ($1,$2);
-      if ($value =~ /^(\S+)\s+eval:(.*)$/) {
-        $self->{parser}->add_test ($1, $2, $TYPE_FULL_EVALS);
-      } else {
-	my @values = split(/\s+/, $value, 2);
-	if (@values != 2) {
-	  return $MISSING_REQUIRED_VALUE;
-	}
-        $self->{parser}->add_test (@values, $TYPE_FULL_TESTS);
-      }
-    }
-  });
-
-=item meta SYMBOLIC_TEST_NAME boolean expression
-
-Define a boolean expression test in terms of other tests that have
-been hit or not hit.  For example:
-
-meta META1        TEST1 && !(TEST2 || TEST3)
-
-Note that English language operators ("and", "or") will be treated as
-rule names, and that there is no C<XOR> operator.
-
-=item meta SYMBOLIC_TEST_NAME boolean arithmetic expression
-
-Can also define an arithmetic expression in terms of other tests,
-with an unhit test having the value "0" and a hit test having a
-nonzero value.  The value of a hit meta test is that of its arithmetic
-expression.  The value of a hit eval test is that returned by its
-method.  The value of a hit header, body, rawbody, uri, or full test
-which has the "multiple" tflag is the number of times the test hit.
-The value of any other type of hit test is "1".
-
-For example:
-
-meta META2        (3 * TEST1 - 2 * TEST2) > 0
-
-Note that Perl builtins and functions, like C<abs()>, B<can't> be
-used, and will be treated as rule names.
-
-If you want to define a meta-rule, but do not want its individual sub-rules to
-count towards the final score unless the entire meta-rule matches, give the
-sub-rules names that start with '__' (two underscores).  SpamAssassin will
-ignore these for scoring.
-
-=cut
-
-  push (@cmds, {
-    setting => 'meta',
-    is_frequent => 1,
-    is_priv => 1,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      my @values = split(/\s+/, $value, 2);
-      if (@values != 2) {
-        return $MISSING_REQUIRED_VALUE;
-      }
-      if ($values[1] =~ /\*\s*\*/) {
-	info("config: found invalid '**' or '* *' operator in meta command");
-        return $INVALID_VALUE;
-      }
-      $self->{parser}->add_test (@values, $TYPE_META_TESTS);
-    }
-  });
-
-=item reuse SYMBOLIC_TEST_NAME [ OLD_SYMBOLIC_TEST_NAME_1 ... ]
-
-Defines the name of a test that should be "reused" during the scoring
-process. If a message has an X-Spam-Status header that shows a hit for
-this rule or any of the old rule names given, a hit will be added for
-this rule when B<mass-check --reuse> is used. Examples:
-
-C<reuse SPF_PASS>
-
-C<reuse MY_NET_RULE_V2 MY_NET_RULE_V1>
-
-The actual logic for reuse tests is done by
-B<Mail::SpamAssassin::Plugin::Reuse>.
-
-=cut
-
-  push (@cmds, {
-    setting => 'reuse',
-    is_priv => 1,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      if ($value !~ /\s*(\w+)(?:\s+(?:\w+(?:\s+\w+)*))?\s*$/) {
-        return $INVALID_VALUE;
-      }
-      my $rule_name = $1;
-      # don't overwrite tests, just define them so scores, priorities work
-      if (!exists $self->{tests}->{$rule_name}) {
-        $self->{parser}->add_test($rule_name, undef, $TYPE_EMPTY_TESTS);
-      }
-    }
-  });
-
-=item tflags SYMBOLIC_TEST_NAME [ {net|nice|learn|userconf|noautolearn|multiple} ]
-
-Used to set flags on a test.  These flags are used in the
-score-determination back end system for details of the test's
-behaviour.  Please see C<bayes_auto_learn> for more information
-about tflag interaction with those systems. The following flags
-can be set:
-
-=over 4
-
-=item  net
-
-The test is a network test, and will not be run in the mass checking system
-or if B<-L> is used, therefore its score should not be modified.
-
-=item  nice
-
-The test is intended to compensate for common false positives, and should be
-assigned a negative score.
-
-=item  userconf
-
-The test requires user configuration before it can be used (like language-
-specific tests).
-
-=item  learn
-
-The test requires training before it can be used.
-
-=item noautolearn
-
-The test will explicitly be ignored when calculating the score for
-learning systems.
-
-=item multiple
-
-The test will be evaluated multiple times, for use with meta rules.
-Only affects header, body, rawbody, uri, and full tests.
-
-=back
-
-=cut
-
-  push (@cmds, {
-    setting => 'tflags',
-    is_frequent => 1,
-    is_priv => 1,
-    type => $CONF_TYPE_HASH_KEY_VALUE,
-  });
-
-=item priority SYMBOLIC_TEST_NAME n
-
-Assign a specific priority to a test.  All tests, except for DNS and Meta
-tests, are run in increasing priority value order (negative priority values
-are run before positive priority values). The default test priority is 0
-(zero).
-
-The values <-99999999999999> and <-99999999999998> have a special meaning
-internally, and should not be used.
-
-=cut
-
-  push (@cmds, {
-    setting => 'priority',
-    is_priv => 1,
-    type => $CONF_TYPE_HASH_KEY_VALUE,
-  });
-
-=back
-
-=head1 ADMINISTRATOR SETTINGS
-
-These settings differ from the ones above, in that they are considered 'more
-privileged' -- even more than the ones in the B<PRIVILEGED SETTINGS> section.
-No matter what C<allow_user_rules> is set to, these can never be set from a
-user's C<user_prefs> file when spamc/spamd is being used.  However, all
-settings can be used by local programs run directly by the user.
-
-=over 4
-
-=item version_tag string
-
-This tag is appended to the SA version in the X-Spam-Status header. You should
-include it when modify your ruleset, especially if you plan to distribute it.
-A good choice for I<string> is your last name or your initials followed by a
-number which you increase with each change.
-
-The version_tag will be lowercased, and any non-alphanumeric or period
-character will be replaced by an underscore.
-
-e.g.
-
-  version_tag myrules1    # version=2.41-myrules1
-
-=cut
-
-  push (@cmds, {
-    setting => 'version_tag',
-    is_admin => 1,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      if ($value eq '') {
-        return $MISSING_REQUIRED_VALUE;
-      }
-      my $tag = lc($value);
-      $tag =~ tr/a-z0-9./_/c;
-      foreach (@Mail::SpamAssassin::EXTRA_VERSION) {
-        if($_ eq $tag) { $tag = undef; last; }
-      }
-      push(@Mail::SpamAssassin::EXTRA_VERSION, $tag) if($tag);
-    }
-  });
-
-=item test SYMBOLIC_TEST_NAME (ok|fail) Some string to test against
-
-Define a regression testing string. You can have more than one regression test
-string per symbolic test name. Simply specify a string that you wish the test
-to match.
-
-These tests are only run as part of the test suite - they should not affect the
-general running of SpamAssassin.
-
-=cut
-
-  push (@cmds, {
-    setting => 'test',
-    is_admin => 1,
-    code => sub {
-      return unless defined $COLLECT_REGRESSION_TESTS;
-      my ($self, $key, $value, $line) = @_;
-      local ($1,$2,$3);
-      if ($value !~ /^(\S+)\s+(ok|fail)\s+(.*)$/) { return $INVALID_VALUE; }
-      $self->{parser}->add_regression_test($1, $2, $3);
-    }
-  });
-
-=item rbl_timeout t [t_min] [zone]		(default: 15 3)
-
-All DNS queries are made at the beginning of a check and we try to read
-the results at the end.  This value specifies the maximum period of time
-(in seconds) to wait for a DNS query.  If most of the DNS queries have
-succeeded for a particular message, then SpamAssassin will not wait for
-the full period to avoid wasting time on unresponsive server(s), but will
-shrink the timeout according to a percentage of queries already completed.
-As the number of queries remaining approaches 0, the timeout value will
-gradually approach a t_min value, which is an optional second parameter
-and defaults to 0.2 * t.  If t is smaller than t_min, the initial timeout
-is set to t_min.  Here is a chart of queries remaining versus the timeout
-in seconds, for the default 15 second / 3 second timeout setting:
-
-  queries left  100%  90%  80%  70%  60%  50%  40%  30%  20%  10%   0%
-  timeout        15   14.9 14.5 13.9 13.1 12.0 10.7  9.1  7.3  5.3  3
-
-For example, if 20 queries are made at the beginning of a message check
-and 16 queries have returned (leaving 20%), the remaining 4 queries should
-finish within 7.3 seconds since their query started or they will be timed out.
-Note that timed out queries are only aborted when there is nothing else left
-for SpamAssassin to do - long evaluation of other rules may grant queries
-additional time.
-
-If a parameter 'zone' is specified (it must end with a letter, which
-distinguishes it from other numeric parametrs), then the setting only
-applies to DNS queries against the specified DNS domain (host, domain or
-RBL (sub)zone).  Matching is case-insensitive, the actual domain may be a
-subdomain of the specified zone.
-
-=cut
-
-  push (@cmds, {
-    setting => 'rbl_timeout',
-    is_admin => 1,
-    default => 15,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      unless (defined $value && $value !~ /^$/) {
-	return $MISSING_REQUIRED_VALUE;
-      }
-      local ($1,$2,$3);
-      unless ($value =~ /^        ( [+-]? \d+ (?: \. \d*)? )
-                          (?: \s+ ( [+-]? \d+ (?: \. \d*)? ) )?
-                          (?: \s+ (\S* [a-zA-Z]) )? $/xs) {
-	return $INVALID_VALUE;
-      }
-      my $zone = $3;
-      if (!defined $zone) {  # a global setting
-        $self->{rbl_timeout}     = $1+0;
-        $self->{rbl_timeout_min} = $2+0  if defined $2;
-      }
-      else {  # per-zone settings
-        $zone =~ s/^\.//;  $zone =~ s/\.$//;  # strip leading and trailing dot
-        $zone = lc $zone;
-        $self->{by_zone}{$zone}{rbl_timeout}     = $1+0;
-        $self->{by_zone}{$zone}{rbl_timeout_min} = $2+0  if defined $2;
-      }
-    },
-    type => $CONF_TYPE_NUMERIC,
-  });
-
-=item util_rb_tld tld1 tld2 ...
-
-This option allows the addition of new TLDs to the RegistrarBoundaries code.
-Updates to the list usually happen when new versions of SpamAssassin are
-released, but sometimes it's necessary to add in new TLDs faster than a
-release can occur.  TLDs include things like com, net, org, etc.
-
-=cut
-
-  push (@cmds, {
-    setting => 'util_rb_tld',
-    is_admin => 1,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      unless (defined $value && $value !~ /^$/) {
-	return $MISSING_REQUIRED_VALUE;
-      }
-      unless ($value =~ /^[a-zA-Z]+(?:\s+[a-zA-Z]+)*$/) {
-	return $INVALID_VALUE;
-      }
-      foreach (split(/\s+/, $value)) {
-        $Mail::SpamAssassin::Util::RegistrarBoundaries::VALID_TLDS{lc $_} = 1;
-      }
-    }
-  });
-
-=item util_rb_2tld 2tld-1.tld 2tld-2.tld ...
-
-This option allows the addition of new 2nd-level TLDs (2TLD) to the
-RegistrarBoundaries code.  Updates to the list usually happen when new
-versions of SpamAssassin are released, but sometimes it's necessary to add in
-new 2TLDs faster than a release can occur.  2TLDs include things like co.uk,
-fed.us, etc.
-
-=cut
-
-  push (@cmds, {
-    setting => 'util_rb_2tld',
-    is_admin => 1,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      unless (defined $value && $value !~ /^$/) {
-	return $MISSING_REQUIRED_VALUE;
-      }
-      unless ($value =~ /^[^\s.]+\.[^\s.]+(?:\s+[^\s.]+\.[^\s.]+)*$/) {
-	return $INVALID_VALUE;
-      }
-      foreach (split(/\s+/, $value)) {
-        $Mail::SpamAssassin::Util::RegistrarBoundaries::TWO_LEVEL_DOMAINS{lc $_} = 1;
-      }
-    }
-  });
-
-=item util_rb_3tld 3tld1.some.tld 3tld2.other.tld ...
-
-This option allows the addition of new 3rd-level TLDs (3TLD) to the
-RegistrarBoundaries code.  Updates to the list usually happen when new
-versions of SpamAssassin are released, but sometimes it's necessary to add in
-new 3TLDs faster than a release can occur.  3TLDs include things like
-demon.co.uk, plc.co.im, etc.
-
-=cut
-
-  push (@cmds, {
-    setting => 'util_rb_3tld',
-    is_admin => 1,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      unless (defined $value && $value !~ /^$/) {
-	return $MISSING_REQUIRED_VALUE;
-      }
-      unless ($value =~ /^[^\s.]+\.[^\s.]+\.[^\s.]+(?:\s+[^\s.]+\.[^\s.]+)*$/) {
-	return $INVALID_VALUE;
-      }
-      foreach (split(/\s+/, $value)) {
-        $Mail::SpamAssassin::Util::RegistrarBoundaries::THREE_LEVEL_DOMAINS{lc $_} = 1;
-      }
-    }
-  });
-
-=item bayes_path /path/filename	(default: ~/.spamassassin/bayes)
-
-This is the directory and filename for Bayes databases.  Several databases
-will be created, with this as the base directory and filename, with C<_toks>,
-C<_seen>, etc. appended to the base.  The default setting results in files
-called C<~/.spamassassin/bayes_seen>, C<~/.spamassassin/bayes_toks>, etc.
-
-By default, each user has their own in their C<~/.spamassassin> directory with
-mode 0700/0600.  For system-wide SpamAssassin use, you may want to reduce disk
-space usage by sharing this across all users.  However, Bayes appears to be
-more effective with individual user databases.
-
-=cut
-
-  push (@cmds, {
-    setting => 'bayes_path',
-    is_admin => 1,
-    default => '__userstate__/bayes',
-    type => $CONF_TYPE_STRING,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      unless (defined $value && $value !~ /^$/) {
-	return $MISSING_REQUIRED_VALUE;
-      }
-      if (-d $value) {
-	return $INVALID_VALUE;
-      }
-     $self->{bayes_path} = $value;
-    }
-  });
-
-=item bayes_file_mode		(default: 0700)
-
-The file mode bits used for the Bayesian filtering database files.
-
-Make sure you specify this using the 'x' mode bits set, as it may also be used
-to create directories.  However, if a file is created, the resulting file will
-not have any execute bits set (the umask is set to 111). The argument is a
-string of octal digits, it is converted to a numeric value internally.
-
-=cut
-
-  push (@cmds, {
-    setting => 'bayes_file_mode',
-    is_admin => 1,
-    default => '0700',
-    type => $CONF_TYPE_NUMERIC,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      if ($value !~ /^0?\d{3}$/) { return $INVALID_VALUE }
-      $self->{bayes_file_mode} = untaint_var($value);
-    }
-  });
-
-=item bayes_store_module Name::Of::BayesStore::Module
-
-If this option is set, the module given will be used as an alternate
-to the default bayes storage mechanism.  It must conform to the
-published storage specification (see
-Mail::SpamAssassin::BayesStore). For example, set this to
-Mail::SpamAssassin::BayesStore::SQL to use the generic SQL storage
-module.
-
-=cut
-
-  push (@cmds, {
-    setting => 'bayes_store_module',
-    is_admin => 1,
-    default => '',
-    type => $CONF_TYPE_STRING,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      local ($1);
-      if ($value !~ /^([_A-Za-z0-9:]+)$/) { return $INVALID_VALUE; }
-      $self->{bayes_store_module} = $1;
-    }
-  });
-
-=item bayes_sql_dsn DBI::databasetype:databasename:hostname:port
-
-Used for BayesStore::SQL storage implementation.
-
-This option give the connect string used to connect to the SQL based Bayes storage.
-
-=cut
-
-  push (@cmds, {
-    setting => 'bayes_sql_dsn',
-    is_admin => 1,
-    default => '',
-    type => $CONF_TYPE_STRING,
-  });
-
-=item bayes_sql_username
-
-Used by BayesStore::SQL storage implementation.
-
-This option gives the username used by the above DSN.
-
-=cut
-
-  push (@cmds, {
-    setting => 'bayes_sql_username',
-    is_admin => 1,
-    default => '',
-    type => $CONF_TYPE_STRING,
-  });
-
-=item bayes_sql_password
-
-Used by BayesStore::SQL storage implementation.
-
-This option gives the password used by the above DSN.
-
-=cut
-
-  push (@cmds, {
-    setting => 'bayes_sql_password',
-    is_admin => 1,
-    default => '',
-    type => $CONF_TYPE_STRING,
-  });
-
-=item bayes_sql_username_authorized ( 0 | 1 )  (default: 0)
-
-Whether to call the services_authorized_for_username plugin hook in BayesSQL.
-If the hook does not determine that the user is allowed to use bayes or is
-invalid then then database will not be initialized.
-
-NOTE: By default the user is considered invalid until a plugin returns
-a true value.  If you enable this, but do not have a proper plugin
-loaded, all users will turn up as invalid.
-
-The username passed into the plugin can be affected by the
-bayes_sql_override_username config option.
-
-=cut
-
-  push (@cmds, {
-    setting => 'bayes_sql_username_authorized',
-    is_admin => 1,
-    default => 0,
-    type => $CONF_TYPE_BOOL,
-  });
-
-=item user_scores_dsn DBI:databasetype:databasename:hostname:port
-
-If you load user scores from an SQL database, this will set the DSN
-used to connect.  Example: C<DBI:mysql:spamassassin:localhost>
-
-If you load user scores from an LDAP directory, this will set the DSN used to
-connect. You have to write the DSN as an LDAP URL, the components being the
-host and port to connect to, the base DN for the search, the scope of the
-search (base, one or sub), the single attribute being the multivalued attribute
-used to hold the configuration data (space separated pairs of key and value,
-just as in a file) and finally the filter being the expression used to filter
-out the wanted username. Note that the filter expression is being used in a
-sprintf statement with the username as the only parameter, thus is can hold a
-single __USERNAME__ expression. This will be replaced with the username.
-
-Example: C<ldap://localhost:389/dc=koehntopp,dc=de?saconfig?uid=__USERNAME__>
-
-=cut
-
-  push (@cmds, {
-    setting => 'user_scores_dsn',
-    is_admin => 1,
-    default => '',
-    type => $CONF_TYPE_STRING,
-  });
-
-=item user_scores_sql_username username
-
-The authorized username to connect to the above DSN.
-
-=cut
-
-  push (@cmds, {
-    setting => 'user_scores_sql_username',
-    is_admin => 1,
-    default => '',
-    type => $CONF_TYPE_STRING,
-  });
-
-=item user_scores_sql_password password
-
-The password for the database username, for the above DSN.
-
-=cut
-
-  push (@cmds, {
-    setting => 'user_scores_sql_password',
-    is_admin => 1,
-    default => '',
-    type => $CONF_TYPE_STRING,
-  });
-
-=item user_scores_sql_custom_query query
-
-This option gives you the ability to create a custom SQL query to
-retrieve user scores and preferences.  In order to work correctly your
-query should return two values, the preference name and value, in that
-order.  In addition, there are several "variables" that you can use
-as part of your query, these variables will be substituted for the
-current values right before the query is run.  The current allowed
-variables are:
-
-=over 4
-
-=item _TABLE_
-
-The name of the table where user scores and preferences are stored. Currently
-hardcoded to userpref, to change this value you need to create a new custom
-query with the new table name.
-
-=item _USERNAME_
-
-The current user's username.
-
-=item _MAILBOX_
-
-The portion before the @ as derived from the current user's username.
-
-=item _DOMAIN_
-
-The portion after the @ as derived from the current user's username, this
-value may be null.
-
-=back
-
-The query must be one continuous line in order to parse correctly.
-
-Here are several example queries, please note that these are broken up
-for easy reading, in your config it should be one continuous line.
-
-=over 4
-
-=item Current default query:
-
-C<SELECT preference, value FROM _TABLE_ WHERE username = _USERNAME_ OR username = '@GLOBAL' ORDER BY username ASC>
-
-=item Use global and then domain level defaults:
-
-C<SELECT preference, value FROM _TABLE_ WHERE username = _USERNAME_ OR username = '@GLOBAL' OR username = '@~'||_DOMAIN_ ORDER BY username ASC>
-
-=item Maybe global prefs should override user prefs:
-
-C<SELECT preference, value FROM _TABLE_ WHERE username = _USERNAME_ OR username = '@GLOBAL' ORDER BY username DESC>
-
-=back
-
-=cut
-
-  push (@cmds, {
-    setting => 'user_scores_sql_custom_query',
-    is_admin => 1,
-    default => undef,
-    type => $CONF_TYPE_STRING,
-  });
-
-=item user_scores_ldap_username
-
-This is the Bind DN used to connect to the LDAP server.  It defaults
-to the empty string (""), allowing anonymous binding to work.
-
-Example: C<cn=master,dc=koehntopp,dc=de>
-
-=cut
-
-  push (@cmds, {
-    setting => 'user_scores_ldap_username',
-    is_admin => 1,
-    default => '',
-    type => $CONF_TYPE_STRING,
-  });
-
-=item user_scores_ldap_password
-
-This is the password used to connect to the LDAP server.  It defaults
-to the empty string ("").
-
-=cut
-
-  push (@cmds, {
-    setting => 'user_scores_ldap_password',
-    is_admin => 1,
-    default => '',
-    type => $CONF_TYPE_STRING,
-  });
-
-=item loadplugin PluginModuleName [/path/module.pm]
-
-Load a SpamAssassin plugin module.  The C<PluginModuleName> is the perl module
-name, used to create the plugin object itself.
-
-C</path/to/module.pm> is the file to load, containing the module's perl code;
-if it's specified as a relative path, it's considered to be relative to the
-current configuration file.  If it is omitted, the module will be loaded
-using perl's search path (the C<@INC> array).
-
-See C<Mail::SpamAssassin::Plugin> for more details on writing plugins.
-
-=cut
-
-  push (@cmds, {
-    setting => 'loadplugin',
-    is_admin => 1,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      if ($value eq '') {
-        return $MISSING_REQUIRED_VALUE;
-      }
-      my ($package, $path);
-      local ($1,$2);
-      if ($value =~ /^(\S+)\s+(\S+)$/) {
-        ($package, $path) = ($1, $2);
-      } elsif ($value =~ /^\S+$/) {
-        ($package, $path) = ($value, undef);
-      } else {
-	return $INVALID_VALUE;
-      }
-      # is blindly untainting safe?  it is no worse than before
-      $_ = untaint_var($_)  for ($package,$path);
-      $self->load_plugin ($package, $path);
-    }
-  });
-
-=item tryplugin PluginModuleName [/path/module.pm]
-
-Same as C<loadplugin>, but silently ignored if the .pm file cannot be found in
-the filesystem.
-
-=cut
-
-  push (@cmds, {
-    setting => 'tryplugin',
-    is_admin => 1,
-    code => sub {
-      my ($self, $key, $value, $line) = @_;
-      if ($value eq '') {
-        return $MISSING_REQUIRED_VALUE;
-      }
-      my ($package, $path);
-      local ($1,$2);
-      if ($value =~ /^(\S+)\s+(\S+)$/) {
-        ($package, $path) = ($1, $2);
-      } elsif ($value =~ /^\S+$/) {
-        ($package, $path) = ($value, undef);
-      } else {
-	return $INVALID_VALUE;
-      }
-      # is blindly untainting safe?  it is no worse than before
-      $_ = untaint_var($_)  for ($package,$path);
-      $self->load_plugin ($package, $path, 1);
-    }
-  });
-
-=item ignore_always_matching_regexps         (Default: 0)
-
-Ignore any rule which contains a regexp which always matches.
-Currently only catches regexps which contain '||', or which begin or
-end with a '|'.  Also ignore rules with C<some> combinatorial explosions.
-
-=cut
-
-  push (@cmds, {
-    setting  => 'ignore_always_matching_regexps',
-    is_admin => 1,
-    default  => 0,
-    type     => $CONF_TYPE_BOOL,
-  });
-
-=back
-
-=head1 PREPROCESSING OPTIONS
-
-=over 4
-
-=item include filename
-
-Include configuration lines from C<filename>.   Relative paths are considered
-relative to the current configuration file or user preferences file.
-
-=item if (boolean perl expression)
-
-Used to support conditional interpretation of the configuration
-file. Lines between this and a corresponding C<else> or C<endif> line
-will be ignored unless the expression evaluates as true
-(in the perl sense; that is, defined and non-0 and non-empty string).
-
-The conditional accepts a limited subset of perl for security -- just enough to
-perform basic arithmetic comparisons.  The following input is accepted:
-
-=over 4
-
-=item numbers, whitespace, arithmetic operations and grouping
-
-Namely these characters and ranges:
-
-  ( ) - + * / _ . , < = > ! ~ 0-9 whitespace
-
-=item version
-
-This will be replaced with the version number of the currently-running
-SpamAssassin engine.  Note: The version used is in the internal SpamAssassin
-version format which is C<x.yyyzzz>, where x is major version, y is minor
-version, and z is maintenance version.  So 3.0.0 is C<3.000000>, and 3.4.80 is
-C<3.004080>.
-
-=item plugin(Name::Of::Plugin)
-
-This is a function call that returns C<1> if the plugin named
-C<Name::Of::Plugin> is loaded, or C<undef> otherwise.
-
-=item can(Name::Of::Package::function_name)
-
-This is a function call that returns C<1> if the perl package named
-C<Name::Of::Package> includes a function called C<function_name>, or C<undef>
-otherwise.  Note that packages can be SpamAssassin plugins or built-in classes,
-there's no difference in this respect.
-
-=back
-
-If the end of a configuration file is reached while still inside a
-C<if> scope, a warning will be issued, but parsing will restart on
-the next file.
-
-For example:
-
-	if (version > 3.000000)
-	  header MY_FOO	...
-	endif
-
-	loadplugin MyPlugin plugintest.pm
-
-	if plugin (MyPlugin)
-	  header MY_PLUGIN_FOO	eval:check_for_foo()
-	  score  MY_PLUGIN_FOO	0.1
-	endif
-
-=item ifplugin PluginModuleName
-
-An alias for C<if plugin(PluginModuleName)>.
-
-=item else
-
-Used to support conditional interpretation of the configuration
-file. Lines between this and a corresponding C<endif> line,
-will be ignored unless the conditional expression evaluates as false
-(in the perl sense; that is, not defined and not 0 and non-empty string).
-
-=item require_version n.nnnnnn
-
-Indicates that the entire file, from this line on, requires a certain
-version of SpamAssassin to run.  If a different (older or newer) version
-of SpamAssassin tries to read the configuration from this file, it will
-output a warning instead, and ignore it.
-
-Note: The version used is in the internal SpamAssassin version format which is
-C<x.yyyzzz>, where x is major version, y is minor version, and z is maintenance
-version.  So 3.0.0 is C<3.000000>, and 3.4.80 is C<3.004080>.
-
-=cut
-
-  push (@cmds, {
-    setting => 'require_version',
-    type => $CONF_TYPE_STRING,
-    code => sub {
-    }
-  });
-
-=back
-
-=head1 TEMPLATE TAGS
-
-The following C<tags> can be used as placeholders in certain options.
-They will be replaced by the corresponding value when they are used.
-
-Some tags can take an argument (in parentheses). The argument is
-optional, and the default is shown below.
-
- _YESNO_           "Yes" for spam, "No" for nonspam (=ham)
- _YESNO(spam_str,ham_str)_  returns the first argument ("Yes" if missing)
-                   for spam, and the second argument ("No" if missing) for ham
- _YESNOCAPS_       "YES" for spam, "NO" for nonspam (=ham)
- _YESNOCAPS(spam_str,ham_str)_  same as _YESNO(...)_, but uppercased
- _SCORE(PAD)_      message score, if PAD is included and is either spaces or
-                   zeroes, then pad scores with that many spaces or zeroes
-		   (default, none)  ie: _SCORE(0)_ makes 2.4 become 02.4,
-		   _SCORE(00)_ is 002.4.  12.3 would be 12.3 and 012.3
-		   respectively.
- _REQD_            message threshold
- _VERSION_         version (eg. 3.0.0 or 3.1.0-r26142-foo1)
- _SUBVERSION_      sub-version/code revision date (eg. 2004-01-10)
- _HOSTNAME_        hostname of the machine the mail was processed on
- _REMOTEHOSTNAME_  hostname of the machine the mail was sent from, only
-                   available with spamd
- _REMOTEHOSTADDR_  ip address of the machine the mail was sent from, only
-                   available with spamd
- _BAYES_           bayes score
- _TOKENSUMMARY_    number of new, neutral, spammy, and hammy tokens found
- _BAYESTC_         number of new tokens found
- _BAYESTCLEARNED_  number of seen tokens found
- _BAYESTCSPAMMY_   number of spammy tokens found
- _BAYESTCHAMMY_    number of hammy tokens found
- _HAMMYTOKENS(N)_  the N most significant hammy tokens (default, 5)
- _SPAMMYTOKENS(N)_ the N most significant spammy tokens (default, 5)
- _DATE_            rfc-2822 date of scan
- _STARS(*)_        one "*" (use any character) for each full score point
-                   (note: limited to 50 'stars')
- _RELAYSTRUSTED_   relays used and deemed to be trusted (see the 
-                   'X-Spam-Relays-Trusted' pseudo-header)
- _RELAYSUNTRUSTED_ relays used that can not be trusted (see the 
-                   'X-Spam-Relays-Untrusted' pseudo-header)
- _RELAYSINTERNAL_  relays used and deemed to be internal (see the 
-                   'X-Spam-Relays-Internal' pseudo-header)
- _RELAYSEXTERNAL_  relays used and deemed to be external (see the 
-                   'X-Spam-Relays-External' pseudo-header)
- _LASTEXTERNALIP_  IP address of client in the external-to-internal
-                   SMTP handover
- _LASTEXTERNALRDNS_ reverse-DNS of client in the external-to-internal
-                   SMTP handover
- _LASTEXTERNALHELO_ HELO string used by client in the external-to-internal
-                   SMTP handover
- _AUTOLEARN_       autolearn status ("ham", "no", "spam", "disabled",
-                   "failed", "unavailable")
- _AUTOLEARNSCORE_  portion of message score used by autolearn
- _TESTS(,)_        tests hit separated by "," (or other separator)
- _TESTSSCORES(,)_  as above, except with scores appended (eg. AWL=-3.0,...)
- _SUBTESTS(,)_     subtests (start with "__") hit separated by ","
-                   (or other separator)
- _DCCB_            DCC's "Brand"
- _DCCR_            DCC's results
- _PYZOR_           Pyzor results
- _RBL_             full results for positive RBL queries in DNS URI format
- _LANGUAGES_       possible languages of mail
- _PREVIEW_         content preview
- _REPORT_          terse report of tests hit (for header reports)
- _SUMMARY_         summary of tests hit for standard report (for body reports)
- _CONTACTADDRESS_  contents of the 'report_contact' setting
- _HEADER(NAME)_    includes the value of a message header.  value is the same
-                   as is found for header rules (see elsewhere in this doc)
- _TIMING_          timing breakdown report
- _ADDEDHEADERHAM_  resulting header fields as requested by add_header for spam
- _ADDEDHEADERSPAM_ resulting header fields as requested by add_header for ham
- _ADDEDHEADER_     same as ADDEDHEADERHAM for ham or ADDEDHEADERSPAM for spam
-
-If a tag reference uses the name of a tag which is not in this list or defined
-by a loaded plugin, the reference will be left intact and not replaced by any
-value.
-
-The C<HAMMYTOKENS> and C<SPAMMYTOKENS> tags have an optional second argument
-which specifies a format.  See the B<HAMMYTOKENS/SPAMMYTOKENS TAG FORMAT>
-section, below, for details.
-
-=head2 HAMMYTOKENS/SPAMMYTOKENS TAG FORMAT
-
-The C<HAMMYTOKENS> and C<SPAMMYTOKENS> tags have an optional second argument
-which specifies a format: C<_SPAMMYTOKENS(N,FMT)_>, C<_HAMMYTOKENS(N,FMT)_>
-The following formats are available:
-
-=over 4
-
-=item short
-
-Only the tokens themselves are listed.
-I<For example, preference file entry:>
-
-C<add_header all Spammy _SPAMMYTOKENS(2,short)_>
-
-I<Results in message header:>
-
-C<X-Spam-Spammy: remove.php, UD:jpg>
-
-Indicating that the top two spammy tokens found are C<remove.php>
-and C<UD:jpg>.  (The token itself follows the last colon, the
-text before the colon indicates something about the token.
-C<UD> means the token looks like it might be part of a domain name.)
-
-=item compact
-
-The token probability, an abbreviated declassification distance (see
-example), and the token are listed.
-I<For example, preference file entry:>
-
-C<add_header all Spammy _SPAMMYTOKENS(2,compact)_>
-
-I<Results in message header:>
-
-C<0.989-6--remove.php, 0.988-+--UD:jpg>
-
-Indicating that the probabilities of the top two tokens are 0.989 and
-0.988, respectively.  The first token has a declassification distance
-of 6, meaning that if the token had appeared in at least 6 more ham
-messages it would not be considered spammy.  The C<+> for the second
-token indicates a declassification distance greater than 9.
-
-=item long
-
-Probability, declassification distance, number of times seen in a ham
-message, number of times seen in a spam message, age and the token are
-listed.
-
-I<For example, preference file entry:>
-
-C<add_header all Spammy _SPAMMYTOKENS(2,long)_>
-
-I<Results in message header:>
-
-C<X-Spam-Spammy: 0.989-6--0h-4s--4d--remove.php, 0.988-33--2h-25s--1d--UD:jpg>
-
-In addition to the information provided by the compact option,
-the long option shows that the first token appeared in zero
-ham messages and four spam messages, and that it was last
-seen four days ago.  The second token appeared in two ham messages,
-25 spam messages and was last seen one day ago.
-(Unlike the C<compact> option, the long option shows declassification
-distances that are greater than 9.)
-
-=back
-
-=cut
-
-  return \@cmds;
-}
-
-###########################################################################
-
-# settings that were once part of core, but are now in (possibly-optional)
-# bundled plugins. These will be warned about, but do not generate a fatal
-# error when "spamassassin --lint" is run like a normal syntax error would.
-
-@MIGRATED_SETTINGS = qw{
-  ok_languages
-};
-
-###########################################################################
-
-sub new {
-  my $class = shift;
-  $class = ref($class) || $class;
-  my $self = {
-    main => shift,
-    registered_commands => [],
-  }; bless ($self, $class);
-
-  $self->{parser} = Mail::SpamAssassin::Conf::Parser->new($self);
-  $self->{parser}->register_commands($self->set_default_commands());
-
-  $self->{errors} = 0;
-  $self->{plugins_loaded} = { };
-
-  $self->{tests} = { };
-  $self->{test_types} = { };