You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spamassassin.apache.org by km...@apache.org on 2015/04/29 19:04:11 UTC
svn commit: r1676792 [15/17] - in /spamassassin/site/full/3.4.x: ./ doc/
Added: spamassassin/site/full/3.4.x/doc/sa-update.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/sa-update.html?rev=1676792&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/sa-update.html (added)
+++ spamassassin/site/full/3.4.x/doc/sa-update.html Wed Apr 29 17:04:09 2015
@@ -0,0 +1,300 @@
+<?xml version="1.0" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<title>sa-update - automate SpamAssassin rule updates</title>
+<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+<link rev="made" href="mailto:root@localhost" />
+</head>
+
+<body style="background-color: white">
+
+
+<!-- INDEX BEGIN -->
+<div name="index">
+<p><a name="__index__"></a></p>
+
+<ul>
+
+ <li><a href="#name">NAME</a></li>
+ <li><a href="#synopsis">SYNOPSIS</a></li>
+ <li><a href="#description">DESCRIPTION</a></li>
+ <li><a href="#options">OPTIONS</a></li>
+ <li><a href="#exit_codes">EXIT CODES</a></li>
+ <li><a href="#see_also">SEE ALSO</a></li>
+ <li><a href="#prerequesites">PREREQUESITES</a></li>
+ <li><a href="#bugs">BUGS</a></li>
+ <li><a href="#authors">AUTHORS</a></li>
+ <li><a href="#copyright">COPYRIGHT</a></li>
+</ul>
+
+<hr name="index" />
+</div>
+<!-- INDEX END -->
+
+<p>
+</p>
+<h1><a name="name">NAME</a></h1>
+<p>sa-update - automate SpamAssassin rule updates</p>
+<p>
+</p>
+<hr />
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+<p><strong>sa-update</strong> [options]</p>
+<p>Options:</p>
+<pre>
+ --channel channel Retrieve updates from this channel
+ Use multiple times for multiple channels
+ --channelfile file Retrieve updates from the channels in the file
+ --checkonly Check for update availability, do not install
+ --install filename Install updates directly from this file. Signature
+ verification will use "file.asc" and "file.sha1"
+ --allowplugins Allow updates to load plugin code
+ --gpgkey key Trust the key id to sign releases
+ Use multiple times for multiple keys
+ --gpgkeyfile file Trust the key ids in the file to sign releases
+ --gpghomedir path Store the GPG keyring in this directory
+ --gpg and --nogpg Use (or do not use) GPG to verify updates
+ (--gpg is assumed by use of the above
+ --gpgkey and --gpgkeyfile options)
+ --import file Import GPG key(s) from file into sa-update's
+ keyring. Use multiple times for multiple files
+ --updatedir path Directory to place updates, defaults to the
+ SpamAssassin site rules directory
+ (default: /var/lib/spamassassin/3.004001)
+ --refreshmirrors Force the MIRRORED.BY file to be updated
+ -D, --debug [area=n,...] Print debugging messages
+ -v, --verbose Be verbose, like print updated channel names;
+ For more verbosity specify multiple times
+ -V, --version Print version
+ -h, --help Print usage message
+ -4 Force using the inet protocol (IPv4), not inet6
+ -6 Force using the inet6 protocol (IPv6), not inet</pre>
+<p>
+</p>
+<hr />
+<h1><a name="description">DESCRIPTION</a></h1>
+<p>sa-update automates the process of downloading and installing new rules and
+configuration, based on channels. The default channel is
+<em>updates.spamassassin.org</em>, which has updated rules since the previous
+release.</p>
+<p>Update archives are verified using SHA1 hashes and GPG signatures, by default.</p>
+<p>Note that <code>sa-update</code> will not restart <code>spamd</code> or otherwise cause
+a scanner to reload the now-updated ruleset automatically. Instead,
+<code>sa-update</code> is typically used in something like the following manner:</p>
+<pre>
+ sa-update && /etc/init.d/spamassassin reload</pre>
+<p>This works because <code>sa-update</code> only returns an exit status of <code>0</code> if
+it has successfully downloaded and installed an updated ruleset.</p>
+<p>The program sa-update uses the underlying operating system umask for the
+updated rule files it installs. You may wish to run sa-update from a script
+that sets the umask prior to calling sa-update. For example:</p>
+<pre>
+ #!/bin/sh
+ umask 022
+ sa-update</pre>
+<p>
+</p>
+<hr />
+<h1><a name="options">OPTIONS</a></h1>
+<dl>
+<dt><strong><a name="channel" class="item"><strong>--channel</strong></a></strong></dt>
+
+<dd>
+<p>sa-update can update multiple channels at the same time. By default, it will
+only access "updates.spamassassin.org", but more channels can be specified via
+this option. If there are multiple additional channels, use the option
+multiple times, once per channel. i.e.:</p>
+<pre>
+ sa-update --channel foo.example.com --channel bar.example.com</pre>
+</dd>
+<dt><strong><a name="channelfile" class="item"><strong>--channelfile</strong></a></strong></dt>
+
+<dd>
+<p>Similar to the <strong>--channel</strong> option, except specify the additional channels in a
+file instead of on the commandline. This is useful when there are a
+lot of additional channels.</p>
+</dd>
+<dt><strong><a name="checkonly" class="item"><strong>--checkonly</strong></a></strong></dt>
+
+<dd>
+<p>Only check if an update is available, don't actually download and install it.
+The exit code will be <code>0</code> or <code>1</code> as described below.</p>
+</dd>
+<dt><strong><a name="install" class="item"><strong>--install</strong></a></strong></dt>
+
+<dd>
+<p>Install updates "offline", from the named tar.gz file, instead of performing
+DNS lookups and HTTP invocations.</p>
+<p>Files named <strong>file</strong>.sha1 and <strong>file</strong>.asc will be used for the SHA-1 and GPG
+signature, respectively. The filename provided must contain a version number
+of at least 3 digits, which will be used as the channel's update version
+number.</p>
+<p>Multiple <strong>--channel</strong> switches cannot be used with <strong>--install</strong>. To install
+multiple channels from tarballs, run <code>sa-update</code> multiple times with different
+<strong>--channel</strong> and <strong>--install</strong> switches, e.g.:</p>
+<pre>
+ sa-update --channel foo.example.com --install foo-34958.tgz
+ sa-update --channel bar.example.com --install bar-938455.tgz</pre>
+</dd>
+<dt><strong><a name="allowplugins" class="item"><strong>--allowplugins</strong></a></strong></dt>
+
+<dd>
+<p>Allow downloaded updates to activate plugins. The default is not to
+activate plugins; any <code>loadplugin</code> or <code>tryplugin</code> lines will be commented
+in the downloaded update rules files.</p>
+</dd>
+<dt><strong><a name="gpg_nogpg" class="item"><strong>--gpg</strong>, <strong>--nogpg</strong></a></strong></dt>
+
+<dd>
+<p>sa-update by default will verify update archives by use of a SHA1 checksum
+and GPG signature. SHA1 hashes can verify whether or not the downloaded
+archive has been corrupted, but it does not offer any form of security
+regarding whether or not the downloaded archive is legitimate (aka:
+non-modifed by evildoers). GPG verification of the archive is used to
+solve that problem.</p>
+<p>If you wish to skip GPG verification, you can use the <strong>--nogpg</strong> option
+to disable its use. Use of the following gpgkey-related options will
+override <strong>--nogpg</strong> and keep GPG verification enabled.</p>
+<p>Note: Currently, only GPG itself is supported (ie: not PGP). v1.2 has been
+tested, although later versions ought to work as well.</p>
+</dd>
+<dt><strong><a name="gpgkey" class="item"><strong>--gpgkey</strong></a></strong></dt>
+
+<dd>
+<p>sa-update has the concept of "release trusted" GPG keys. When an archive is
+downloaded and the signature verified, sa-update requires that the signature
+be from one of these "release trusted" keys or else verification fails. This
+prevents third parties from manipulating the files on a mirror, for instance,
+and signing with their own key.</p>
+<p>By default, sa-update trusts key ids <code>24F434CE</code> and <code>5244EC45</code>, which are
+the standard SpamAssassin release key and its sub-key. Use this option to
+trust additional keys. See the <strong>--import</strong> option for how to add keys to
+sa-update's keyring. For sa-update to use a key it must be in sa-update's
+keyring and trusted.</p>
+<p>For multiple keys, use the option multiple times. i.e.:</p>
+<pre>
+ sa-update --gpgkey E580B363 --gpgkey 298BC7D0</pre>
+<p>Note: use of this option automatically enables GPG verification.</p>
+</dd>
+<dt><strong><a name="gpgkeyfile" class="item"><strong>--gpgkeyfile</strong></a></strong></dt>
+
+<dd>
+<p>Similar to the <strong>--gpgkey</strong> option, except specify the additional keys in a file
+instead of on the commandline. This is extremely useful when there are a lot
+of additional keys that you wish to trust.</p>
+</dd>
+<dt><strong><a name="gpghomedir" class="item"><strong>--gpghomedir</strong></a></strong></dt>
+
+<dd>
+<p>Specify a directory path to use as a storage area for the <code>sa-update</code> GPG
+keyring. By default, this is</p>
+<pre>
+ /etc/mail/spamassassin/sa-update-keys</pre>
+</dd>
+<dt><strong><a name="import2" class="item"><strong>--import</strong></a></strong></dt>
+
+<dd>
+<p>Use to import GPG key(s) from a file into the sa-update keyring which is
+located in the directory specified by <strong>--gpghomedir</strong>. Before using channels
+from third party sources, you should use this option to import the GPG key(s)
+used by those channels. You must still use the <strong>--gpgkey</strong> or <strong>--gpgkeyfile</strong>
+options above to get sa-update to trust imported keys.</p>
+<p>To import multiple keys, use the option multiple times. i.e.:</p>
+<pre>
+ sa-update --import channel1-GPG.KEY --import channel2-GPG.KEY</pre>
+<p>Note: use of this option automatically enables GPG verification.</p>
+</dd>
+<dt><strong><a name="refreshmirrors" class="item"><strong>--refreshmirrors</strong></a></strong></dt>
+
+<dd>
+<p>Force the list of sa-update mirrors for each channel, stored in the MIRRORED.BY
+file, to be updated. By default, the MIRRORED.BY file will be cached for up to
+7 days after each time it is downloaded.</p>
+</dd>
+<dt><strong><a name="updatedir2" class="item"><strong>--updatedir</strong></a></strong></dt>
+
+<dd>
+<p>By default, <code>sa-update</code> will use the system-wide rules update directory:</p>
+<pre>
+ /var/lib/spamassassin/3.004001</pre>
+<p>If the updates should be stored in another location, specify it here.</p>
+<p>Note that use of this option is not recommended; if you're just using sa-update
+to download updated rulesets for a scanner, and sa-update is placing updates in
+the wrong directory, you probably need to rebuild SpamAssassin with different
+<code>Makefile.PL</code> arguments, instead of overriding sa-update's runtime behaviour.</p>
+</dd>
+<dt><strong><a name="d_area_debug_area4" class="item"><strong>-D</strong> [<em>area,...</em>], <strong>--debug</strong> [<em>area,...</em>]</a></strong></dt>
+
+<dd>
+<p>Produce debugging output. If no areas are listed, all debugging information is
+printed. Diagnostic output can also be enabled for each area individually;
+<em>area</em> is the area of the code to instrument. For example, to produce
+diagnostic output on channel, gpg, and http, use:</p>
+<pre>
+ sa-update -D channel,gpg,http</pre>
+<p>For more information about which areas (also known as channels) are
+available, please see the documentation at
+<a href="http://wiki.apache.org/spamassassin/DebugChannels">http://wiki.apache.org/spamassassin/DebugChannels</a>.</p>
+</dd>
+<dt><strong><a name="h_help4" class="item"><strong>-h</strong>, <strong>--help</strong></a></strong></dt>
+
+<dd>
+<p>Print help message and exit.</p>
+</dd>
+<dt><strong><a name="v_version3" class="item"><strong>-V</strong>, <strong>--version</strong></a></strong></dt>
+
+<dd>
+<p>Print sa-update version and exit.</p>
+</dd>
+</dl>
+<p>
+</p>
+<hr />
+<h1><a name="exit_codes">EXIT CODES</a></h1>
+<p>In absence of a --checkonly option, an exit code of <code>0</code> means:
+an update was available, and was downloaded and installed successfully.
+If --checkonly was specified, an exit code of <code>0</code> means: an update was
+available.</p>
+<p>An exit code of <code>1</code> means no fresh updates were available.</p>
+<p>An exit code of <code>2</code> means that at least one update is available but that a
+lint check of the site pre files failed. The site pre files must pass a lint
+check before any updates are attempted.</p>
+<p>An exit code of <code>3</code> means that at least one update succeeded while
+other channels failed. If using sa-compile, you should proceed with it.</p>
+<p>An exit code of <code>4</code> or higher, indicates that errors occurred while
+attempting to download and extract updates, and no channels were updated.</p>
+<p>
+</p>
+<hr />
+<h1><a name="see_also">SEE ALSO</a></h1>
+<p>Mail::SpamAssassin(3)
+Mail::SpamAssassin::Conf(3)
+<code>spamassassin(1)</code>
+<code>spamd(1)</code>
+<http://wiki.apache.org/spamassassin/RuleUpdates></p>
+<p>
+</p>
+<hr />
+<h1><a name="prerequesites">PREREQUESITES</a></h1>
+<p><code>Mail::SpamAssassin</code></p>
+<p>
+</p>
+<hr />
+<h1><a name="bugs">BUGS</a></h1>
+<p>See <http://issues.apache.org/SpamAssassin/></p>
+<p>
+</p>
+<hr />
+<h1><a name="authors">AUTHORS</a></h1>
+<p>The Apache SpamAssassin(tm) Project <http://spamassassin.apache.org/></p>
+<p>
+</p>
+<hr />
+<h1><a name="copyright">COPYRIGHT</a></h1>
+<p>SpamAssassin is distributed under the Apache License, Version 2.0, as
+described in the file <code>LICENSE</code> included with the distribution.</p>
+
+</body>
+
+</html>
Added: spamassassin/site/full/3.4.x/doc/sa-update.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/sa-update.txt?rev=1676792&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/sa-update.txt (added)
+++ spamassassin/site/full/3.4.x/doc/sa-update.txt Wed Apr 29 17:04:09 2015
@@ -0,0 +1,236 @@
+NAME
+ sa-update - automate SpamAssassin rule updates
+
+SYNOPSIS
+ sa-update [options]
+
+ Options:
+
+ --channel channel Retrieve updates from this channel
+ Use multiple times for multiple channels
+ --channelfile file Retrieve updates from the channels in the file
+ --checkonly Check for update availability, do not install
+ --install filename Install updates directly from this file. Signature
+ verification will use "file.asc" and "file.sha1"
+ --allowplugins Allow updates to load plugin code
+ --gpgkey key Trust the key id to sign releases
+ Use multiple times for multiple keys
+ --gpgkeyfile file Trust the key ids in the file to sign releases
+ --gpghomedir path Store the GPG keyring in this directory
+ --gpg and --nogpg Use (or do not use) GPG to verify updates
+ (--gpg is assumed by use of the above
+ --gpgkey and --gpgkeyfile options)
+ --import file Import GPG key(s) from file into sa-update's
+ keyring. Use multiple times for multiple files
+ --updatedir path Directory to place updates, defaults to the
+ SpamAssassin site rules directory
+ (default: /var/lib/spamassassin/3.004001)
+ --refreshmirrors Force the MIRRORED.BY file to be updated
+ -D, --debug [area=n,...] Print debugging messages
+ -v, --verbose Be verbose, like print updated channel names;
+ For more verbosity specify multiple times
+ -V, --version Print version
+ -h, --help Print usage message
+ -4 Force using the inet protocol (IPv4), not inet6
+ -6 Force using the inet6 protocol (IPv6), not inet
+
+DESCRIPTION
+ sa-update automates the process of downloading and installing new rules
+ and configuration, based on channels. The default channel is
+ *updates.spamassassin.org*, which has updated rules since the previous
+ release.
+
+ Update archives are verified using SHA1 hashes and GPG signatures, by
+ default.
+
+ Note that "sa-update" will not restart "spamd" or otherwise cause a
+ scanner to reload the now-updated ruleset automatically. Instead,
+ "sa-update" is typically used in something like the following manner:
+
+ sa-update && /etc/init.d/spamassassin reload
+
+ This works because "sa-update" only returns an exit status of 0 if it
+ has successfully downloaded and installed an updated ruleset.
+
+ The program sa-update uses the underlying operating system umask for the
+ updated rule files it installs. You may wish to run sa-update from a
+ script that sets the umask prior to calling sa-update. For example:
+
+ #!/bin/sh
+ umask 022
+ sa-update
+
+OPTIONS
+ --channel
+ sa-update can update multiple channels at the same time. By default,
+ it will only access "updates.spamassassin.org", but more channels
+ can be specified via this option. If there are multiple additional
+ channels, use the option multiple times, once per channel. i.e.:
+
+ sa-update --channel foo.example.com --channel bar.example.com
+
+ --channelfile
+ Similar to the --channel option, except specify the additional
+ channels in a file instead of on the commandline. This is useful
+ when there are a lot of additional channels.
+
+ --checkonly
+ Only check if an update is available, don't actually download and
+ install it. The exit code will be 0 or 1 as described below.
+
+ --install
+ Install updates "offline", from the named tar.gz file, instead of
+ performing DNS lookups and HTTP invocations.
+
+ Files named file.sha1 and file.asc will be used for the SHA-1 and
+ GPG signature, respectively. The filename provided must contain a
+ version number of at least 3 digits, which will be used as the
+ channel's update version number.
+
+ Multiple --channel switches cannot be used with --install. To
+ install multiple channels from tarballs, run "sa-update" multiple
+ times with different --channel and --install switches, e.g.:
+
+ sa-update --channel foo.example.com --install foo-34958.tgz
+ sa-update --channel bar.example.com --install bar-938455.tgz
+
+ --allowplugins
+ Allow downloaded updates to activate plugins. The default is not to
+ activate plugins; any "loadplugin" or "tryplugin" lines will be
+ commented in the downloaded update rules files.
+
+ --gpg, --nogpg
+ sa-update by default will verify update archives by use of a SHA1
+ checksum and GPG signature. SHA1 hashes can verify whether or not
+ the downloaded archive has been corrupted, but it does not offer any
+ form of security regarding whether or not the downloaded archive is
+ legitimate (aka: non-modifed by evildoers). GPG verification of the
+ archive is used to solve that problem.
+
+ If you wish to skip GPG verification, you can use the --nogpg option
+ to disable its use. Use of the following gpgkey-related options will
+ override --nogpg and keep GPG verification enabled.
+
+ Note: Currently, only GPG itself is supported (ie: not PGP). v1.2
+ has been tested, although later versions ought to work as well.
+
+ --gpgkey
+ sa-update has the concept of "release trusted" GPG keys. When an
+ archive is downloaded and the signature verified, sa-update requires
+ that the signature be from one of these "release trusted" keys or
+ else verification fails. This prevents third parties from
+ manipulating the files on a mirror, for instance, and signing with
+ their own key.
+
+ By default, sa-update trusts key ids "24F434CE" and "5244EC45",
+ which are the standard SpamAssassin release key and its sub-key. Use
+ this option to trust additional keys. See the --import option for
+ how to add keys to sa-update's keyring. For sa-update to use a key
+ it must be in sa-update's keyring and trusted.
+
+ For multiple keys, use the option multiple times. i.e.:
+
+ sa-update --gpgkey E580B363 --gpgkey 298BC7D0
+
+ Note: use of this option automatically enables GPG verification.
+
+ --gpgkeyfile
+ Similar to the --gpgkey option, except specify the additional keys
+ in a file instead of on the commandline. This is extremely useful
+ when there are a lot of additional keys that you wish to trust.
+
+ --gpghomedir
+ Specify a directory path to use as a storage area for the
+ "sa-update" GPG keyring. By default, this is
+
+ /etc/mail/spamassassin/sa-update-keys
+
+ --import
+ Use to import GPG key(s) from a file into the sa-update keyring
+ which is located in the directory specified by --gpghomedir. Before
+ using channels from third party sources, you should use this option
+ to import the GPG key(s) used by those channels. You must still use
+ the --gpgkey or --gpgkeyfile options above to get sa-update to trust
+ imported keys.
+
+ To import multiple keys, use the option multiple times. i.e.:
+
+ sa-update --import channel1-GPG.KEY --import channel2-GPG.KEY
+
+ Note: use of this option automatically enables GPG verification.
+
+ --refreshmirrors
+ Force the list of sa-update mirrors for each channel, stored in the
+ MIRRORED.BY file, to be updated. By default, the MIRRORED.BY file
+ will be cached for up to 7 days after each time it is downloaded.
+
+ --updatedir
+ By default, "sa-update" will use the system-wide rules update
+ directory:
+
+ /var/lib/spamassassin/3.004001
+
+ If the updates should be stored in another location, specify it
+ here.
+
+ Note that use of this option is not recommended; if you're just
+ using sa-update to download updated rulesets for a scanner, and
+ sa-update is placing updates in the wrong directory, you probably
+ need to rebuild SpamAssassin with different "Makefile.PL" arguments,
+ instead of overriding sa-update's runtime behaviour.
+
+ -D [*area,...*], --debug [*area,...*]
+ Produce debugging output. If no areas are listed, all debugging
+ information is printed. Diagnostic output can also be enabled for
+ each area individually; *area* is the area of the code to
+ instrument. For example, to produce diagnostic output on channel,
+ gpg, and http, use:
+
+ sa-update -D channel,gpg,http
+
+ For more information about which areas (also known as channels) are
+ available, please see the documentation at
+ <http://wiki.apache.org/spamassassin/DebugChannels>.
+
+ -h, --help
+ Print help message and exit.
+
+ -V, --version
+ Print sa-update version and exit.
+
+EXIT CODES
+ In absence of a --checkonly option, an exit code of 0 means: an update
+ was available, and was downloaded and installed successfully. If
+ --checkonly was specified, an exit code of 0 means: an update was
+ available.
+
+ An exit code of 1 means no fresh updates were available.
+
+ An exit code of 2 means that at least one update is available but that a
+ lint check of the site pre files failed. The site pre files must pass a
+ lint check before any updates are attempted.
+
+ An exit code of 3 means that at least one update succeeded while other
+ channels failed. If using sa-compile, you should proceed with it.
+
+ An exit code of 4 or higher, indicates that errors occurred while
+ attempting to download and extract updates, and no channels were
+ updated.
+
+SEE ALSO
+ Mail::SpamAssassin(3) Mail::SpamAssassin::Conf(3) spamassassin(1)
+ spamd(1) <http://wiki.apache.org/spamassassin/RuleUpdates>
+
+PREREQUESITES
+ "Mail::SpamAssassin"
+
+BUGS
+ See <http://issues.apache.org/SpamAssassin/>
+
+AUTHORS
+ The Apache SpamAssassin(tm) Project <http://spamassassin.apache.org/>
+
+COPYRIGHT
+ SpamAssassin is distributed under the Apache License, Version 2.0, as
+ described in the file "LICENSE" included with the distribution.
+
Added: spamassassin/site/full/3.4.x/doc/spamassassin-run.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/spamassassin-run.html?rev=1676792&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/spamassassin-run.html (added)
+++ spamassassin/site/full/3.4.x/doc/spamassassin-run.html Wed Apr 29 17:04:09 2015
@@ -0,0 +1,356 @@
+<?xml version="1.0" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<title>spamassassin - simple front-end filtering script for SpamAssassin</title>
+<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+<link rev="made" href="mailto:root@localhost" />
+</head>
+
+<body style="background-color: white">
+
+
+<!-- INDEX BEGIN -->
+<div name="index">
+<p><a name="__index__"></a></p>
+
+<ul>
+
+ <li><a href="#name">NAME</a></li>
+ <li><a href="#synopsis">SYNOPSIS</a></li>
+ <li><a href="#description">DESCRIPTION</a></li>
+ <li><a href="#options">OPTIONS</a></li>
+ <li><a href="#see_also">SEE ALSO</a></li>
+ <li><a href="#prerequisites">PREREQUISITES</a></li>
+ <li><a href="#bugs">BUGS</a></li>
+ <li><a href="#authors">AUTHORS</a></li>
+ <li><a href="#copyright">COPYRIGHT</a></li>
+</ul>
+
+<hr name="index" />
+</div>
+<!-- INDEX END -->
+
+<p>
+</p>
+<h1><a name="name">NAME</a></h1>
+<p>spamassassin - simple front-end filtering script for SpamAssassin</p>
+<p>
+</p>
+<hr />
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+<p><strong>spamassassin</strong> [options] [ < <em>mailmessage</em> | <em>path</em> ... ]</p>
+<p><strong>spamassassin</strong> <strong>-d</strong> [ < <em>mailmessage</em> | <em>path</em> ... ]</p>
+<p><strong>spamassassin</strong> <strong>-r</strong> [ < <em>mailmessage</em> | <em>path</em> ... ]</p>
+<p><strong>spamassassin</strong> <strong>-k</strong> [ < <em>mailmessage</em> | <em>path</em> ... ]</p>
+<p><strong>spamassassin</strong> <strong>-W</strong>|<strong>-R</strong> [ < <em>mailmessage</em> | <em>path</em> ... ]</p>
+<p>Options:</p>
+<pre>
+ -L, --local Local tests only (no online tests)
+ -r, --report Report message as spam
+ -k, --revoke Revoke message as spam
+ -d, --remove-markup Remove spam reports from a message
+ -C path, --configpath=path, --config-file=path
+ Path to standard configuration dir
+ -p prefs, --prefspath=file, --prefs-file=file
+ Set user preferences file
+ --siteconfigpath=path Path for site configs
+ (def: /etc/mail/spamassassin)
+ --cf='config line' Additional line of configuration
+ -x, --nocreate-prefs Don't create user preferences file
+ -e, --exit-code Exit with a non-zero exit code if the
+ tested message was spam
+ --mbox read in messages in mbox format
+ --mbx read in messages in UW mbx format
+ -t, --test-mode Pipe message through and add extra
+ report to the bottom
+ --lint Lint the rule set: report syntax errors
+ -W, --add-to-whitelist Add addresses in mail to persistent address whitelist
+ --add-to-blacklist Add addresses in mail to persistent address blacklist
+ -R, --remove-from-whitelist Remove all addresses found in mail from
+ persistent address list
+ --add-addr-to-whitelist=addr Add addr to persistent address whitelist
+ --add-addr-to-blacklist=addr Add addr to persistent address blacklist
+ --remove-addr-from-whitelist=addr Remove addr from persistent address list
+ -4 --ipv4only, --ipv4-only, --ipv4 Use IPv4, disable use of IPv6 for DNS etc.
+ -6 Use IPv6, disable use of IPv4 where possible
+ --progress Print progress bar
+ -D, --debug [area=n,...] Print debugging messages
+ -V, --version Print version
+ -h, --help Print usage message</pre>
+<p>
+</p>
+<hr />
+<h1><a name="description">DESCRIPTION</a></h1>
+<p>spamassassin is a simple front-end filter for SpamAssassin.</p>
+<p>Using the SpamAssassin rule base, it uses a wide range of heuristic
+tests on mail headers and body text to identify "spam", also known as
+unsolicited bulk email. Once identified, the mail is then tagged as
+spam for later filtering using the user's own mail user-agent
+application.</p>
+<p>The default tagging operations that take place are detailed in <em>spamassassin/"TAGGING"</em>.</p>
+<p>By default, message(s) are read in from STDIN (< <em>mailmessage</em>), or
+from specified files and directories (<em>path</em> ...) STDIN and files
+are assumed to be in <em>file</em> format, with a single message per file.
+Directories are assumed to be in a format where each file in the directory
+contains only one message (directories are not recursed and filenames
+containing whitespace or beginning with "." or "," are skipped).
+The options <em>--mbox</em> and <em>--mbx</em> can override the assumed format,
+see the appropriate OPTION information below.</p>
+<p>Please note that SpamAssassin is not designed to scan large
+messages. Don't feed messages larger than about 500 KB to
+SpamAssassin, as this will consume a huge amount of memory.</p>
+<p>
+</p>
+<hr />
+<h1><a name="options">OPTIONS</a></h1>
+<dl>
+<dt><strong><a name="e_error_code_exit_code2" class="item"><strong>-e</strong>, <strong>--error-code</strong>, <strong>--exit-code</strong></a></strong></dt>
+
+<dd>
+<p>Exit with a non-zero error code, if the message is determined to be
+spam.</p>
+</dd>
+<dt><strong><a name="h_help7" class="item"><strong>-h</strong>, <strong>--help</strong></a></strong></dt>
+
+<dd>
+<p>Print help message and exit.</p>
+</dd>
+<dt><strong><a name="v_version6" class="item"><strong>-V</strong>, <strong>--version</strong></a></strong></dt>
+
+<dd>
+<p>Print version and exit.</p>
+</dd>
+<dt><strong><a name="t_test_mode2" class="item"><strong>-t</strong>, <strong>--test-mode</strong></a></strong></dt>
+
+<dd>
+<p>Test mode. Pipe message through and add extra report. Note that the report
+text assumes that the message is spam, since in normal use it is only visible
+in this case. Pay attention to the score instead.</p>
+<p>If you run this with <strong>-d</strong>, the message will first have SpamAssassin
+markup removed before being tested.</p>
+</dd>
+<dt><strong><a name="r_report2" class="item"><strong>-r</strong>, <strong>--report</strong></a></strong></dt>
+
+<dd>
+<p>Report this message as manually-verified spam. This will submit the mail
+message read from STDIN to various spam-blocker databases. Currently,
+these are the Distributed Checksum Clearinghouse
+<code>http://www.dcc-servers.net/dcc/</code>, Pyzor
+<code>http://pyzor.sourceforge.net/</code>, Vipul's Razor
+<code>http://razor.sourceforge.net/</code>, and SpamCop <code>http://www.spamcop.net/</code>.</p>
+<p>If the message contains SpamAssassin markup, the markup will be stripped
+out automatically before submission. The support modules for DCC, Pyzor,
+and Razor must be installed for spam to be reported to each service.
+SpamCop reports will have greater effect if you register and set the
+<code>spamcop_to_address</code> option.</p>
+<p>The message will also be submitted to SpamAssassin's learning systems;
+currently this is the internal Bayesian statistical-filtering system (the
+BAYES rules). (Note that if you <em>only</em> want to perform statistical
+learning, and do not want to report mail to third-parties, you should use
+the <code>sa-learn</code> command directly instead.)</p>
+</dd>
+<dt><strong><a name="k_revoke2" class="item"><strong>-k</strong>, <strong>--revoke</strong></a></strong></dt>
+
+<dd>
+<p>Revoke this message. This will revoke the mail message read from STDIN from
+various spam-blocker databases. Currently, these are Vipul's Razor.</p>
+<p>Revocation support for the Distributed Checksum Clearinghouse, Pyzor, and
+SpamCop is not currently available.</p>
+<p>If the message contains SpamAssassin markup, the markup will be stripped
+out automatically before submission. The support modules for Razor must
+be installed for spam to be revoked from the service.</p>
+<p>The message will also be submitted as 'ham' (non-spam) to SpamAssassin's
+learning systems; currently this is the internal Bayesian
+statistical-filtering system (the BAYES rules). (Note that if you <em>only</em>
+want to perform statistical learning, and do not want to report mail to
+third-parties, you should use the <code>sa-learn</code> command directly instead.)</p>
+</dd>
+<dt><strong><a name="lint2" class="item"><strong>--lint</strong></a></strong></dt>
+
+<dd>
+<p>Syntax check (lint) the rule set and configuration files, reporting
+typos and rules that do not compile correctly. Exits with 0 if there
+are no errors, or greater than 0 if any errors are found.</p>
+</dd>
+<dt><strong><a name="w_add_to_whitelist2" class="item"><strong>-W</strong>, <strong>--add-to-whitelist</strong></a></strong></dt>
+
+<dd>
+<p>Add all email addresses, in the headers and body of the mail message read
+from STDIN, to a persistent address whitelist. Note that you must be running
+<code>spamassassin</code> or <code>spamd</code> with a persistent address list plugin enabled for
+this to work.</p>
+</dd>
+<dt><strong><a name="add_to_blacklist2" class="item"><strong>--add-to-blacklist</strong></a></strong></dt>
+
+<dd>
+<p>Add all email addresses, in the headers and body of the mail message read
+from STDIN, to the persistent address blacklist. Note that you must be
+running <code>spamassassin</code> or <code>spamd</code> with a persistent address list plugin
+enabled for this to work.</p>
+</dd>
+<dt><strong><a name="r_remove_from_whitelist2" class="item"><strong>-R</strong>, <strong>--remove-from-whitelist</strong></a></strong></dt>
+
+<dd>
+<p>Remove all email addresses, in the headers and body of the mail message read
+from STDIN, from a persistent address list. STDIN must contain a full email
+message, so to remove a single address you should use
+<strong>--remove-addr-from-whitelist</strong> instead.</p>
+<p>Note that you must be running <code>spamassassin</code> or <code>spamd</code> with a persistent
+address list plugin enabled for this to work.</p>
+</dd>
+<dt><strong><a name="add_addr_to_whitelist2" class="item"><strong>--add-addr-to-whitelist</strong></a></strong></dt>
+
+<dd>
+<p>Add the named email address to a persistent address whitelist. Note that you
+must be running <code>spamassassin</code> or <code>spamd</code> with a persistent address list
+plugin enabled for this to work.</p>
+</dd>
+<dt><strong><a name="add_addr_to_blacklist2" class="item"><strong>--add-addr-to-blacklist</strong></a></strong></dt>
+
+<dd>
+<p>Add the named email address to a persistent address blacklist. Note that you
+must be running <code>spamassassin</code> or <code>spamd</code> with a persistent address list
+plugin enabled for this to work.</p>
+</dd>
+<dt><strong><a name="remove_addr_from_whitelist2" class="item"><strong>--remove-addr-from-whitelist</strong></a></strong></dt>
+
+<dd>
+<p>Remove the named email address from a persistent address whitelist. Note that
+you must be running <code>spamassassin</code> or <code>spamd</code> with a persistent address
+list plugin enabled for this to work.</p>
+</dd>
+<dt><strong><a name="ipv4only_ipv4_only_ipv42" class="item"><strong> --ipv4only</strong>, <strong>--ipv4-only</strong>, <strong>--ipv4</strong></a></strong></dt>
+
+<dd>
+<p>Do not use IPv6 for DNS tests. Normally, SpamAssassin will try to detect if
+IPv6 is available, using only IPv4 if it is not. Use if the existing tests
+for IPv6 availability produce incorrect results or crashes.</p>
+</dd>
+<dt><strong><a name="l_local4" class="item"><strong>-L</strong>, <strong>--local</strong></a></strong></dt>
+
+<dd>
+<p>Do only the ''local'' tests, ones that do not require an internet connection to
+operate. Normally, SpamAssassin will try to detect whether you are connected
+to the net before doing these tests anyway, but for faster checks you may wish
+to use this.</p>
+<p>Note that SpamAssassin's network rules are run in parallel. This can cause
+overhead in terms of the number of file descriptors required if <strong>--local</strong> is
+not used; it is recommended that the minimum limit on fds be raised to at least
+256 for safety.</p>
+</dd>
+<dt><strong><a name="d_remove_markup2" class="item"><strong>-d</strong>, <strong>--remove-markup</strong></a></strong></dt>
+
+<dd>
+<p>Remove SpamAssassin markup (the "SpamAssassin results" report, X-Spam-Status
+headers, etc.) from the mail message. The resulting message, which will be
+more or less identical to the original, pre-SpamAssassin input, will be output
+to STDOUT.</p>
+<p>(Note: the message will not be exactly identical; some headers will be
+reformatted due to some features of the Mail::Internet package, but the body
+text will be.)</p>
+</dd>
+<dt><strong><a name="c_path_configpath_path_config_file_path4" class="item"><strong>-C</strong> <em>path</em>, <strong>--configpath</strong>=<em>path</em>, <strong>--config-file</strong>=<em>path</em></a></strong></dt>
+
+<dd>
+<p>Use the specified path for locating the distributed configuration files.
+Ignore the default directories (usually <code>/usr/share/spamassassin</code> or similar).</p>
+</dd>
+<dt><strong><a name="siteconfigpath_path5" class="item"><strong>--siteconfigpath</strong>=<em>path</em></a></strong></dt>
+
+<dd>
+<p>Use the specified path for locating site-specific configuration files. Ignore
+the default directories (usually <code>/etc/mail/spamassassin</code> or similar).</p>
+</dd>
+<dt><strong><a name="cf_config_line5" class="item"><strong>--cf='config line'</strong></a></strong></dt>
+
+<dd>
+<p>Add additional lines of configuration directly from the command-line, parsed
+after the configuration files are read. Multiple <strong>--cf</strong> arguments can be
+used, and each will be considered a separate line of configuration. For
+example:</p>
+<pre>
+ spamassassin -t --cf="body NEWRULE /text/" --cf="score NEWRULE 3.0"</pre>
+</dd>
+<dt><strong><a name="p_prefs_prefspath_prefs_prefs_file_prefs4" class="item"><strong>-p</strong> <em>prefs</em>, <strong>--prefspath</strong>=<em>prefs</em>, <strong>--prefs-file</strong>=<em>prefs</em></a></strong></dt>
+
+<dd>
+<p>Read user score preferences from <em>prefs</em> (usually <code>$HOME/.spamassassin/user_prefs</code>).</p>
+</dd>
+<dt><strong><a name="progress3" class="item"><strong>--progress</strong></a></strong></dt>
+
+<dd>
+<p>Prints a progress bar (to STDERR) showing the current progress. This option
+will only be useful if you are redirecting STDOUT (and not STDERR). In the
+case where no valid terminal is found this option will behave very much like
+the --showdots option in other SpamAssassin programs.</p>
+</dd>
+<dt><strong><a name="d_area_debug_area6" class="item"><strong>-D</strong> [<em>area,...</em>], <strong>--debug</strong> [<em>area,...</em>]</a></strong></dt>
+
+<dd>
+<p>Produce debugging output. If no areas are listed, all debugging information is
+printed. Diagnostic output can also be enabled for each area individually;
+<em>area</em> is the area of the code to instrument. For example, to produce
+diagnostic output on bayes, learn, and dns, use:</p>
+<pre>
+ spamassassin -D bayes,learn,dns</pre>
+<p>Higher priority informational messages that are suitable for logging in normal
+circumstances are available with an area of "info".</p>
+<p>For more information about which areas (also known as channels) are available,
+please see the documentation at:</p>
+<pre>
+ L<<a href="http://wiki.apache.org/spamassassin/DebugChannels>">http://wiki.apache.org/spamassassin/DebugChannels></a>;</pre>
+</dd>
+<dt><strong><a name="x_nocreate_prefs2" class="item"><strong>-x</strong>, <strong>--nocreate-prefs</strong></a></strong></dt>
+
+<dd>
+<p>Disable creation of user preferences file.</p>
+</dd>
+<dt><strong><a name="mbox3" class="item"><strong>--mbox</strong></a></strong></dt>
+
+<dd>
+<p>Specify that the input message(s) are in mbox format. mbox is a standard
+Unix message folder format.</p>
+</dd>
+<dt><strong><a name="mbx3" class="item"><strong>--mbx</strong></a></strong></dt>
+
+<dd>
+<p>Specify that the input message(s) are in UW .mbx format. mbx is
+the mailbox format used within the University of Washington's IMAP
+implementation; see <code>http://www.washington.edu/imap/</code>.</p>
+</dd>
+</dl>
+<p>
+</p>
+<hr />
+<h1><a name="see_also">SEE ALSO</a></h1>
+<p>sa-learn(1)
+<code>spamd(1)</code>
+<code>spamc(1)</code>
+Mail::SpamAssassin::Conf(3)
+Mail::SpamAssassin(3)</p>
+<p>
+</p>
+<hr />
+<h1><a name="prerequisites">PREREQUISITES</a></h1>
+<p><code>Mail::SpamAssassin</code></p>
+<p>
+</p>
+<hr />
+<h1><a name="bugs">BUGS</a></h1>
+<p>See <http://issues.apache.org/SpamAssassin/></p>
+<p>
+</p>
+<hr />
+<h1><a name="authors">AUTHORS</a></h1>
+<p>The SpamAssassin(tm) Project <http://spamassassin.apache.org/></p>
+<p>
+</p>
+<hr />
+<h1><a name="copyright">COPYRIGHT</a></h1>
+<p>SpamAssassin is distributed under the Apache License, Version 2.0, as
+described in the file <code>LICENSE</code> included with the distribution.</p>
+
+</body>
+
+</html>
Added: spamassassin/site/full/3.4.x/doc/spamassassin-run.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/spamassassin-run.txt?rev=1676792&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/spamassassin-run.txt (added)
+++ spamassassin/site/full/3.4.x/doc/spamassassin-run.txt Wed Apr 29 17:04:09 2015
@@ -0,0 +1,276 @@
+NAME
+ spamassassin - simple front-end filtering script for SpamAssassin
+
+SYNOPSIS
+ spamassassin [options] [ < *mailmessage* | *path* ... ]
+
+ spamassassin -d [ < *mailmessage* | *path* ... ]
+
+ spamassassin -r [ < *mailmessage* | *path* ... ]
+
+ spamassassin -k [ < *mailmessage* | *path* ... ]
+
+ spamassassin -W|-R [ < *mailmessage* | *path* ... ]
+
+ Options:
+
+ -L, --local Local tests only (no online tests)
+ -r, --report Report message as spam
+ -k, --revoke Revoke message as spam
+ -d, --remove-markup Remove spam reports from a message
+ -C path, --configpath=path, --config-file=path
+ Path to standard configuration dir
+ -p prefs, --prefspath=file, --prefs-file=file
+ Set user preferences file
+ --siteconfigpath=path Path for site configs
+ (def: /etc/mail/spamassassin)
+ --cf='config line' Additional line of configuration
+ -x, --nocreate-prefs Don't create user preferences file
+ -e, --exit-code Exit with a non-zero exit code if the
+ tested message was spam
+ --mbox read in messages in mbox format
+ --mbx read in messages in UW mbx format
+ -t, --test-mode Pipe message through and add extra
+ report to the bottom
+ --lint Lint the rule set: report syntax errors
+ -W, --add-to-whitelist Add addresses in mail to persistent address whitelist
+ --add-to-blacklist Add addresses in mail to persistent address blacklist
+ -R, --remove-from-whitelist Remove all addresses found in mail from
+ persistent address list
+ --add-addr-to-whitelist=addr Add addr to persistent address whitelist
+ --add-addr-to-blacklist=addr Add addr to persistent address blacklist
+ --remove-addr-from-whitelist=addr Remove addr from persistent address list
+ -4 --ipv4only, --ipv4-only, --ipv4 Use IPv4, disable use of IPv6 for DNS etc.
+ -6 Use IPv6, disable use of IPv4 where possible
+ --progress Print progress bar
+ -D, --debug [area=n,...] Print debugging messages
+ -V, --version Print version
+ -h, --help Print usage message
+
+DESCRIPTION
+ spamassassin is a simple front-end filter for SpamAssassin.
+
+ Using the SpamAssassin rule base, it uses a wide range of heuristic
+ tests on mail headers and body text to identify "spam", also known as
+ unsolicited bulk email. Once identified, the mail is then tagged as spam
+ for later filtering using the user's own mail user-agent application.
+
+ The default tagging operations that take place are detailed in "TAGGING"
+ in spamassassin.
+
+ By default, message(s) are read in from STDIN (< *mailmessage*), or from
+ specified files and directories (*path* ...) STDIN and files are assumed
+ to be in *file* format, with a single message per file. Directories are
+ assumed to be in a format where each file in the directory contains only
+ one message (directories are not recursed and filenames containing
+ whitespace or beginning with "." or "," are skipped). The options
+ *--mbox* and *--mbx* can override the assumed format, see the
+ appropriate OPTION information below.
+
+ Please note that SpamAssassin is not designed to scan large messages.
+ Don't feed messages larger than about 500 KB to SpamAssassin, as this
+ will consume a huge amount of memory.
+
+OPTIONS
+ -e, --error-code, --exit-code
+ Exit with a non-zero error code, if the message is determined to be
+ spam.
+
+ -h, --help
+ Print help message and exit.
+
+ -V, --version
+ Print version and exit.
+
+ -t, --test-mode
+ Test mode. Pipe message through and add extra report. Note that the
+ report text assumes that the message is spam, since in normal use it
+ is only visible in this case. Pay attention to the score instead.
+
+ If you run this with -d, the message will first have SpamAssassin
+ markup removed before being tested.
+
+ -r, --report
+ Report this message as manually-verified spam. This will submit the
+ mail message read from STDIN to various spam-blocker databases.
+ Currently, these are the Distributed Checksum Clearinghouse
+ "http://www.dcc-servers.net/dcc/", Pyzor
+ "http://pyzor.sourceforge.net/", Vipul's Razor
+ "http://razor.sourceforge.net/", and SpamCop
+ "http://www.spamcop.net/".
+
+ If the message contains SpamAssassin markup, the markup will be
+ stripped out automatically before submission. The support modules
+ for DCC, Pyzor, and Razor must be installed for spam to be reported
+ to each service. SpamCop reports will have greater effect if you
+ register and set the "spamcop_to_address" option.
+
+ The message will also be submitted to SpamAssassin's learning
+ systems; currently this is the internal Bayesian
+ statistical-filtering system (the BAYES rules). (Note that if you
+ *only* want to perform statistical learning, and do not want to
+ report mail to third-parties, you should use the "sa-learn" command
+ directly instead.)
+
+ -k, --revoke
+ Revoke this message. This will revoke the mail message read from
+ STDIN from various spam-blocker databases. Currently, these are
+ Vipul's Razor.
+
+ Revocation support for the Distributed Checksum Clearinghouse,
+ Pyzor, and SpamCop is not currently available.
+
+ If the message contains SpamAssassin markup, the markup will be
+ stripped out automatically before submission. The support modules
+ for Razor must be installed for spam to be revoked from the service.
+
+ The message will also be submitted as 'ham' (non-spam) to
+ SpamAssassin's learning systems; currently this is the internal
+ Bayesian statistical-filtering system (the BAYES rules). (Note that
+ if you *only* want to perform statistical learning, and do not want
+ to report mail to third-parties, you should use the "sa-learn"
+ command directly instead.)
+
+ --lint
+ Syntax check (lint) the rule set and configuration files, reporting
+ typos and rules that do not compile correctly. Exits with 0 if there
+ are no errors, or greater than 0 if any errors are found.
+
+ -W, --add-to-whitelist
+ Add all email addresses, in the headers and body of the mail message
+ read from STDIN, to a persistent address whitelist. Note that you
+ must be running "spamassassin" or "spamd" with a persistent address
+ list plugin enabled for this to work.
+
+ --add-to-blacklist
+ Add all email addresses, in the headers and body of the mail message
+ read from STDIN, to the persistent address blacklist. Note that you
+ must be running "spamassassin" or "spamd" with a persistent address
+ list plugin enabled for this to work.
+
+ -R, --remove-from-whitelist
+ Remove all email addresses, in the headers and body of the mail
+ message read from STDIN, from a persistent address list. STDIN must
+ contain a full email message, so to remove a single address you
+ should use --remove-addr-from-whitelist instead.
+
+ Note that you must be running "spamassassin" or "spamd" with a
+ persistent address list plugin enabled for this to work.
+
+ --add-addr-to-whitelist
+ Add the named email address to a persistent address whitelist. Note
+ that you must be running "spamassassin" or "spamd" with a persistent
+ address list plugin enabled for this to work.
+
+ --add-addr-to-blacklist
+ Add the named email address to a persistent address blacklist. Note
+ that you must be running "spamassassin" or "spamd" with a persistent
+ address list plugin enabled for this to work.
+
+ --remove-addr-from-whitelist
+ Remove the named email address from a persistent address whitelist.
+ Note that you must be running "spamassassin" or "spamd" with a
+ persistent address list plugin enabled for this to work.
+
+ --ipv4only, --ipv4-only, --ipv4
+ Do not use IPv6 for DNS tests. Normally, SpamAssassin will try to
+ detect if IPv6 is available, using only IPv4 if it is not. Use if
+ the existing tests for IPv6 availability produce incorrect results
+ or crashes.
+
+ -L, --local
+ Do only the ''local'' tests, ones that do not require an internet
+ connection to operate. Normally, SpamAssassin will try to detect
+ whether you are connected to the net before doing these tests
+ anyway, but for faster checks you may wish to use this.
+
+ Note that SpamAssassin's network rules are run in parallel. This can
+ cause overhead in terms of the number of file descriptors required
+ if --local is not used; it is recommended that the minimum limit on
+ fds be raised to at least 256 for safety.
+
+ -d, --remove-markup
+ Remove SpamAssassin markup (the "SpamAssassin results" report,
+ X-Spam-Status headers, etc.) from the mail message. The resulting
+ message, which will be more or less identical to the original,
+ pre-SpamAssassin input, will be output to STDOUT.
+
+ (Note: the message will not be exactly identical; some headers will
+ be reformatted due to some features of the Mail::Internet package,
+ but the body text will be.)
+
+ -C *path*, --configpath=*path*, --config-file=*path*
+ Use the specified path for locating the distributed configuration
+ files. Ignore the default directories (usually
+ "/usr/share/spamassassin" or similar).
+
+ --siteconfigpath=*path*
+ Use the specified path for locating site-specific configuration
+ files. Ignore the default directories (usually
+ "/etc/mail/spamassassin" or similar).
+
+ --cf='config line'
+ Add additional lines of configuration directly from the
+ command-line, parsed after the configuration files are read.
+ Multiple --cf arguments can be used, and each will be considered a
+ separate line of configuration. For example:
+
+ spamassassin -t --cf="body NEWRULE /text/" --cf="score NEWRULE 3.0"
+
+ -p *prefs*, --prefspath=*prefs*, --prefs-file=*prefs*
+ Read user score preferences from *prefs* (usually
+ "$HOME/.spamassassin/user_prefs").
+
+ --progress
+ Prints a progress bar (to STDERR) showing the current progress. This
+ option will only be useful if you are redirecting STDOUT (and not
+ STDERR). In the case where no valid terminal is found this option
+ will behave very much like the --showdots option in other
+ SpamAssassin programs.
+
+ -D [*area,...*], --debug [*area,...*]
+ Produce debugging output. If no areas are listed, all debugging
+ information is printed. Diagnostic output can also be enabled for
+ each area individually; *area* is the area of the code to
+ instrument. For example, to produce diagnostic output on bayes,
+ learn, and dns, use:
+
+ spamassassin -D bayes,learn,dns
+
+ Higher priority informational messages that are suitable for logging
+ in normal circumstances are available with an area of "info".
+
+ For more information about which areas (also known as channels) are
+ available, please see the documentation at:
+
+ L<http://wiki.apache.org/spamassassin/DebugChannels>
+
+ -x, --nocreate-prefs
+ Disable creation of user preferences file.
+
+ --mbox
+ Specify that the input message(s) are in mbox format. mbox is a
+ standard Unix message folder format.
+
+ --mbx
+ Specify that the input message(s) are in UW .mbx format. mbx is the
+ mailbox format used within the University of Washington's IMAP
+ implementation; see "http://www.washington.edu/imap/".
+
+SEE ALSO
+ sa-learn(1) spamd(1) spamc(1) Mail::SpamAssassin::Conf(3)
+ Mail::SpamAssassin(3)
+
+PREREQUISITES
+ "Mail::SpamAssassin"
+
+BUGS
+ See <http://issues.apache.org/SpamAssassin/>
+
+AUTHORS
+ The SpamAssassin(tm) Project <http://spamassassin.apache.org/>
+
+COPYRIGHT
+ SpamAssassin is distributed under the Apache License, Version 2.0, as
+ described in the file "LICENSE" included with the distribution.
+
Added: spamassassin/site/full/3.4.x/doc/spamassassin.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/spamassassin.html?rev=1676792&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/spamassassin.html (added)
+++ spamassassin/site/full/3.4.x/doc/spamassassin.html Wed Apr 29 17:04:09 2015
@@ -0,0 +1,390 @@
+<?xml version="1.0" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<title>spamassassin - extensible email filter used to identify spam</title>
+<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+<link rev="made" href="mailto:root@localhost" />
+</head>
+
+<body style="background-color: white">
+
+
+<!-- INDEX BEGIN -->
+<div name="index">
+<p><a name="__index__"></a></p>
+
+<ul>
+
+ <li><a href="#name">NAME</a></li>
+ <li><a href="#description">DESCRIPTION</a></li>
+ <li><a href="#synopsis">SYNOPSIS</a></li>
+ <ul>
+
+ <li><a href="#overview">OVERVIEW</a></li>
+ <li><a href="#configuration">CONFIGURATION</a></li>
+ <li><a href="#usage">USAGE</a></li>
+ <li><a href="#default_plugins">DEFAULT PLUGINS</a></li>
+ </ul>
+
+ <li><a href="#web_sites">WEB SITES</a></li>
+ <li><a href="#user_mailing_list">USER MAILING LIST</a></li>
+ <li><a href="#configuration_files">CONFIGURATION FILES</a></li>
+ <li><a href="#tagging">TAGGING</a></li>
+ <ul>
+
+ <li><a href="#tagging_for_spam_mails">TAGGING FOR SPAM MAILS</a></li>
+ <li><a href="#default_tagging_for_all_mails">DEFAULT TAGGING FOR ALL MAILS</a></li>
+ </ul>
+
+ <li><a href="#installation">INSTALLATION</a></li>
+ <li><a href="#developer_documentation">DEVELOPER DOCUMENTATION</a></li>
+ <li><a href="#bugs">BUGS</a></li>
+ <li><a href="#authors">AUTHORS</a></li>
+ <li><a href="#copyright">COPYRIGHT</a></li>
+</ul>
+
+<hr name="index" />
+</div>
+<!-- INDEX END -->
+
+<p>
+</p>
+<h1><a name="name">NAME</a></h1>
+<p>spamassassin - extensible email filter used to identify spam</p>
+<p>
+</p>
+<hr />
+<h1><a name="description">DESCRIPTION</a></h1>
+<p>SpamAssassin is an intelligent email filter which uses a diverse range of
+tests to identify unsolicited bulk email, more commonly known as "spam".
+These tests are applied to email headers and content to classify email
+using advanced statistical methods. In addition, SpamAssassin has a
+modular architecture that allows other technologies to be quickly wielded
+against spam and is designed for easy integration into virtually any email
+system.</p>
+<p>
+</p>
+<hr />
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+<p>For ease of access, the SpamAssassin manual has been split up into
+several sections. If you're intending to read these straight through
+for the first time, the suggested order will tend to reduce the number
+of forward references.</p>
+<p>Extensive additional documentation for SpamAssassin is available,
+primarily on the SpamAssassin web site and wiki.</p>
+<p>You should be able to view SpamAssassin's documentation with your <code>man(1)</code>
+program or <code>perldoc(1)</code>.</p>
+<p>
+</p>
+<h2><a name="overview">OVERVIEW</a></h2>
+<pre>
+ spamassassin SpamAssassin overview (this section)</pre>
+<p>
+</p>
+<h2><a name="configuration">CONFIGURATION</a></h2>
+<pre>
+ Mail::SpamAssassin::Conf SpamAssassin configuration files</pre>
+<p>
+</p>
+<h2><a name="usage">USAGE</a></h2>
+<pre>
+ spamassassin-run "spamassassin" front-end filtering script
+ sa-learn train SpamAssassin's Bayesian classifier
+ spamc client for spamd (faster than spamassassin)
+ spamd spamassassin server (needed by spamc)</pre>
+<p>
+</p>
+<h2><a name="default_plugins">DEFAULT PLUGINS</a></h2>
+<pre>
+ Mail::SpamAssassin::Plugin::AskDNS
+ Mail::SpamAssassin::Plugin::AutoLearnThreshold
+ Mail::SpamAssassin::Plugin::Bayes
+ Mail::SpamAssassin::Plugin::BodyEval
+ Mail::SpamAssassin::Plugin::Check
+ Mail::SpamAssassin::Plugin::DKIM
+ Mail::SpamAssassin::Plugin::DNSEval
+ Mail::SpamAssassin::Plugin::FreeMail
+ Mail::SpamAssassin::Plugin::HTMLEval
+ Mail::SpamAssassin::Plugin::HTTPSMismatch
+ Mail::SpamAssassin::Plugin::Hashcash
+ Mail::SpamAssassin::Plugin::HeaderEval
+ Mail::SpamAssassin::Plugin::ImageInfo
+ Mail::SpamAssassin::Plugin::MIMEEval
+ Mail::SpamAssassin::Plugin::MIMEHeader
+ Mail::SpamAssassin::Plugin::Pyzor
+ Mail::SpamAssassin::Plugin::Razor2
+ Mail::SpamAssassin::Plugin::RelayEval
+ Mail::SpamAssassin::Plugin::ReplaceTags
+ Mail::SpamAssassin::Plugin::SPF
+ Mail::SpamAssassin::Plugin::SpamCop
+ Mail::SpamAssassin::Plugin::URIDNSBL
+ Mail::SpamAssassin::Plugin::URIDetail
+ Mail::SpamAssassin::Plugin::URIEval
+ Mail::SpamAssassin::Plugin::VBounce
+ Mail::SpamAssassin::Plugin::WLBLEval
+ Mail::SpamAssassin::Plugin::WhiteListSubject</pre>
+<p>
+</p>
+<hr />
+<h1><a name="web_sites">WEB SITES</a></h1>
+<pre>
+ SpamAssassin web site: <a href="http://spamassassin.apache.org/">http://spamassassin.apache.org/</a>
+ Wiki-based documentation: <a href="http://wiki.apache.org/spamassassin/">http://wiki.apache.org/spamassassin/</a></pre>
+<p>
+</p>
+<hr />
+<h1><a name="user_mailing_list">USER MAILING LIST</a></h1>
+<p>A users mailing list exists where other experienced users are often able
+to help and provide tips and advice. Subscription instructions are
+located on the SpamAssassin web site.</p>
+<p>
+</p>
+<hr />
+<h1><a name="configuration_files">CONFIGURATION FILES</a></h1>
+<p>The SpamAssassin rule base, text templates, and rule description text
+are loaded from configuration files.</p>
+<p>Default configuration data is loaded from the first existing directory
+in:</p>
+<dl>
+<dt><strong><a name="var_lib_spamassassin_3_004001" class="item">/var/lib/spamassassin/3.004001</a></strong></dt>
+
+<dt><strong><a name="usr_local_share_spamassassin" class="item">/usr/local/share/spamassassin</a></strong></dt>
+
+<dt><strong><a name="usr_local_share_spamassassin2" class="item">/usr/local/share/spamassassin</a></strong></dt>
+
+<dt><strong><a name="usr_local_share_spamassassin3" class="item">/usr/local/share/spamassassin</a></strong></dt>
+
+<dt><strong><a name="usr_share_spamassassin" class="item">/usr/share/spamassassin</a></strong></dt>
+
+</dl>
+<p>Site-specific configuration data is used to override any values which had
+already been set. This is loaded from the first existing directory in:</p>
+<dl>
+<dt><strong><a name="etc_mail_spamassassin" class="item">/etc/mail/spamassassin</a></strong></dt>
+
+<dt><strong><a name="usr_local_etc_mail_spamassassin" class="item">/usr/local/etc/mail/spamassassin</a></strong></dt>
+
+<dt><strong><a name="usr_local_etc_spamassassin" class="item">/usr/local/etc/spamassassin</a></strong></dt>
+
+<dt><strong><a name="usr_local_etc_spamassassin2" class="item">/usr/local/etc/spamassassin</a></strong></dt>
+
+<dt><strong><a name="usr_pkg_etc_spamassassin" class="item">/usr/pkg/etc/spamassassin</a></strong></dt>
+
+<dt><strong><a name="usr_etc_spamassassin" class="item">/usr/etc/spamassassin</a></strong></dt>
+
+<dt><strong><a name="etc_mail_spamassassin2" class="item">/etc/mail/spamassassin</a></strong></dt>
+
+<dt><strong><a name="etc_spamassassin" class="item">/etc/spamassassin</a></strong></dt>
+
+</dl>
+<p>From those three directories, SpamAssassin will first read files ending in
+".pre" in lexical order and then it will read files ending in ".cf" in
+lexical order (most files begin with two numbers to make the sorting
+order obvious).</p>
+<p>In other words, it will read <em class="file">init.pre</em> first, then <em class="file">10_default_prefs.cf</em> before
+<em class="file">50_scores.cf</em> and <em class="file">20_body_tests.cf</em> before <em class="file">20_head_tests.cf</em>.
+Options in later files will override earlier files.</p>
+<p>Individual user preferences are loaded from the location specified on
+the <code>spamassassin</code>, <code>sa-learn</code>, or <code>spamd</code> command line (see respective
+manual page for details). If the location is not specified,
+<em class="file">~/.spamassassin/user_prefs</em> is used if it exists. SpamAssassin will
+create that file if it does not already exist, using
+<em class="file">user_prefs.template</em> as a template. That file will be looked for in:</p>
+<dl>
+<dt><strong><a name="etc_mail_spamassassin3" class="item">/etc/mail/spamassassin</a></strong></dt>
+
+<dt><strong><a name="usr_local_etc_mail_spamassassin2" class="item">/usr/local/etc/mail/spamassassin</a></strong></dt>
+
+<dt><strong><a name="usr_local_share_spamassassin4" class="item">/usr/local/share/spamassassin</a></strong></dt>
+
+<dt><strong><a name="etc_spamassassin2" class="item">/etc/spamassassin</a></strong></dt>
+
+<dt><strong><a name="etc_mail_spamassassin4" class="item">/etc/mail/spamassassin</a></strong></dt>
+
+<dt><strong><a name="usr_local_share_spamassassin5" class="item">/usr/local/share/spamassassin</a></strong></dt>
+
+<dt><strong><a name="usr_share_spamassassin2" class="item">/usr/share/spamassassin</a></strong></dt>
+
+</dl>
+<p>
+</p>
+<hr />
+<h1><a name="tagging">TAGGING</a></h1>
+<p>The following two sections detail the default tagging and markup that
+takes place for messages when running <code>spamassassin</code> or <code>spamc</code> with
+<code>spamd</code> in the default configuration.</p>
+<p>Note: before header modification and addition, all headers beginning
+with <code>X-Spam-</code> are removed to prevent spammer mischief and also to
+avoid potential problems caused by prior invocations of SpamAssassin.</p>
+<p>
+</p>
+<h2><a name="tagging_for_spam_mails">TAGGING FOR SPAM MAILS</a></h2>
+<p>By default, all messages with a calculated score of 5.0 or higher are
+tagged as spam.</p>
+<p>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).</p>
+<p>The new report message inherits the following headers (if they are
+present) from the original spam message:</p>
+<dl>
+<dt><strong><a name="from_header" class="item">From: header</a></strong></dt>
+
+<dt><strong><a name="to_header" class="item">To: header</a></strong></dt>
+
+<dt><strong><a name="cc_header" class="item">Cc: header</a></strong></dt>
+
+<dt><strong><a name="subject_header" class="item">Subject: header</a></strong></dt>
+
+<dt><strong><a name="date_header" class="item">Date: header</a></strong></dt>
+
+<dt><strong><a name="message_id_header" class="item">Message-ID: header</a></strong></dt>
+
+</dl>
+<p>The above headers can be modified if the relevant <code>rewrite_header</code>
+option is given (see <code>Mail::SpamAssassin::Conf</code> for more information).</p>
+<p>By default these message headers are added to spam:</p>
+<dl>
+<dt><strong><a name="x_spam_flag_header" class="item">X-Spam-Flag: header</a></strong></dt>
+
+<dd>
+<p>Set to <code>YES</code>.</p>
+</dd>
+</dl>
+<p>The headers that added are fully configurable via the <code>add_header</code>
+option (see <code>Mail::SpamAssassin::Conf</code> for more information).</p>
+<dl>
+<dt><strong><a name="spam_mail_body_text" class="item">spam mail body text</a></strong></dt>
+
+<dd>
+<p>The SpamAssassin report is added to top of the mail message body,
+if the message is marked as spam.</p>
+</dd>
+</dl>
+<p>
+</p>
+<h2><a name="default_tagging_for_all_mails">DEFAULT TAGGING FOR ALL MAILS</a></h2>
+<p>These headers are added to all messages, both spam and ham (non-spam).</p>
+<dl>
+<dt><strong><a name="x_spam_checker_version_header" class="item">X-Spam-Checker-Version: header</a></strong></dt>
+
+<dd>
+<p>The version and subversion of SpamAssassin and the host where
+SpamAssassin was run.</p>
+</dd>
+<dt><strong><a name="x_spam_level_header" class="item">X-Spam-Level: header</a></strong></dt>
+
+<dd>
+<p>A series of "*" charactes where each one represents a full score point.</p>
+</dd>
+<dt><strong><a name="x_spam_status_header" class="item">X-Spam-Status: header</a></strong></dt>
+
+<dd>
+<p>A string, <code>(Yes|No), score=nn required=nn tests=xxx,xxx
+autolearn=(ham|spam|no|unavailable|failed)</code> is set in this header to
+reflect the filter status. For the first word, "Yes" means spam and
+"No" means ham (non-spam).</p>
+</dd>
+</dl>
+<p>The headers that added are fully configurable via the <code>add_header</code>
+option (see <code>Mail::SpamAssassin::Conf</code> for more information).</p>
+<p>
+</p>
+<hr />
+<h1><a name="installation">INSTALLATION</a></h1>
+<p>The <strong>spamassassin</strong> command is part of the <strong>Mail::SpamAssassin</strong> Perl module.
+Install this as a normal Perl module, using <code>perl -MCPAN -e shell</code>, or by
+hand.</p>
+<p>Note that it is not possible to use the <code>PERL5LIB</code> environment variable
+to affect where SpamAssassin finds its perl modules, due to limitations
+imposed by perl's "taint" security checks.</p>
+<p>For further details on how to install, please read the <code>INSTALL</code> file
+from the SpamAssassin distribution.</p>
+<p>
+</p>
+<hr />
+<h1><a name="developer_documentation">DEVELOPER DOCUMENTATION</a></h1>
+<pre>
+ Mail::SpamAssassin
+ Spam detector and markup engine</pre>
+<pre>
+ Mail::SpamAssassin::ArchiveIterator
+ find and process messages one at a time</pre>
+<pre>
+ Mail::SpamAssassin::AutoWhitelist
+ auto-whitelist handler for SpamAssassin</pre>
+<pre>
+ Mail::SpamAssassin::Bayes
+ determine spammishness using a Bayesian classifier</pre>
+<pre>
+ Mail::SpamAssassin::BayesStore
+ Bayesian Storage Module</pre>
+<pre>
+ Mail::SpamAssassin::BayesStore::SQL
+ SQL Bayesian Storage Module Implementation</pre>
+<pre>
+ Mail::SpamAssassin::Conf::LDAP
+ load SpamAssassin scores from LDAP database</pre>
+<pre>
+ Mail::SpamAssassin::Conf::Parser
+ parse SpamAssassin configuration</pre>
+<pre>
+ Mail::SpamAssassin::Conf::SQL
+ load SpamAssassin scores from SQL database</pre>
+<pre>
+ Mail::SpamAssassin::Message
+ decode, render, and hold an RFC-2822 message</pre>
+<pre>
+ Mail::SpamAssassin::Message::Metadata
+ extract metadata from a message</pre>
+<pre>
+ Mail::SpamAssassin::Message::Node
+ decode, render, and make available MIME message parts</pre>
+<pre>
+ Mail::SpamAssassin::PerMsgLearner
+ per-message status (spam or not-spam)</pre>
+<pre>
+ Mail::SpamAssassin::PerMsgStatus
+ per-message status (spam or not-spam)</pre>
+<pre>
+ Mail::SpamAssassin::PersistentAddrList
+ persistent address list base class</pre>
+<pre>
+ Mail::SpamAssassin::Plugin
+ SpamAssassin plugin base class</pre>
+<pre>
+ Mail::SpamAssassin::Plugin::Hashcash
+ perform hashcash verification tests</pre>
+<pre>
+ Mail::SpamAssassin::Plugin::RelayCountry
+ add message metadata indicating the country code of each relay</pre>
+<pre>
+ Mail::SpamAssassin::Plugin::SPF
+ perform SPF verification tests</pre>
+<pre>
+ Mail::SpamAssassin::Plugin::URIDNSBL
+ look up URLs against DNS blocklists</pre>
+<pre>
+ Mail::SpamAssassin::SQLBasedAddrList
+ SpamAssassin SQL Based Auto Whitelist</pre>
+<p>
+</p>
+<hr />
+<h1><a name="bugs">BUGS</a></h1>
+<p>See <http://issues.apache.org/SpamAssassin/></p>
+<p>
+</p>
+<hr />
+<h1><a name="authors">AUTHORS</a></h1>
+<p>The SpamAssassin(tm) Project <http://spamassassin.apache.org/></p>
+<p>
+</p>
+<hr />
+<h1><a name="copyright">COPYRIGHT</a></h1>
+<p>SpamAssassin is distributed under the Apache License, Version 2.0, as
+described in the file <code>LICENSE</code> included with the distribution.</p>
+
+</body>
+
+</html>
Added: spamassassin/site/full/3.4.x/doc/spamassassin.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/spamassassin.txt?rev=1676792&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/spamassassin.txt (added)
+++ spamassassin/site/full/3.4.x/doc/spamassassin.txt Wed Apr 29 17:04:09 2015
@@ -0,0 +1,273 @@
+NAME
+ spamassassin - extensible email filter used to identify spam
+
+DESCRIPTION
+ SpamAssassin is an intelligent email filter which uses a diverse range
+ of tests to identify unsolicited bulk email, more commonly known as
+ "spam". These tests are applied to email headers and content to classify
+ email using advanced statistical methods. In addition, SpamAssassin has
+ a modular architecture that allows other technologies to be quickly
+ wielded against spam and is designed for easy integration into virtually
+ any email system.
+
+SYNOPSIS
+ For ease of access, the SpamAssassin manual has been split up into
+ several sections. If you're intending to read these straight through for
+ the first time, the suggested order will tend to reduce the number of
+ forward references.
+
+ Extensive additional documentation for SpamAssassin is available,
+ primarily on the SpamAssassin web site and wiki.
+
+ You should be able to view SpamAssassin's documentation with your man(1)
+ program or perldoc(1).
+
+ OVERVIEW
+ spamassassin SpamAssassin overview (this section)
+
+ CONFIGURATION
+ Mail::SpamAssassin::Conf SpamAssassin configuration files
+
+ USAGE
+ spamassassin-run "spamassassin" front-end filtering script
+ sa-learn train SpamAssassin's Bayesian classifier
+ spamc client for spamd (faster than spamassassin)
+ spamd spamassassin server (needed by spamc)
+
+ DEFAULT PLUGINS
+ Mail::SpamAssassin::Plugin::AskDNS
+ Mail::SpamAssassin::Plugin::AutoLearnThreshold
+ Mail::SpamAssassin::Plugin::Bayes
+ Mail::SpamAssassin::Plugin::BodyEval
+ Mail::SpamAssassin::Plugin::Check
+ Mail::SpamAssassin::Plugin::DKIM
+ Mail::SpamAssassin::Plugin::DNSEval
+ Mail::SpamAssassin::Plugin::FreeMail
+ Mail::SpamAssassin::Plugin::HTMLEval
+ Mail::SpamAssassin::Plugin::HTTPSMismatch
+ Mail::SpamAssassin::Plugin::Hashcash
+ Mail::SpamAssassin::Plugin::HeaderEval
+ Mail::SpamAssassin::Plugin::ImageInfo
+ Mail::SpamAssassin::Plugin::MIMEEval
+ Mail::SpamAssassin::Plugin::MIMEHeader
+ Mail::SpamAssassin::Plugin::Pyzor
+ Mail::SpamAssassin::Plugin::Razor2
+ Mail::SpamAssassin::Plugin::RelayEval
+ Mail::SpamAssassin::Plugin::ReplaceTags
+ Mail::SpamAssassin::Plugin::SPF
+ Mail::SpamAssassin::Plugin::SpamCop
+ Mail::SpamAssassin::Plugin::URIDNSBL
+ Mail::SpamAssassin::Plugin::URIDetail
+ Mail::SpamAssassin::Plugin::URIEval
+ Mail::SpamAssassin::Plugin::VBounce
+ Mail::SpamAssassin::Plugin::WLBLEval
+ Mail::SpamAssassin::Plugin::WhiteListSubject
+
+WEB SITES
+ SpamAssassin web site: http://spamassassin.apache.org/
+ Wiki-based documentation: http://wiki.apache.org/spamassassin/
+
+USER MAILING LIST
+ A users mailing list exists where other experienced users are often able
+ to help and provide tips and advice. Subscription instructions are
+ located on the SpamAssassin web site.
+
+CONFIGURATION FILES
+ The SpamAssassin rule base, text templates, and rule description text
+ are loaded from configuration files.
+
+ Default configuration data is loaded from the first existing directory
+ in:
+
+ /var/lib/spamassassin/3.004001
+ /usr/local/share/spamassassin
+ /usr/local/share/spamassassin
+ /usr/local/share/spamassassin
+ /usr/share/spamassassin
+
+ Site-specific configuration data is used to override any values which
+ had already been set. This is loaded from the first existing directory
+ in:
+
+ /etc/mail/spamassassin
+ /usr/local/etc/mail/spamassassin
+ /usr/local/etc/spamassassin
+ /usr/local/etc/spamassassin
+ /usr/pkg/etc/spamassassin
+ /usr/etc/spamassassin
+ /etc/mail/spamassassin
+ /etc/spamassassin
+
+ From those three directories, SpamAssassin will first read files ending
+ in ".pre" in lexical order and then it will read files ending in ".cf"
+ in lexical order (most files begin with two numbers to make the sorting
+ order obvious).
+
+ In other words, it will read init.pre first, then 10_default_prefs.cf
+ before 50_scores.cf and 20_body_tests.cf before 20_head_tests.cf.
+ Options in later files will override earlier files.
+
+ Individual user preferences are loaded from the location specified on
+ the "spamassassin", "sa-learn", or "spamd" command line (see respective
+ manual page for details). If the location is not specified,
+ ~/.spamassassin/user_prefs is used if it exists. SpamAssassin will
+ create that file if it does not already exist, using user_prefs.template
+ as a template. That file will be looked for in:
+
+ /etc/mail/spamassassin
+ /usr/local/etc/mail/spamassassin
+ /usr/local/share/spamassassin
+ /etc/spamassassin
+ /etc/mail/spamassassin
+ /usr/local/share/spamassassin
+ /usr/share/spamassassin
+
+TAGGING
+ The following two sections detail the default tagging and markup that
+ takes place for messages when running "spamassassin" or "spamc" with
+ "spamd" in the default configuration.
+
+ Note: before header modification and addition, all headers beginning
+ with "X-Spam-" are removed to prevent spammer mischief and also to avoid
+ potential problems caused by prior invocations of SpamAssassin.
+
+ TAGGING FOR SPAM MAILS
+ By default, all messages with a calculated score of 5.0 or higher are
+ tagged as spam.
+
+ 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).
+
+ The new report message inherits the following headers (if they are
+ present) from the original spam message:
+
+ From: header
+ To: header
+ Cc: header
+ Subject: header
+ Date: header
+ Message-ID: header
+
+ The above headers can be modified if the relevant "rewrite_header"
+ option is given (see "Mail::SpamAssassin::Conf" for more information).
+
+ By default these message headers are added to spam:
+
+ X-Spam-Flag: header
+ Set to "YES".
+
+ The headers that added are fully configurable via the "add_header"
+ option (see "Mail::SpamAssassin::Conf" for more information).
+
+ spam mail body text
+ The SpamAssassin report is added to top of the mail message body, if
+ the message is marked as spam.
+
+ DEFAULT TAGGING FOR ALL MAILS
+ These headers are added to all messages, both spam and ham (non-spam).
+
+ X-Spam-Checker-Version: header
+ The version and subversion of SpamAssassin and the host where
+ SpamAssassin was run.
+
+ X-Spam-Level: header
+ A series of "*" charactes where each one represents a full score
+ point.
+
+ X-Spam-Status: header
+ A string, "(Yes|No), score=nn required=nn tests=xxx,xxx
+ autolearn=(ham|spam|no|unavailable|failed)" is set in this header to
+ reflect the filter status. For the first word, "Yes" means spam and
+ "No" means ham (non-spam).
+
+ The headers that added are fully configurable via the "add_header"
+ option (see "Mail::SpamAssassin::Conf" for more information).
+
+INSTALLATION
+ The spamassassin command is part of the Mail::SpamAssassin Perl module.
+ Install this as a normal Perl module, using "perl -MCPAN -e shell", or
+ by hand.
+
+ Note that it is not possible to use the "PERL5LIB" environment variable
+ to affect where SpamAssassin finds its perl modules, due to limitations
+ imposed by perl's "taint" security checks.
+
+ For further details on how to install, please read the "INSTALL" file
+ from the SpamAssassin distribution.
+
+DEVELOPER DOCUMENTATION
+ Mail::SpamAssassin
+ Spam detector and markup engine
+
+ Mail::SpamAssassin::ArchiveIterator
+ find and process messages one at a time
+
+ Mail::SpamAssassin::AutoWhitelist
+ auto-whitelist handler for SpamAssassin
+
+ Mail::SpamAssassin::Bayes
+ determine spammishness using a Bayesian classifier
+
+ Mail::SpamAssassin::BayesStore
+ Bayesian Storage Module
+
+ Mail::SpamAssassin::BayesStore::SQL
+ SQL Bayesian Storage Module Implementation
+
+ Mail::SpamAssassin::Conf::LDAP
+ load SpamAssassin scores from LDAP database
+
+ Mail::SpamAssassin::Conf::Parser
+ parse SpamAssassin configuration
+
+ Mail::SpamAssassin::Conf::SQL
+ load SpamAssassin scores from SQL database
+
+ Mail::SpamAssassin::Message
+ decode, render, and hold an RFC-2822 message
+
+ Mail::SpamAssassin::Message::Metadata
+ extract metadata from a message
+
+ Mail::SpamAssassin::Message::Node
+ decode, render, and make available MIME message parts
+
+ Mail::SpamAssassin::PerMsgLearner
+ per-message status (spam or not-spam)
+
+ Mail::SpamAssassin::PerMsgStatus
+ per-message status (spam or not-spam)
+
+ Mail::SpamAssassin::PersistentAddrList
+ persistent address list base class
+
+ Mail::SpamAssassin::Plugin
+ SpamAssassin plugin base class
+
+ Mail::SpamAssassin::Plugin::Hashcash
+ perform hashcash verification tests
+
+ Mail::SpamAssassin::Plugin::RelayCountry
+ add message metadata indicating the country code of each relay
+
+ Mail::SpamAssassin::Plugin::SPF
+ perform SPF verification tests
+
+ Mail::SpamAssassin::Plugin::URIDNSBL
+ look up URLs against DNS blocklists
+
+ Mail::SpamAssassin::SQLBasedAddrList
+ SpamAssassin SQL Based Auto Whitelist
+
+BUGS
+ See <http://issues.apache.org/SpamAssassin/>
+
+AUTHORS
+ The SpamAssassin(tm) Project <http://spamassassin.apache.org/>
+
+COPYRIGHT
+ SpamAssassin is distributed under the Apache License, Version 2.0, as
+ described in the file "LICENSE" included with the distribution.
+