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 2020/01/29 19:06:00 UTC
svn commit: r1873332 [16/17] - in /spamassassin/site/full/3.4.x: ./ doc/
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=1873332&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/sa-update.txt (added)
+++ spamassassin/site/full/3.4.x/doc/sa-update.txt Wed Jan 29 19:05:59 2020
@@ -0,0 +1,248 @@
+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", "file.sha256",
+ and "file.sha512".
+ --allowplugins Allow updates to load plugin code (DANGEROUS)
+ --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.004004)
+ --refreshmirrors Force the MIRRORED.BY file to be updated
+ --httputil util Force used download tool. By default first found
+ from these is used: curl, wget, fetch, lwp
+ -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 SHA256 and SHA512 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.sha256, file.sha512, and file.asc will be used for
+ the SHA256 and SHA512 hashes and the 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.
+
+ You should never enable this for 3rd party update channels, since
+ plugins can execute unrestricted code on your system, even possibly
+ as root! This includes spamassassin official updates, which have no
+ need to include running code.
+
+ Use --reallyallowplugins option to bypass warnings and make it work.
+
+ --gpg, --nogpg
+ sa-update by default will verify update archives by use of SHA256
+ and SHA512 checksums and GPG signature. SHA* 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.004004
+
+ 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>
+
+PREREQUISITES
+ "Mail::SpamAssassin"
+
+BUGS
+ See <http://issues.apache.org/SpamAssassin/>
+
+AUTHORS
+ The Apache SpamAssassin(tm) Project <https://spamassassin.apache.org/>
+
+LICENSE AND COPYRIGHT
+ SpamAssassin is distributed under the Apache License, Version 2.0, as
+ described in the file "LICENSE" included with the distribution.
+
+ Copyright (C) 2015 The Apache Software Foundation
+
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=1873332&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/spamassassin-run.html (added)
+++ spamassassin/site/full/3.4.x/doc/spamassassin-run.html Wed Jan 29 19:05:59 2020
@@ -0,0 +1,298 @@
+<?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></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">
+
+
+
+<ul id="index">
+ <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>
+
+<h1 id="NAME">NAME</h1>
+
+<p>spamassassin - simple front-end filtering script for SpamAssassin</p>
+
+<h1 id="SYNOPSIS">SYNOPSIS</h1>
+
+<p><b>spamassassin</b> [options] [ < <i>mailmessage</i> | <i>path</i> ... ]</p>
+
+<p><b>spamassassin</b> <b>-d</b> [ < <i>mailmessage</i> | <i>path</i> ... ]</p>
+
+<p><b>spamassassin</b> <b>-r</b> [ < <i>mailmessage</i> | <i>path</i> ... ]</p>
+
+<p><b>spamassassin</b> <b>-k</b> [ < <i>mailmessage</i> | <i>path</i> ... ]</p>
+
+<p><b>spamassassin</b> <b>-W</b>|<b>-R</b> [ < <i>mailmessage</i> | <i>path</i> ... ]</p>
+
+<p>Options:</p>
+
+<pre><code> -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</code></pre>
+
+<h1 id="DESCRIPTION">DESCRIPTION</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 <a>"TAGGING" in spamassassin</a>.</p>
+
+<p>By default, message(s) are read in from STDIN (< <i>mailmessage</i>), or from specified files and directories (<i>path</i> ...) STDIN and files are assumed to be in <i>file</i> 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 <i>--mbox</i> and <i>--mbx</i> 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>
+
+<h1 id="OPTIONS">OPTIONS</h1>
+
+<dl>
+
+<dt id="e---error-code---exit-code"><b>-e</b>, <b>--error-code</b>, <b>--exit-code</b></dt>
+<dd>
+
+<p>Exit with a non-zero error code, if the message is determined to be spam.</p>
+
+</dd>
+<dt id="h---help"><b>-h</b>, <b>--help</b></dt>
+<dd>
+
+<p>Print help message and exit.</p>
+
+</dd>
+<dt id="V---version"><b>-V</b>, <b>--version</b></dt>
+<dd>
+
+<p>Print version and exit.</p>
+
+</dd>
+<dt id="t---test-mode"><b>-t</b>, <b>--test-mode</b></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 <b>-d</b>, the message will first have SpamAssassin markup removed before being tested.</p>
+
+</dd>
+<dt id="r---report"><b>-r</b>, <b>--report</b></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>https://www.dcc-servers.net/dcc/</code>, Pyzor <code>http://pyzor.org/</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 <i>only</i> 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 id="k---revoke"><b>-k</b>, <b>--revoke</b></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 <i>only</i> 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 id="lint"><b>--lint</b></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 id="W---add-to-whitelist"><b>-W</b>, <b>--add-to-whitelist</b></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 id="add-to-blacklist"><b>--add-to-blacklist</b></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 id="R---remove-from-whitelist"><b>-R</b>, <b>--remove-from-whitelist</b></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 <b>--remove-addr-from-whitelist</b> 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 id="add-addr-to-whitelist"><b>--add-addr-to-whitelist</b></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 id="add-addr-to-blacklist"><b>--add-addr-to-blacklist</b></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 id="remove-addr-from-whitelist"><b>--remove-addr-from-whitelist</b></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 id="ipv4only---ipv4-only---ipv4"><b> --ipv4only</b>, <b>--ipv4-only</b>, <b>--ipv4</b></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 id="L---local"><b>-L</b>, <b>--local</b></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 <b>--local</b> is not used; it is recommended that the minimum limit on fds be raised to at least 256 for safety.</p>
+
+</dd>
+<dt id="d---remove-markup"><b>-d</b>, <b>--remove-markup</b></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 id="C-path---configpath-path---config-file-path"><b>-C</b> <i>path</i>, <b>--configpath</b>=<i>path</i>, <b>--config-file</b>=<i>path</i></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 id="siteconfigpath-path"><b>--siteconfigpath</b>=<i>path</i></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 id="cf-config-line"><b>--cf='config line'</b></dt>
+<dd>
+
+<p>Add additional lines of configuration directly from the command-line, parsed after the configuration files are read. Multiple <b>--cf</b> arguments can be used, and each will be considered a separate line of configuration. For example:</p>
+
+<pre><code> spamassassin -t --cf="body NEWRULE /text/" --cf="score NEWRULE 3.0"</code></pre>
+
+</dd>
+<dt id="p-prefs---prefspath-prefs---prefs-file-prefs"><b>-p</b> <i>prefs</i>, <b>--prefspath</b>=<i>prefs</i>, <b>--prefs-file</b>=<i>prefs</i></dt>
+<dd>
+
+<p>Read user score preferences from <i>prefs</i> (usually <code>$HOME/.spamassassin/user_prefs</code>).</p>
+
+</dd>
+<dt id="progress"><b>--progress</b></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 id="D-area-...---debug-area"><b>-D</b> [<i>area,...</i>], <b>--debug</b> [<i>area,...</i>]</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; <i>area</i> is the area of the code to instrument. For example, to produce diagnostic output on bayes, learn, and dns, use:</p>
+
+<pre><code> spamassassin -D bayes,learn,dns</code></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><code> L<http://wiki.apache.org/spamassassin/DebugChannels></code></pre>
+
+</dd>
+<dt id="x---nocreate-prefs"><b>-x</b>, <b>--nocreate-prefs</b></dt>
+<dd>
+
+<p>Disable creation of user preferences file.</p>
+
+</dd>
+<dt id="mbox"><b>--mbox</b></dt>
+<dd>
+
+<p>Specify that the input message(s) are in mbox format. mbox is a standard Unix message folder format.</p>
+
+</dd>
+<dt id="mbx"><b>--mbx</b></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>
+
+<h1 id="SEE-ALSO">SEE ALSO</h1>
+
+<p>sa-learn(1) spamd(1) spamc(1) Mail::SpamAssassin::Conf(3) Mail::SpamAssassin(3)</p>
+
+<h1 id="PREREQUISITES">PREREQUISITES</h1>
+
+<p><code>Mail::SpamAssassin</code></p>
+
+<h1 id="BUGS">BUGS</h1>
+
+<p>See <http://issues.apache.org/SpamAssassin/></p>
+
+<h1 id="AUTHORS">AUTHORS</h1>
+
+<p>The SpamAssassin(tm) Project <https://spamassassin.apache.org/></p>
+
+<h1 id="COPYRIGHT">COPYRIGHT</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=1873332&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/spamassassin-run.txt (added)
+++ spamassassin/site/full/3.4.x/doc/spamassassin-run.txt Wed Jan 29 19:05:59 2020
@@ -0,0 +1,275 @@
+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
+ "https://www.dcc-servers.net/dcc/", Pyzor "http://pyzor.org/",
+ 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 <https://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=1873332&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/spamassassin.html (added)
+++ spamassassin/site/full/3.4.x/doc/spamassassin.html Wed Jan 29 19:05:59 2020
@@ -0,0 +1,404 @@
+<?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></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">
+
+
+
+<ul id="index">
+ <li><a href="#NAME">NAME</a></li>
+ <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
+ <li><a href="#SYNOPSIS">SYNOPSIS</a>
+ <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>
+ <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>
+ <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>
+ <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-AND-LICENSE">COPYRIGHT AND LICENSE</a></li>
+</ul>
+
+<h1 id="NAME">NAME</h1>
+
+<p>spamassassin - extensible email filter used to identify spam</p>
+
+<h1 id="DESCRIPTION">DESCRIPTION</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>
+
+<h1 id="SYNOPSIS">SYNOPSIS</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 man(1) program or perldoc(1).</p>
+
+<h2 id="OVERVIEW">OVERVIEW</h2>
+
+<pre><code> spamassassin SpamAssassin overview (this section)</code></pre>
+
+<h2 id="CONFIGURATION">CONFIGURATION</h2>
+
+<pre><code> Mail::SpamAssassin::Conf SpamAssassin configuration files</code></pre>
+
+<h2 id="USAGE">USAGE</h2>
+
+<pre><code> 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)</code></pre>
+
+<h2 id="DEFAULT-PLUGINS">DEFAULT PLUGINS</h2>
+
+<pre><code> 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::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</code></pre>
+
+<h1 id="WEB-SITES">WEB SITES</h1>
+
+<pre><code> SpamAssassin web site: http://spamassassin.apache.org/
+ Wiki-based documentation: http://wiki.apache.org/spamassassin/</code></pre>
+
+<h1 id="USER-MAILING-LIST">USER MAILING LIST</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>
+
+<h1 id="CONFIGURATION-FILES">CONFIGURATION FILES</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 id="var-lib-spamassassin-3.004004">/var/lib/spamassassin/3.004004</dt>
+<dd>
+
+</dd>
+<dt id="usr-local-share-spamassassin">/usr/local/share/spamassassin</dt>
+<dd>
+
+</dd>
+<dt id="usr-local-share-spamassassin1">/usr/local/share/spamassassin</dt>
+<dd>
+
+</dd>
+<dt id="usr-local-share-spamassassin2">/usr/local/share/spamassassin</dt>
+<dd>
+
+</dd>
+<dt id="usr-share-spamassassin">/usr/share/spamassassin</dt>
+<dd>
+
+</dd>
+</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 id="etc-mail-spamassassin">/etc/mail/spamassassin</dt>
+<dd>
+
+</dd>
+<dt id="usr-local-etc-mail-spamassassin">/usr/local/etc/mail/spamassassin</dt>
+<dd>
+
+</dd>
+<dt id="usr-local-etc-spamassassin">/usr/local/etc/spamassassin</dt>
+<dd>
+
+</dd>
+<dt id="usr-local-etc-spamassassin1">/usr/local/etc/spamassassin</dt>
+<dd>
+
+</dd>
+<dt id="usr-pkg-etc-spamassassin">/usr/pkg/etc/spamassassin</dt>
+<dd>
+
+</dd>
+<dt id="usr-etc-spamassassin">/usr/etc/spamassassin</dt>
+<dd>
+
+</dd>
+<dt id="etc-mail-spamassassin1">/etc/mail/spamassassin</dt>
+<dd>
+
+</dd>
+<dt id="etc-spamassassin">/etc/spamassassin</dt>
+<dd>
+
+</dd>
+</dl>
+
+<p>From those 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 <i>init.pre</i> first, then <i>10_default_prefs.cf</i> before <i>50_scores.cf</i> and <i>20_body_tests.cf</i> before <i>20_head_tests.cf</i>. 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, <i>~/.spamassassin/user_prefs</i> is used if it exists. SpamAssassin will create that file if it does not already exist, using <i>user_prefs.template</i> as a template. That file will be looked for in:</p>
+
+<dl>
+
+<dt id="etc-mail-spamassassin2">/etc/mail/spamassassin</dt>
+<dd>
+
+</dd>
+<dt id="usr-local-etc-mail-spamassassin1">/usr/local/etc/mail/spamassassin</dt>
+<dd>
+
+</dd>
+<dt id="usr-local-share-spamassassin3">/usr/local/share/spamassassin</dt>
+<dd>
+
+</dd>
+<dt id="etc-spamassassin1">/etc/spamassassin</dt>
+<dd>
+
+</dd>
+<dt id="etc-mail-spamassassin3">/etc/mail/spamassassin</dt>
+<dd>
+
+</dd>
+<dt id="usr-local-share-spamassassin4">/usr/local/share/spamassassin</dt>
+<dd>
+
+</dd>
+<dt id="usr-share-spamassassin1">/usr/share/spamassassin</dt>
+<dd>
+
+</dd>
+</dl>
+
+<h1 id="TAGGING">TAGGING</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>
+
+<h2 id="TAGGING-FOR-SPAM-MAILS">TAGGING FOR SPAM MAILS</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 id="From:-header">From: header</dt>
+<dd>
+
+</dd>
+<dt id="To:-header">To: header</dt>
+<dd>
+
+</dd>
+<dt id="Cc:-header">Cc: header</dt>
+<dd>
+
+</dd>
+<dt id="Subject:-header">Subject: header</dt>
+<dd>
+
+</dd>
+<dt id="Date:-header">Date: header</dt>
+<dd>
+
+</dd>
+<dt id="Message-ID:-header">Message-ID: header</dt>
+<dd>
+
+</dd>
+</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 id="X-Spam-Flag:-header">X-Spam-Flag: header</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 id="spam-mail-body-text">spam mail body text</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>
+
+<h2 id="DEFAULT-TAGGING-FOR-ALL-MAILS">DEFAULT TAGGING FOR ALL MAILS</h2>
+
+<p>These headers are added to all messages, both spam and ham (non-spam).</p>
+
+<dl>
+
+<dt id="X-Spam-Checker-Version:-header">X-Spam-Checker-Version: header</dt>
+<dd>
+
+<p>The version and subversion of SpamAssassin and the host where SpamAssassin was run.</p>
+
+</dd>
+<dt id="X-Spam-Level:-header">X-Spam-Level: header</dt>
+<dd>
+
+<p>A series of "*" characters where each one represents a full score point.</p>
+
+</dd>
+<dt id="X-Spam-Status:-header">X-Spam-Status: header</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>
+
+<h1 id="INSTALLATION">INSTALLATION</h1>
+
+<p>The <b>spamassassin</b> command is part of the <b>Mail::SpamAssassin</b> 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>
+
+<h1 id="DEVELOPER-DOCUMENTATION">DEVELOPER DOCUMENTATION</h1>
+
+<pre><code> 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</code></pre>
+
+<h1 id="BUGS">BUGS</h1>
+
+<p>See <http://issues.apache.org/SpamAssassin/></p>
+
+<h1 id="AUTHORS">AUTHORS</h1>
+
+<p>The SpamAssassin(tm) Project <http://spamassassin.apache.org/></p>
+
+<h1 id="COPYRIGHT-AND-LICENSE">COPYRIGHT AND LICENSE</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>
+
+<p>Copyright (C) 2015 The Apache Software Foundation</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=1873332&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/spamassassin.txt (added)
+++ spamassassin/site/full/3.4.x/doc/spamassassin.txt Wed Jan 29 19:05:59 2020
@@ -0,0 +1,274 @@
+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::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.004004
+ /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 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 "*" characters 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 AND LICENSE
+ SpamAssassin is distributed under the Apache License, Version 2.0, as
+ described in the file "LICENSE" included with the distribution.
+
+ Copyright (C) 2015 The Apache Software Foundation
+
Added: spamassassin/site/full/3.4.x/doc/spamc.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/spamc.html?rev=1873332&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/spamc.html (added)
+++ spamassassin/site/full/3.4.x/doc/spamc.html Wed Jan 29 19:05:59 2020
@@ -0,0 +1,349 @@
+<?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></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">
+
+
+
+<ul id="index">
+ <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="#CONFIGURATION-FILE">CONFIGURATION FILE</a></li>
+ <li><a href="#EXIT-CODES">EXIT CODES</a></li>
+ <li><a href="#SEE-ALSO">SEE ALSO</a></li>
+ <li><a href="#PREREQUISITES">PREREQUISITES</a></li>
+ <li><a href="#AUTHORS">AUTHORS</a></li>
+ <li><a href="#COPYRIGHT">COPYRIGHT</a></li>
+</ul>
+
+<h1 id="NAME">NAME</h1>
+
+<p>spamc - client for spamd</p>
+
+<h1 id="SYNOPSIS">SYNOPSIS</h1>
+
+<dl>
+
+<dt id="spamc-options-message">spamc [options] < message</dt>
+<dd>
+
+</dd>
+</dl>
+
+<h1 id="DESCRIPTION">DESCRIPTION</h1>
+
+<p>Spamc is the client half of the spamc/spamd pair. It should be used in place of <code>spamassassin</code> in scripts to process mail. It will read the mail from STDIN, and spool it to its connection to spamd, then read the result back and print it to STDOUT. Spamc has extremely low overhead in loading, so it should be much faster to load than the whole spamassassin program.</p>
+
+<p>See the <i>README</i> file in the <i>spamd</i> directory of the SpamAssassin distribution for more details.</p>
+
+<h1 id="OPTIONS">OPTIONS</h1>
+
+<p>All options detailed below can be passed as command line arguments, or be contained in a configuration file, as described in the <b>CONFIGURATION FILE</b> section below.</p>
+
+<p>Note that the long options, a la <code>--long-options</code>, are new as of SpamAssassin 3.2.0, and were not available in earlier versions.</p>
+
+<dl>
+
+<dt id="B---bsmtp"><b>-B</b>, <b>--bsmtp</b></dt>
+<dd>
+
+<p>Assume input is a single BSMTP-formatted message. In other words, spamc will pull out everything between the DATA line and the lone-dot line to feed to spamd, and will place the spamd output back in the same envelope (thus, any SIZE extension in your BSMTP file will cause many problems).</p>
+
+</dd>
+<dt id="c---check"><b>-c</b>, <b>--check</b></dt>
+<dd>
+
+<p>Just check if the message is spam or not. Set process exitcode to 1 if message is spam, 0 if not spam or processing failure occurs. Will print score/threshold to stdout (as ints) or 0/0 if there was an error. Combining <b>-c</b> and <b>-E</b> is a no-op, since <b>-c</b> implies the behaviour of <b>-E</b>.</p>
+
+</dd>
+<dt id="d-host-host2---dest-host-host2"><b>-d</b> <i>host[,host2]</i>, <b>--dest</b>=<i>host[,host2]</i></dt>
+<dd>
+
+<p>In TCP/IP mode, connect to spamd server on given host (default: localhost). Several hosts can be specified if separated by commas.</p>
+
+<p>If <i>host</i> resolves to multiple addresses, then spamc will fail-over to the other addresses, if the first one cannot be connected to. It will first try all addresses of one host before it tries the next one in the list. Note that this fail-over behaviour is incompatible with <b>-x</b>; if that switch is used, fail-over will not occur.</p>
+
+</dd>
+<dt id="pod-4"><b>-4</b></dt>
+<dd>
+
+<p>Use IPv4 only for connecting to server. Restricts domain name resolution of spamd server host(s) to address family AF_INET through the <code>hints.ai_family</code> flag in the call to getaddrinfo(3).</p>
+
+</dd>
+<dt id="pod-6"><b>-6</b></dt>
+<dd>
+
+<p>Use IPv6 only for connecting to server. Restricts domain name resolution of spamd server host(s) to address family AF_INET6 through the <code>hints.ai_family</code> flag in the call to getaddrinfo(3).</p>
+
+</dd>
+<dt id="e-command-args---pipe-to-command-args"><b>-e</b> <i>command</i> <i>[args]</i>, <b>--pipe-to</b> <i>command</i> <i>[args]</i></dt>
+<dd>
+
+<p>Instead of writing to stdout, pipe the output to <i>command</i>'s standard input. Note that there is a very slight chance mail will be lost here, because if the fork-and-exec fails there's no place to put the mail message.</p>
+
+<p>Note that this must be the LAST command line option, as everything after the <b>-e</b> is taken as arguments to the command (it's like <i>rxvt</i> or <i>xterm</i>).</p>
+
+<p>This option is not supported on Win32 platforms.</p>
+
+</dd>
+<dt id="E---exitcode"><b>-E</b>, <b>--exitcode</b></dt>
+<dd>
+
+<p>Filter according to the other options, but set the process exitcode to 1 if message is spam, 0 if not spam or processing failure occurs.</p>
+
+</dd>
+<dt id="F-path-to-file---config-path"><b>-F</b> <i>/path/to/file</i>, <b>--config</b>=<i>path</i></dt>
+<dd>
+
+<p>Specify a configuration file to read additional command-line flags from. See <b>CONFIGURATION FILE</b> below.</p>
+
+</dd>
+<dt id="h---help"><b>-h</b>, <b>--help</b></dt>
+<dd>
+
+<p>Print this help message and terminate without action.</p>
+
+</dd>
+<dt id="H---randomize"><b>-H</b>, <b>--randomize</b></dt>
+<dd>
+
+<p>For TCP/IP sockets, randomize the IP addresses returned for the hosts given by the <b>-d</b> switch. This provides for a simple kind of load balancing. It will try only three times though.</p>
+
+</dd>
+<dt id="l---log-to-stderr"><b>-l</b>, <b>--log-to-stderr</b></dt>
+<dd>
+
+<p>Send log messages to stderr, instead of to the syslog.</p>
+
+</dd>
+<dt id="L-learn-type---learntype-type"><b>-L</b> <i>learn type</i>, <b>--learntype</b>=<i>type</i></dt>
+<dd>
+
+<p>Send message to spamd for learning. The <code>learn type</code> can be either spam, ham or forget. The exitcode for spamc will be set to 5 if the message was learned, or 6 if it was already learned, under a condition that a <b>--no-safe-fallback</b> option is selected too.</p>
+
+<p>Note that the <code>spamd</code> must run with the <code>--allow-tell</code> option for this to work.</p>
+
+</dd>
+<dt id="C-report-type---reporttype-type"><b>-C</b> <i>report type</i>, <b>--reporttype</b>=<i>type</i></dt>
+<dd>
+
+<p>Report or revoke a message to one of the configured collaborative filtering databases. The <code>report type</code> can be either report or revoke.</p>
+
+<p>Note that the <code>spamd</code> must run with the <code>--allow-tell</code> option for this to work.</p>
+
+</dd>
+<dt id="p-port---port-port"><b>-p</b> <i>port</i>, <b>--port</b>=<i>port</i></dt>
+<dd>
+
+<p>In TCP/IP mode, connect to spamd server listening on given port (default: 783).</p>
+
+</dd>
+<dt id="r---full-spam"><b>-r</b>, <b>--full-spam</b></dt>
+<dd>
+
+<p>Just output the SpamAssassin report text to stdout, if the message is spam. If the message is ham (non-spam), nothing will be printed. The first line of the output is the message score and the threshold, in this format:</p>
+
+<pre><code> score/threshold</code></pre>
+
+</dd>
+<dt id="R---full"><b>-R</b>, <b>--full</b></dt>
+<dd>
+
+<p>Just output the SpamAssassin report text to stdout, for all messages. See <b>-r</b> for details of the output format used.</p>
+
+</dd>
+<dt id="s-max_size---max-size-max_size"><b>-s</b> <i>max_size</i>, <b>--max-size</b>=<i>max_size</i></dt>
+<dd>
+
+<p>Set the maximum message size which will be sent to spamd -- any bigger than this threshold and the message will be returned unprocessed (default: 500 KB). If spamc gets handed a message bigger than this, it won't be passed to spamd. The maximum message size is 256 MB.</p>
+
+<p>The size is specified in bytes, as a positive integer greater than 0. For example, <b>-s 500000</b>.</p>
+
+</dd>
+<dt id="connect-retries-retries"><b>--connect-retries</b>=<i>retries</i></dt>
+<dd>
+
+<p>Retry connecting to spamd <i>retries</i> times. The default is 3 times.</p>
+
+</dd>
+<dt id="retry-sleep-sleep"><b>--retry-sleep</b>=<i>sleep</i></dt>
+<dd>
+
+<p>Sleep for <i>sleep</i> seconds between attempts to connect to spamd. The default is 1 second.</p>
+
+</dd>
+<dt id="filter-retries-retries"><b>--filter-retries</b>=<i>retries</i></dt>
+<dd>
+
+<p>Retry filtering <i>retries</i> times if the spamd process fails (usually times out). This differs from <b>--connect-retries</b> in that it times out the transaction after the TCP connection has been established successfully. The default is 1 time (ie. one attempt and no retries).</p>
+
+</dd>
+<dt id="filter-retry-sleep-sleep"><b>--filter-retry-sleep</b>=<i>sleep</i></dt>
+<dd>
+
+<p>Sleep for <i>sleep</i> seconds between failed spamd filtering attempts. The default is 1 second.</p>
+
+</dd>
+<dt id="S---ssl---ssl"><b>-S</b>, <b>--ssl</b>, <b>--ssl</b></dt>
+<dd>
+
+<p>If spamc was built with support for SSL, encrypt data to and from the spamd process with SSL; spamd must support SSL as well.</p>
+
+</dd>
+<dt id="t-timeout---timeout-timeout"><b>-t</b> <i>timeout</i>, <b>--timeout</b>=<i>timeout</i></dt>
+<dd>
+
+<p>Set the timeout for spamc-to-spamd communications (default: 600, 0 disables). If spamd takes longer than this many seconds to reply to a message, spamc will abort the connection and treat this as a failure to connect; in other words the message will be returned unprocessed.</p>
+
+</dd>
+<dt id="n-timeout---connect-timeout-timeout"><b>-n</b> <i>timeout</i>, <b>--connect-timeout</b>=<i>timeout</i></dt>
+<dd>
+
+<p>Set the timeout for spamc-to-spamd connection establishment (default: 600, 0 disables). If spamc takes longer than this many seconds to establish a connection to spamd, spamc will abort the connection and treat this as a failure to connect; in other words the message will be returned unprocessed.</p>
+
+</dd>
+<dt id="u-username---username-username"><b>-u</b> <i>username</i>, <b>--username</b>=<i>username</i></dt>
+<dd>
+
+<p>To have spamd use per-user-config files, run spamc as the user whose config files spamd should load; by default the effective user-ID is sent to spamd. If you're running spamc as some other user, though, (eg. root, mail, nobody, cyrus, etc.) then you may use this flag to override the default.</p>
+
+</dd>
+<dt id="U-socketpath---socket-path"><b>-U</b> <i>socketpath</i>, <b>--socket</b>=<i>path</i></dt>
+<dd>
+
+<p>Connect to <code>spamd</code> via UNIX domain socket <i>socketpath</i> instead of a TCP/IP connection.</p>
+
+<p>This option is not supported on Win32 platforms.</p>
+
+</dd>
+<dt id="V---version"><b>-V</b>, <b>--version</b></dt>
+<dd>
+
+<p>Report the version of this <code>spamc</code> client. If built with SSL support, an additional line will be included noting this, like so:</p>
+
+<pre><code> SpamAssassin Client version 3.0.0-rc4
+ compiled with SSL support (OpenSSL 0.9.7d 17 Mar 2004)</code></pre>
+
+</dd>
+<dt id="x---no-safe-fallback"><b>-x</b>, <b>--no-safe-fallback</b></dt>
+<dd>
+
+<p>Disables the 'safe fallback' error-recovery method, which passes through the unaltered message if an error occurs. Instead, exit with an error code, and let the MTA queue up the mails for a retry later. See also <a href="#EXIT-CODES">"EXIT CODES"</a>.</p>
+
+<p>This also disables the TCP fail-over behaviour from <b>-d</b>.</p>
+
+</dd>
+<dt id="X---unavailable-tempfail"><b>-X</b>, <b>--unavailable-tempfail</b></dt>
+<dd>
+
+<p>When disabling 'safe fallback' with <b>-x</b>, this option will turn EX_UNAVAILABLE errors into EX_TEMPFAIL. This may allow your MTA to defer mails with a temporary SMTP error instead of bouncing them with a permanent SMTP error. See also <a href="#EXIT-CODES">"EXIT CODES"</a>.</p>
+
+</dd>
+<dt id="y---tests"><b>-y</b>, <b>--tests</b></dt>
+<dd>
+
+<p>Just output the names of the tests hit to stdout, on one line, separated by commas.</p>
+
+</dd>
+<dt id="K"><b>-K</b></dt>
+<dd>
+
+<p>Perform a keep-alive check of spamd, instead of a full message check.</p>
+
+</dd>
+<dt id="z"><b>-z</b></dt>
+<dd>
+
+<p>Use gzip compression to compress the mail message sent to <code>spamd</code>. This is useful for long-distance use of spamc over the internet. Note that this relies on <code>zlib</code> being installed on the <code>spamc</code> client side, and the <code>Compress::Zlib</code> perl module on the server side; an error will be returned otherwise.</p>
+
+</dd>
+<dt id="headers"><b>--headers</b></dt>
+<dd>
+
+<p>Perform a scan, but instead of allowing any part of the message (header and body) to be rewritten, limit rewriting to only the message headers. This is much more efficient in bandwidth usage, since the response message transmitted back from the spamd server will not include the body.</p>
+
+<p>Note that this only makes sense if you are using <code>report_safe 0</code> in the scanning configuration on the remote end; with <code>report_safe 1</code>, it is likely to result in corrupt messages.</p>
+
+</dd>
+</dl>
+
+<h1 id="CONFIGURATION-FILE">CONFIGURATION FILE</h1>
+
+<p>The above command-line switches can also be loaded from a configuration file.</p>
+
+<p>The format of the file is similar to the SpamAssassin rules files; blank lines and lines beginning with <code>#</code> are ignored. Any space-separated words are considered additions to the command line, and are prepended. Newlines are treated as equivalent to spaces. Existing command line switches will override any settings in the configuration file.</p>
+
+<p>If the <b>-F</b> switch is specified, that file will be used. Otherwise, <code>spamc</code> will attempt to load spamc.conf in <code>SYSCONFDIR</code> (default: /etc/mail/spamassassin). If that file doesn't exist, and the <b>-F</b> switch is not specified, no configuration file will be read.</p>
+
+<p>Example:</p>
+
+<pre><code> # spamc global configuration file
+
+ # connect to "server.example.com", port 783
+ -d server.example.com
+ -p 783
+
+ # max message size for scanning = 350k
+ -s 350000</code></pre>
+
+<h1 id="EXIT-CODES">EXIT CODES</h1>
+
+<p>By default, spamc will use the 'safe fallback' error recovery method. That means, it will always exit with an exit code of <code>0</code>, even if an error was encountered. If any error occurs, it will simply pass through the unaltered message.</p>
+
+<p>The <b>-c</b> and <b>-E</b> options modify this; instead, spamc will use an exit code of <code>1</code> if the message is determined to be spam.</p>
+
+<p>If one of the <code>-x</code>, <code>-L</code> or <code>-C</code> options are specified, 'safe fallback' will be disabled, and certain error conditions related to communication between spamc and spamd will result in an error code.</p>
+
+<p>The exit codes used are as follows:</p>
+
+<pre><code> EX_USAGE 64 command line usage error
+ EX_DATAERR 65 data format error
+ EX_NOINPUT 66 cannot open input
+ EX_NOUSER 67 addressee unknown
+ EX_NOHOST 68 host name unknown
+ EX_UNAVAILABLE 69 service unavailable
+ EX_SOFTWARE 70 internal software error
+ EX_OSERR 71 system error (e.g., can't fork)
+ EX_OSFILE 72 critical OS file missing
+ EX_CANTCREAT 73 can't create (user) output file
+ EX_IOERR 74 input/output error
+ EX_TEMPFAIL 75 temp failure; user is invited to retry
+ EX_PROTOCOL 76 remote error in protocol
+ EX_NOPERM 77 permission denied
+ EX_CONFIG 78 configuration error
+
+ * The EX_TOOBIG error level is never used. If spamc receives a message
+ that is too big, the exit code will be 0.
+
+ EX_TOOBIG 98 message was too big to process (see --max-size)</code></pre>
+
+<h1 id="SEE-ALSO">SEE ALSO</h1>
+
+<p>spamd(1) spamassassin(1) Mail::SpamAssassin(3)</p>
+
+<h1 id="PREREQUISITES">PREREQUISITES</h1>
+
+<p><code>Mail::SpamAssassin</code></p>
+
+<h1 id="AUTHORS">AUTHORS</h1>
+
+<p>The SpamAssassin(tm) Project <https://spamassassin.apache.org/></p>
+
+<h1 id="COPYRIGHT">COPYRIGHT</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>
+
+