You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spamassassin.apache.org by jm...@apache.org on 2007/07/25 14:52:48 UTC
svn commit: r559437 [12/13] - in /spamassassin/site/full/3.2.x: ./ doc/
Added: spamassassin/site/full/3.2.x/doc/spamassassin-run.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/spamassassin-run.html?view=auto&rev=559437
==============================================================================
--- spamassassin/site/full/3.2.x/doc/spamassassin-run.html (added)
+++ spamassassin/site/full/3.2.x/doc/spamassassin-run.html Wed Jul 25 05:52:42 2007
@@ -0,0 +1,402 @@
+<!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>
+<link rev="made" href="mailto:jm@apache.org" />
+</head>
+
+<body style="background-color: white">
+
+<p><a name="__index__"></a></p>
+<!-- INDEX BEGIN -->
+
+<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>
+<!-- INDEX END -->
+
+<hr />
+<p>
+</p>
+<hr />
+<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
+ --ipv4only, --ipv4-only, --ipv4 Disable attempted use of ipv6 for DNS
+ --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 <a href="#tagging">TAGGING</a>.</p>
+<p>By default, <code>message(s)</code> 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="item__2de_2c__2d_2derror_2dcode_2c__2d_2dexit_2dcode"><strong>-e</strong>, <strong>--error-code</strong>, <strong>--exit-code</strong></a></strong><br />
+</dt>
+<dd>
+Exit with a non-zero error code, if the message is determined to be
+spam.
+</dd>
+<p></p>
+<dt><strong><a name="item__2dh_2c__2d_2dhelp"><strong>-h</strong>, <strong>--help</strong></a></strong><br />
+</dt>
+<dd>
+Print help message and exit.
+</dd>
+<p></p>
+<dt><strong><a name="item__2dv_2c__2d_2dversion"><strong>-V</strong>, <strong>--version</strong></a></strong><br />
+</dt>
+<dd>
+Print version and exit.
+</dd>
+<p></p>
+<dt><strong><a name="item__2dt_2c__2d_2dtest_2dmode"><strong>-t</strong>, <strong>--test-mode</strong></a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<dd>
+<p>If you run this with <strong>-d</strong>, the message will first have SpamAssassin
+markup removed before being tested.</p>
+</dd>
+<p></p>
+<dt><strong><a name="item__2dr_2c__2d_2dreport"><strong>-r</strong>, <strong>--report</strong></a></strong><br />
+</dt>
+<dd>
+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.rhyolite.com/anti-spam/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>.
+</dd>
+<dd>
+<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>
+</dd>
+<dd>
+<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>
+<p></p>
+<dt><strong><a name="item__2dk_2c__2d_2drevoke"><strong>-k</strong>, <strong>--revoke</strong></a></strong><br />
+</dt>
+<dd>
+Revoke this message. This will revoke the mail message read from STDIN from
+various spam-blocker databases. Currently, these are Vipul's Razor.
+</dd>
+<dd>
+<p>Revocation support for the Distributed Checksum Clearinghouse, Pyzor, and
+SpamCop is not currently available.</p>
+</dd>
+<dd>
+<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>
+</dd>
+<dd>
+<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>
+<p></p>
+<dt><strong><a name="item__2d_2dlint"><strong>--lint</strong></a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<p></p>
+<dt><strong><a name="item__2dw_2c__2d_2dadd_2dto_2dwhitelist"><strong>-W</strong>, <strong>--add-to-whitelist</strong></a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<p></p>
+<dt><strong><a name="item__2d_2dadd_2dto_2dblacklist"><strong>--add-to-blacklist</strong></a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<p></p>
+<dt><strong><a name="item__2dr_2c__2d_2dremove_2dfrom_2dwhitelist"><strong>-R</strong>, <strong>--remove-from-whitelist</strong></a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<dd>
+<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>
+<p></p>
+<dt><strong><a name="item__2d_2dadd_2daddr_2dto_2dwhitelist"><strong>--add-addr-to-whitelist</strong></a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<p></p>
+<dt><strong><a name="item__2d_2dadd_2daddr_2dto_2dblacklist"><strong>--add-addr-to-blacklist</strong></a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<p></p>
+<dt><strong><a name="item__2d_2dremove_2daddr_2dfrom_2dwhitelist"><strong>--remove-addr-from-whitelist</strong></a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<p></p>
+<dt><strong><a name="item___2d_2dipv4only_2c__2d_2dipv4_2donly_2c__2d_2dipv4"><strong> --ipv4only</strong>, <strong>--ipv4-only</strong>, <strong>--ipv4</strong></a></strong><br />
+</dt>
+<dd>
+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 availablity produce incorrect results or crashes.
+</dd>
+<p></p>
+<dt><strong><a name="item__2dl_2c__2d_2dlocal"><strong>-L</strong>, <strong>--local</strong></a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<dd>
+<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>
+<p></p>
+<dt><strong><a name="item__2dd_2c__2d_2dremove_2dmarkup"><strong>-d</strong>, <strong>--remove-markup</strong></a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<dd>
+<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>
+<p></p>
+<dt><strong><a name="item__2dc_path_2c__2d_2dconfigpath_3dpath_2c__2d_2dconf"><strong>-C</strong> <em>path</em>, <strong>--configpath</strong>=<em>path</em>, <strong>--config-file</strong>=<em>path</em></a></strong><br />
+</dt>
+<dd>
+Use the specified path for locating the distributed configuration files.
+Ignore the default directories (usually <code>/usr/share/spamassassin</code> or similar).
+</dd>
+<p></p>
+<dt><strong><a name="item__2d_2dsiteconfigpath_3dpath"><strong>--siteconfigpath</strong>=<em>path</em></a></strong><br />
+</dt>
+<dd>
+Use the specified path for locating site-specific configuration files. Ignore
+the default directories (usually <code>/etc/mail/spamassassin</code> or similar).
+</dd>
+<p></p>
+<dt><strong><a name="item__2d_2dcf_3d_27config_line_27"><strong>--cf='config line'</strong></a></strong><br />
+</dt>
+<dd>
+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:
+</dd>
+<dd>
+<pre>
+ spamassassin -t --cf="body NEWRULE /text/" --cf="score NEWRULE 3.0"</pre>
+</dd>
+<p></p>
+<dt><strong><a name="item__2dp_prefs_2c__2d_2dprefspath_3dprefs_2c__2d_2dpre"><strong>-p</strong> <em>prefs</em>, <strong>--prefspath</strong>=<em>prefs</em>, <strong>--prefs-file</strong>=<em>prefs</em></a></strong><br />
+</dt>
+<dd>
+Read user score preferences from <em>prefs</em> (usually <code>$HOME/.spamassassin/user_prefs</code>).
+</dd>
+<p></p>
+<dt><strong><a name="item__2d_2dprogress"><strong>--progress</strong></a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<p></p>
+<dt><strong><a name="item__2dd__5barea_2c_2e_2e_2e_5d_2c__2d_2ddebug__5barea"><strong>-D</strong> [<em>area,...</em>], <strong>--debug</strong> [<em>area,...</em>]</a></strong><br />
+</dt>
+<dd>
+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:
+</dd>
+<dd>
+<pre>
+ spamassassin -D bayes,learn,dns</pre>
+</dd>
+<dd>
+<p>Higher priority informational messages that are suitable for logging in normal
+circumstances are available with an area of ``info''.</p>
+</dd>
+<dd>
+<p>For more information about which areas (also known as channels) are available,
+please see the documentation at:</p>
+</dd>
+<dd>
+<pre>
+ C<<a href="http://wiki.apache.org/spamassassin/DebugChannels>">http://wiki.apache.org/spamassassin/DebugChannels></a>;</pre>
+</dd>
+<p></p>
+<dt><strong><a name="item__2dx_2c__2d_2dnocreate_2dprefs"><strong>-x</strong>, <strong>--nocreate-prefs</strong></a></strong><br />
+</dt>
+<dd>
+Disable creation of user preferences file.
+</dd>
+<p></p>
+<dt><strong><a name="item__2d_2dmbox"><strong>--mbox</strong></a></strong><br />
+</dt>
+<dd>
+Specify that the input <code>message(s)</code> are in mbox format. mbox is a standard
+Unix message folder format.
+</dd>
+<p></p>
+<dt><strong><a name="item__2d_2dmbx"><strong>--mbx</strong></a></strong><br />
+</dt>
+<dd>
+Specify that the input <code>message(s)</code> 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>.
+</dd>
+<p></p></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 <code>SpamAssassin(tm)</code> 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.2.x/doc/spamassassin-run.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/spamassassin-run.txt?view=auto&rev=559437
==============================================================================
--- spamassassin/site/full/3.2.x/doc/spamassassin-run.txt (added)
+++ spamassassin/site/full/3.2.x/doc/spamassassin-run.txt Wed Jul 25 05:52:42 2007
@@ -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
+ --ipv4only, --ipv4-only, --ipv4 Disable attempted use of ipv6 for DNS
+ --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".
+
+ 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.rhyolite.com/anti-spam/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 availablity 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:
+
+ C<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.2.x/doc/spamassassin.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/spamassassin.html?view=auto&rev=559437
==============================================================================
--- spamassassin/site/full/3.2.x/doc/spamassassin.html (added)
+++ spamassassin/site/full/3.2.x/doc/spamassassin.html Wed Jul 25 05:52:42 2007
@@ -0,0 +1,363 @@
+<!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>
+<link rev="made" href="mailto:jm@apache.org" />
+</head>
+
+<body style="background-color: white">
+
+<p><a name="__index__"></a></p>
+<!-- INDEX BEGIN -->
+
+<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>
+<!-- INDEX END -->
+
+<hr />
+<p>
+</p>
+<hr />
+<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 perldoc(1).</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::Hashcash
+ Mail::SpamAssassin::Plugin::SPF
+ Mail::SpamAssassin::Plugin::URIDNSBL</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="item__2fhome_2fjm_2fperl584_2fvar_2fspamassassin_2f3_2e">/home/jm/perl584/var/spamassassin/3.002003</a></strong><br />
+</dt>
+<dt><strong><a name="item__2fhome_2fjm_2fperl584_2fshare_2fspamassassin">/home/jm/perl584/share/spamassassin</a></strong><br />
+</dt>
+<dt><strong>/home/jm/perl584/share/spamassassin</strong><br />
+</dt>
+<dt><strong><a name="item__2fusr_2flocal_2fshare_2fspamassassin">/usr/local/share/spamassassin</a></strong><br />
+</dt>
+<dt><strong><a name="item__2fusr_2fshare_2fspamassassin">/usr/share/spamassassin</a></strong><br />
+</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="item__2fhome_2fjm_2fperl584_2fetc_2fmail_2fspamassassin">/home/jm/perl584/etc/mail/spamassassin</a></strong><br />
+</dt>
+<dt><strong>/home/jm/perl584/etc/mail/spamassassin</strong><br />
+</dt>
+<dt><strong><a name="item__2fhome_2fjm_2fperl584_2fetc_2fspamassassin">/home/jm/perl584/etc/spamassassin</a></strong><br />
+</dt>
+<dt><strong><a name="item__2fusr_2flocal_2fetc_2fspamassassin">/usr/local/etc/spamassassin</a></strong><br />
+</dt>
+<dt><strong><a name="item__2fusr_2fpkg_2fetc_2fspamassassin">/usr/pkg/etc/spamassassin</a></strong><br />
+</dt>
+<dt><strong><a name="item__2fusr_2fetc_2fspamassassin">/usr/etc/spamassassin</a></strong><br />
+</dt>
+<dt><strong><a name="item__2fetc_2fmail_2fspamassassin">/etc/mail/spamassassin</a></strong><br />
+</dt>
+<dt><strong><a name="item__2fetc_2fspamassassin">/etc/spamassassin</a></strong><br />
+</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>init.pre</em> first, then <em>10_default_prefs.cf</em> before
+<em>50_scores.cf</em> and <em>20_body_tests.cf</em> before <em>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>~/.spamassassin/user_prefs</em> is used if it exists. SpamAssassin will
+create that file if it does not already exist, using
+<em>user_prefs.template</em> as a template. That file will be looked for in:</p>
+<dl>
+<dt><strong>/home/jm/perl584/etc/mail/spamassassin</strong><br />
+</dt>
+<dt><strong>/home/jm/perl584/etc/mail/spamassassin</strong><br />
+</dt>
+<dt><strong>/home/jm/perl584/share/spamassassin</strong><br />
+</dt>
+<dt><strong>/etc/spamassassin</strong><br />
+</dt>
+<dt><strong>/etc/mail/spamassassin</strong><br />
+</dt>
+<dt><strong>/usr/local/share/spamassassin</strong><br />
+</dt>
+<dt><strong>/usr/share/spamassassin</strong><br />
+</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="item_from_3a_header">From: header</a></strong><br />
+</dt>
+<dt><strong><a name="item_to_3a_header">To: header</a></strong><br />
+</dt>
+<dt><strong><a name="item_cc_3a_header">Cc: header</a></strong><br />
+</dt>
+<dt><strong><a name="item_subject_3a_header">Subject: header</a></strong><br />
+</dt>
+<dt><strong><a name="item_date_3a_header">Date: header</a></strong><br />
+</dt>
+<dt><strong><a name="item_message_2did_3a_header">Message-ID: header</a></strong><br />
+</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="item_x_2dspam_2dflag_3a_header">X-Spam-Flag: header</a></strong><br />
+</dt>
+<dd>
+Set to <code>YES</code>.
+</dd>
+<p></p></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="item_spam_mail_body_text">spam mail body text</a></strong><br />
+</dt>
+<dd>
+The SpamAssassin report is added to top of the mail message body,
+if the message is marked as spam.
+</dd>
+<p></p></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="item_x_2dspam_2dchecker_2dversion_3a_header">X-Spam-Checker-Version: header</a></strong><br />
+</dt>
+<dd>
+The version and subversion of SpamAssassin and the host where
+SpamAssassin was run.
+</dd>
+<p></p>
+<dt><strong><a name="item_x_2dspam_2dlevel_3a_header">X-Spam-Level: header</a></strong><br />
+</dt>
+<dd>
+A series of ``*'' charactes where each one represents a full score point.
+</dd>
+<p></p>
+<dt><strong><a name="item_x_2dspam_2dstatus_3a_header">X-Spam-Status: header</a></strong><br />
+</dt>
+<dd>
+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).
+</dd>
+<p></p></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 <code>SpamAssassin(tm)</code> 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.2.x/doc/spamassassin.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/spamassassin.txt?view=auto&rev=559437
==============================================================================
--- spamassassin/site/full/3.2.x/doc/spamassassin.txt (added)
+++ spamassassin/site/full/3.2.x/doc/spamassassin.txt Wed Jul 25 05:52:42 2007
@@ -0,0 +1,249 @@
+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::Hashcash
+ Mail::SpamAssassin::Plugin::SPF
+ Mail::SpamAssassin::Plugin::URIDNSBL
+
+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:
+
+ /home/jm/perl584/var/spamassassin/3.002003
+ /home/jm/perl584/share/spamassassin
+ /home/jm/perl584/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:
+
+ /home/jm/perl584/etc/mail/spamassassin
+ /home/jm/perl584/etc/mail/spamassassin
+ /home/jm/perl584/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:
+
+ /home/jm/perl584/etc/mail/spamassassin
+ /home/jm/perl584/etc/mail/spamassassin
+ /home/jm/perl584/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.
+
Added: spamassassin/site/full/3.2.x/doc/spamc.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/spamc.html?view=auto&rev=559437
==============================================================================
--- spamassassin/site/full/3.2.x/doc/spamc.html (added)
+++ spamassassin/site/full/3.2.x/doc/spamc.html Wed Jul 25 05:52:42 2007
@@ -0,0 +1,400 @@
+<!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>spamc - client for spamd</title>
+<link rev="made" href="mailto:jm@apache.org" />
+</head>
+
+<body style="background-color: white">
+
+<p><a name="__index__"></a></p>
+<!-- INDEX BEGIN -->
+
+<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="#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>
+<!-- INDEX END -->
+
+<hr />
+<p>
+</p>
+<hr />
+<h1><a name="name">NAME</a></h1>
+<p>spamc - client for spamd</p>
+<p>
+</p>
+<hr />
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+<dl>
+<dt><strong><a name="item_spamc__5boptions_5d__3c_message">spamc [options] < message</a></strong><br />
+</dt>
+</dl>
+<p>
+</p>
+<hr />
+<h1><a name="description">DESCRIPTION</a></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 <em>README</em> file in the <em>spamd</em> directory of the SpamAssassin
+distribution for more details.</p>
+<p>
+</p>
+<hr />
+<h1><a name="options">OPTIONS</a></h1>
+<p>All options detailed below can be passed as command line arguments, or be
+contained in a configuration file, as described in the <strong>CONFIGURATION FILE</strong>
+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><strong><a name="item__2db_2c__2d_2dbsmtp"><strong>-B</strong>, <strong>--bsmtp</strong></a></strong><br />
+</dt>
+<dd>
+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).
+</dd>
+<p></p>
+<dt><strong><a name="item__2dc_2c__2d_2dcheck"><strong>-c</strong>, <strong>--check</strong></a></strong><br />
+</dt>
+<dd>
+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 <strong>-c</strong> and <strong>-E</strong> is a no-op, since <strong>-c</strong> implies the behaviour
+of <strong>-E</strong>.
+</dd>
+<p></p>
+<dt><strong><a name="item__2dd_host_5b_2chost2_5d_2c__2d_2ddest_3dhost_5b_2c"><strong>-d</strong> <em>host[,host2]</em>, <strong>--dest</strong>=<em>host[,host2]</em></a></strong><br />
+</dt>
+<dd>
+In TCP/IP mode, connect to spamd server on given host (default: localhost).
+Several hosts can be specified if separated by commas.
+</dd>
+<dd>
+<p>If <em>host</em> 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 <strong>-x</strong>; if that
+switch is used, fail-over will not occur.</p>
+</dd>
+<p></p>
+<dt><strong><a name="item__2de_command__5bargs_5d_2c__2d_2dpipe_2dto_command"><strong>-e</strong> <em>command</em> <em>[args]</em>, <strong>--pipe-to</strong> <em>command</em> <em>[args]</em></a></strong><br />
+</dt>
+<dd>
+Instead of writing to stdout, pipe the output to <em>command</em>'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.
+</dd>
+<dd>
+<p>Note that this must be the LAST command line option, as everything after the
+<strong>-e</strong> is taken as arguments to the command (it's like <em>rxvt</em> or <em>xterm</em>).</p>
+</dd>
+<dd>
+<p>This option is not supported on Win32 platforms.</p>
+</dd>
+<p></p>
+<dt><strong><a name="item__2de_2c__2d_2dexitcode"><strong>-E</strong>, <strong>--exitcode</strong></a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<p></p>
+<dt><strong><a name="item__2df__2fpath_2fto_2ffile_2c__2d_2dconfig_3dpath"><strong>-F</strong> <em>/path/to/file</em>, <strong>--config</strong>=<em>path</em></a></strong><br />
+</dt>
+<dd>
+Specify a configuration file to read additional command-line flags from.
+See <strong>CONFIGURATION FILE</strong> below.
+</dd>
+<p></p>
+<dt><strong><a name="item__2dh_2c__2d_2dhelp"><strong>-h</strong>, <strong>--help</strong></a></strong><br />
+</dt>
+<dd>
+Print this help message and terminate without action.
+</dd>
+<p></p>
+<dt><strong><a name="item__2dh_2c__2d_2drandomize"><strong>-H</strong>, <strong>--randomize</strong></a></strong><br />
+</dt>
+<dd>
+For TCP/IP sockets, randomize the IP addresses returned for the hosts given
+by the <strong>-d</strong> switch. This provides for a simple kind of load balancing. It
+will try only three times though.
+</dd>
+<p></p>
+<dt><strong><a name="item__2dl_2c__2d_2dlog_2dto_2dstderr"><strong>-l</strong>, <strong>--log-to-stderr</strong></a></strong><br />
+</dt>
+<dd>
+Send log messages to stderr, instead of to the syslog.
+</dd>
+<p></p>
+<dt><strong><a name="item__2dl_learn_type_2c__2d_2dlearntype_3dtype"><strong>-L</strong> <em>learn type</em>, <strong>--learntype</strong>=<em>type</em></a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<dd>
+<p>Note that the <code>spamd</code> must run with the <code>--allow-tell</code> option for
+this to work.</p>
+</dd>
+<p></p>
+<dt><strong><a name="item__2dc_report_type_2c__2d_2dreporttype_3dtype"><strong>-C</strong> <em>report type</em>, <strong>--reporttype</strong>=<em>type</em></a></strong><br />
+</dt>
+<dd>
+Report or revoke a message to one of the configured collaborative filtering
+databases. The <code>report type</code> can be either report or revoke.
+</dd>
+<dd>
+<p>Note that the <code>spamd</code> must run with the <code>--allow-tell</code> option for
+this to work.</p>
+</dd>
+<p></p>
+<dt><strong><a name="item__2dp_port_2c__2d_2dport_3dport"><strong>-p</strong> <em>port</em>, <strong>--port</strong>=<em>port</em></a></strong><br />
+</dt>
+<dd>
+In TCP/IP mode, connect to spamd server listening on given port
+(default: 783).
+</dd>
+<p></p>
+<dt><strong><a name="item__2dr_2c__2d_2dfull_2dspam"><strong>-r</strong>, <strong>--full-spam</strong></a></strong><br />
+</dt>
+<dd>
+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:
+</dd>
+<dd>
+<pre>
+ score/threshold</pre>
+</dd>
+<p></p>
+<dt><strong><a name="item__2dr_2c__2d_2dfull"><strong>-R</strong>, <strong>--full</strong></a></strong><br />
+</dt>
+<dd>
+Just output the SpamAssassin report text to stdout, for all messages.
+See <strong>-r</strong> for details of the output format used.
+</dd>
+<p></p>
+<dt><strong><a name="item__2ds_max_size_2c__2d_2dmax_2dsize_3dmax_size"><strong>-s</strong> <em>max_size</em>, <strong>--max-size</strong>=<em>max_size</em></a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<dd>
+<p>The size is specified in bytes, as a positive integer greater than 0.
+For example, <strong>-s 500000</strong>.</p>
+</dd>
+<p></p>
+<dt><strong><a name="item__2d_2dconnect_2dretries_3dretries"><strong>--connect-retries</strong>=<em>retries</em></a></strong><br />
+</dt>
+<dd>
+Retry connecting to spamd <em>retries</em> times. The default is 3 times.
+</dd>
+<p></p>
+<dt><strong><a name="item__2d_2dretry_2dsleep_3dsleep"><strong>--retry-sleep</strong>=<em>sleep</em></a></strong><br />
+</dt>
+<dd>
+Sleep for <em>sleep</em> seconds between attempts to connect to spamd.
+The default is 1 second.
+</dd>
+<p></p>
+<dt><strong><a name="item__2ds_2c__2d_2dssl_2c__2d_2dssl_3dsslversion"><strong>-S</strong>, <strong>--ssl</strong>, <strong>--ssl</strong>=<em>sslversion</em></a></strong><br />
+</dt>
+<dd>
+If spamc was built with support for SSL, encrypt data to and from the
+spamd process with SSL; spamd must support SSL as well.
+<em>sslversion</em> specifies the SSL protocol version to use, one of
+<code>sslv2</code>, <code>sslv3</code>, <code>tlsv1</code>, or <code>sslv23</code>. The default, <code>sslv23</code>, causes
+spamc to use a SSLv2 hello handshake then negotiate use of SSLv3 or TLSv1
+protocol if the spamd server can accept it.
+</dd>
+<p></p>
+<dt><strong><a name="item__2dt_timeout_2c__2d_2dtimeout_3dtimeout"><strong>-t</strong> <em>timeout</em>, <strong>--timeout</strong>=<em>timeout</em></a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<p></p>
+<dt><strong><a name="item__2du_username_2c__2d_2dusername_3dusername"><strong>-u</strong> <em>username</em>, <strong>--username</strong>=<em>username</em></a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<p></p>
+<dt><strong><a name="item__2du_socketpath_2c__2d_2dsocket_3dpath"><strong>-U</strong> <em>socketpath</em>, <strong>--socket</strong>=<em>path</em></a></strong><br />
+</dt>
+<dd>
+Connect to <code>spamd</code> via UNIX domain socket <em>socketpath</em> instead of a
+TCP/IP connection.
+</dd>
+<dd>
+<p>This option is not supported on Win32 platforms.</p>
+</dd>
+<p></p>
+<dt><strong><a name="item__2dv_2c__2d_2dversion"><strong>-V</strong>, <strong>--version</strong></a></strong><br />
+</dt>
+<dd>
+Report the version of this <code>spamc</code> client. If built with SSL support,
+an additional line will be included noting this, like so:
+</dd>
+<dd>
+<pre>
+ SpamAssassin Client version 3.0.0-rc4
+ compiled with SSL support (OpenSSL 0.9.7d 17 Mar 2004)</pre>
+</dd>
+<p></p>
+<dt><strong><a name="item__2dx_2c__2d_2dno_2dsafe_2dfallback"><strong>-x</strong>, <strong>--no-safe-fallback</strong></a></strong><br />
+</dt>
+<dd>
+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>.
+</dd>
+<dd>
+<p>This also disables the TCP fail-over behaviour from <strong>-d</strong>.</p>
+</dd>
+<p></p>
+<dt><strong><a name="item__2dy_2c__2d_2dtests"><strong>-y</strong>, <strong>--tests</strong></a></strong><br />
+</dt>
+<dd>
+Just output the names of the tests hit to stdout, on one line, separated
+by commas.
+</dd>
+<p></p>
+<dt><strong><a name="item__2dk"><strong>-K</strong></a></strong><br />
+</dt>
+<dd>
+Perform a keep-alive check of spamd, instead of a full message check.
+</dd>
+<p></p>
+<dt><strong><a name="item__2dz"><strong>-z</strong></a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<p></p>
+<dt><strong><a name="item__2d_2dheaders"><strong>--headers</strong></a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<dd>
+<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>
+<p></p></dl>
+<p>
+</p>
+<hr />
+<h1><a name="configuration_file">CONFIGURATION FILE</a></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 <strong>-F</strong> 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 <strong>-F</strong>
+switch is not specified, no configuration file will be read.</p>
+<p>Example:</p>
+<pre>
+ # spamc global configuration file
+
+ # connect to "server.example.com", port 783
+ -d server.example.com
+ -p 783</pre>
+<pre>
+ # max message size for scanning = 350k
+ -s 350000</pre>
+<p>
+</p>
+<hr />
+<h1><a name="exit_codes">EXIT CODES</a></h1>
+<p>By default, spamc will use the 'safe fallback' error recovery method. That
+means, it will always exit with an exit code if <code>0</code>, even if an error was
+encountered. If any error occurrs, it will simply pass through the unaltered
+message.</p>
+<p>The <strong>-c</strong> and <strong>-E</strong> 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 the <code>-x</code> option is specified, 'safe fallback' will be disabled, and certain
+error conditions related to communication between spamc and spamd will result
+in an error code. The exit codes used are as follows:</p>
+<pre>
+ 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</pre>
+<p>
+</p>
+<hr />
+<h1><a name="see_also">SEE ALSO</a></h1>
+<p><code>spamd(1)</code>
+<code>spamassassin(1)</code>
+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="authors">AUTHORS</a></h1>
+<p>The <code>SpamAssassin(tm)</code> 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.2.x/doc/spamc.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/spamc.txt?view=auto&rev=559437
==============================================================================
--- spamassassin/site/full/3.2.x/doc/spamc.txt (added)
+++ spamassassin/site/full/3.2.x/doc/spamc.txt Wed Jul 25 05:52:42 2007
@@ -0,0 +1,264 @@
+NAME
+ spamc - client for spamd
+
+SYNOPSIS
+ spamc [options] < message
+
+DESCRIPTION
+ Spamc is the client half of the spamc/spamd pair. It should be used in
+ place of "spamassassin" 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.
+
+ See the README file in the spamd directory of the SpamAssassin
+ distribution for more details.
+
+OPTIONS
+ All options detailed below can be passed as command line arguments, or
+ be contained in a configuration file, as described in the CONFIGURATION
+ FILE section below.
+
+ Note that the long options, a la "--long-options", are new as of
+ SpamAssassin 3.2.0, and were not available in earlier versions.
+
+ -B, --bsmtp
+ 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).
+
+ -c, --check
+ 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 -c and -E is a no-op, since -c implies the
+ behaviour of -E.
+
+ -d *host[,host2]*, --dest=*host[,host2]*
+ In TCP/IP mode, connect to spamd server on given host (default:
+ localhost). Several hosts can be specified if separated by commas.
+
+ If *host* 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 -x; if that switch is used, fail-over will not occur.
+
+ -e *command* *[args]*, --pipe-to *command* *[args]*
+ Instead of writing to stdout, pipe the output to *command*'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.
+
+ Note that this must be the LAST command line option, as everything
+ after the -e is taken as arguments to the command (it's like *rxvt*
+ or *xterm*).
+
+ This option is not supported on Win32 platforms.
+
+ -E, --exitcode
+ 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.
+
+ -F */path/to/file*, --config=*path*
+ Specify a configuration file to read additional command-line flags
+ from. See CONFIGURATION FILE below.
+
+ -h, --help
+ Print this help message and terminate without action.
+
+ -H, --randomize
+ For TCP/IP sockets, randomize the IP addresses returned for the
+ hosts given by the -d switch. This provides for a simple kind of
+ load balancing. It will try only three times though.
+
+ -l, --log-to-stderr
+ Send log messages to stderr, instead of to the syslog.
+
+ -L *learn type*, --learntype=*type*
+ Send message to spamd for learning. The "learn type" 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.
+
+ Note that the "spamd" must run with the "--allow-tell" option for
+ this to work.
+
+ -C *report type*, --reporttype=*type*
+ Report or revoke a message to one of the configured collaborative
+ filtering databases. The "report type" can be either report or
+ revoke.
+
+ Note that the "spamd" must run with the "--allow-tell" option for
+ this to work.
+
+ -p *port*, --port=*port*
+ In TCP/IP mode, connect to spamd server listening on given port
+ (default: 783).
+
+ -r, --full-spam
+ 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:
+
+ score/threshold
+
+ -R, --full
+ Just output the SpamAssassin report text to stdout, for all
+ messages. See -r for details of the output format used.
+
+ -s *max_size*, --max-size=*max_size*
+ 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.
+
+ The size is specified in bytes, as a positive integer greater than
+ 0. For example, -s 500000.
+
+ --connect-retries=*retries*
+ Retry connecting to spamd *retries* times. The default is 3 times.
+
+ --retry-sleep=*sleep*
+ Sleep for *sleep* seconds between attempts to connect to spamd. The
+ default is 1 second.
+
+ -S, --ssl, --ssl=*sslversion*
+ If spamc was built with support for SSL, encrypt data to and from
+ the spamd process with SSL; spamd must support SSL as well.
+ *sslversion* specifies the SSL protocol version to use, one of
+ "sslv2", "sslv3", "tlsv1", or "sslv23". The default, "sslv23",
+ causes spamc to use a SSLv2 hello handshake then negotiate use of
+ SSLv3 or TLSv1 protocol if the spamd server can accept it.
+
+ -t *timeout*, --timeout=*timeout*
+ 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.
+
+ -u *username*, --username=*username*
+ 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.
+
+ -U *socketpath*, --socket=*path*
+ Connect to "spamd" via UNIX domain socket *socketpath* instead of a
+ TCP/IP connection.
+
+ This option is not supported on Win32 platforms.
+
+ -V, --version
+ Report the version of this "spamc" client. If built with SSL
+ support, an additional line will be included noting this, like so:
+
+ SpamAssassin Client version 3.0.0-rc4
+ compiled with SSL support (OpenSSL 0.9.7d 17 Mar 2004)
+
+ -x, --no-safe-fallback
+ 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 "EXIT CODES".
+
+ This also disables the TCP fail-over behaviour from -d.
+
+ -y, --tests
+ Just output the names of the tests hit to stdout, on one line,
+ separated by commas.
+
+ -K Perform a keep-alive check of spamd, instead of a full message
+ check.
+
+ -z Use gzip compression to compress the mail message sent to "spamd".
+ This is useful for long-distance use of spamc over the internet.
+ Note that this relies on "zlib" being installed on the "spamc"
+ client side, and the "Compress::Zlib" perl module on the server
+ side; an error will be returned otherwise.
+
+ --headers
+ 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.
+
+ Note that this only makes sense if you are using "report_safe 0" in
+ the scanning configuration on the remote end; with "report_safe 1",
+ it is likely to result in corrupt messages.
+
+CONFIGURATION FILE
+ The above command-line switches can also be loaded from a configuration
+ file.
+
+ The format of the file is similar to the SpamAssassin rules files; blank
+ lines and lines beginning with "#" 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.
+
+ If the -F switch is specified, that file will be used. Otherwise,
+ "spamc" will attempt to load spamc.conf in "SYSCONFDIR" (default:
+ /etc/mail/spamassassin). If that file doesn't exist, and the -F switch
+ is not specified, no configuration file will be read.
+
+ Example:
+
+ # 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
+
+EXIT CODES
+ By default, spamc will use the 'safe fallback' error recovery method.
+ That means, it will always exit with an exit code if 0, even if an error
+ was encountered. If any error occurrs, it will simply pass through the
+ unaltered message.
+
+ The -c and -E options modify this; instead, spamc will use an exit code
+ of 1 if the message is determined to be spam.
+
+ If the "-x" option is specified, 'safe fallback' will be disabled, and
+ certain error conditions related to communication between spamc and
+ spamd will result in an error code. The exit codes used are as follows:
+
+ 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
+
+SEE ALSO
+ spamd(1) spamassassin(1) Mail::SpamAssassin(3)
+
+PREREQUISITES
+ "Mail::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.
+