<!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>spamd - daemonized version of spamassassin</title> <link rev="made" href="mailto:root@localhost" /> </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="#bugs">BUGS</a></li> <li><a href="#see_also">SEE ALSO</a></li> <li><a href="#author">AUTHOR</a></li> <li><a href="#prerequisites">PREREQUISITES</a></li> </ul> <!-- INDEX END --> <hr /> <p> </p> <h1><a name="name">NAME</a></h1> <p>spamd - daemonized version of spamassassin</p> <p> </p> <hr /> <h1><a name="synopsis">SYNOPSIS</a></h1> <p>spamd [options]</p> <p>Options:</p> <pre> -a, --auto-whitelist, --whitelist Use auto-whitelists -c, --create-prefs Create user preferences files -C path, --configpath=path Path for default config files -d, --daemonize Daemonize -h, --help Print usage message. -i ipaddr, --listen-ip=ipaddr,... Listen on the IP ipaddr (default: 127.0.0.1) -m num, --max-children num Allow maximum num children -p port, --port Listen on specified port (default: 783) -q, --sql-config Enable SQL config (only useful with -x) -V, --virtual-config=dir Enable Virtual configs (needs -x) -r pidfile, --pidfile Write the process id to pidfile -s facility, --syslog=facility Specify the syslog facility (default: mail) --syslog-socket=type How to connect to syslogd (default: unix) -u username, --username=username Run as username -v, --vpopmail Enable vpopmail config -x, --nouser-config Disable user config files -A host,..., --allowed-ips=..,.. Limit ip addresses which can connect -D, --debug Print debugging messages -L, --local Use local tests only (no DNS) -P, --paranoid Die upon user errors -H dir Specify a different HOME directory, path optional</pre> <p> </p> <hr /> <h1><a name="description">DESCRIPTION</a></h1> <p>The purpose of this program is to provide a daemonized version of the spamassassin executable. The goal is improving throughput performance for automated mail checking.</p> <p>This is intended to be used alongside <code>spamc</code>, a fast, low-overhead C client program.</p> <p>See the README file in the <code>spamd</code> directory of the SpamAssassin distribution for more details.</p> <p>Note: Although spamd will check per-user config files for every message, any changes to the system-wide config files will require restarting spamd for the changes to take effect.</p> <p> </p> <hr /> <h1><a name="options">OPTIONS</a></h1> <p>Options of the long form can be shortened as long as they remain unambiguous. (i.e. <strong>--dae</strong> can be used instead of <strong>--daemonize</strong>) Also, boolean options (like <strong>--auto-whitelist</strong>) can be negated by adding <em>--no</em> (<strong>--noauto-whitelist</strong>), however, this is usually unnecessary.</p> <dl> <dt><strong><a name="item_%2da%2c_%2d%2dauto%2dwhitelist%2c_%2d%2dwhitelist"><strong>-a</strong>, <strong>--auto-whitelist</strong>, <strong>--whitelist</strong></a></strong><br /> </dt> <dd> Use auto-whitelists. Auto-whitelists track the long-term average score for each sender and then shift the score of new messages toward that long-term average. This can increase or decrease the score for messages, depending on the long-term behavior of the particular correspondent. See the README file for more details. </dd> <p></p> <dt><strong><a name="item_%2dc%2c_%2d%2dcreate%2dprefs"><strong>-c</strong>, <strong>--create-prefs</strong></a></strong><br /> </dt> <dd> Create user preferences files if they don't exist (default: don't). </dd> <p></p> <dt><strong><a name="item_%2dc_path%2c_%2d%2dconfigpath%3dpath"><strong>-C</strong> <em>path</em>, <strong>--configpath</strong>=<em>path</em></a></strong><br /> </dt> <dd> Use the specified path for locating configuration files. Ignore the default directories. </dd> <p></p> <dt><strong><a name="item_%2dd%2c_%2d%2ddaemonize"><strong>-d</strong>, <strong>--daemonize</strong></a></strong><br /> </dt> <dd> Detach from starting process and run in background (daemonize). </dd> <p></p> <dt><strong><a name="item_%2dh%2c_%2d%2dhelp"><strong>-h</strong>, <strong>--help</strong></a></strong><br /> </dt> <dd> Print a brief help message, then exit without further action. </dd> <p></p> <dt><strong><a name="item_%2di_ipaddress%2c_%2d%2dlisten%2dip%3dipaddress%2c"><strong>-i</strong> <em>ipaddress</em>, <strong>--listen-ip</strong>=<em>ipaddress</em>, <strong>--ip-address</strong>=<em>ipaddress</em></a></strong><br /> </dt> <dd> Tells spamd to listen on the specified IP address [defaults to 127.0.0.1]. Use 0.0.0.0 to listen on all interfaces. </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> Optionally specifies the port number for the server to listen on. </dd> <p></p> <dt><strong><a name="item_%2dq%2c_%2d%2dsql%2dconfig"><strong>-q</strong>, <strong>--sql-config</strong></a></strong><br /> </dt> <dd> Turn on SQL lookups even when per-user config files have been disabled with <strong>-x</strong>. this is useful for spamd hosts which don't have user's home directories but do want to load user preferences from an SQL database. </dd> <p></p> <dt><strong><a name="item_%2dv%2c_%2d%2dvirtual%2dconfig%3ddirectory"><strong>-V</strong>, <strong>--virtual-config</strong>=<em>directory</em></a></strong><br /> </dt> <dd> This option specifies a directory which will contain per-user preference files. The files are in the format of <strong><em>username</em>.prefs</strong>. A <strong>default.prefs</strong> file will be used if an individual user config is not found. </dd> <dd> <p>Note that this <strong>requires</strong> that <strong>-x</strong> is used, and cannot be combined with SQL-based configuration.</p> </dd> <p></p> <dt><strong><a name="item_%2dr_pidfile%2c_%2d%2dpidfile%3dpidfile"><strong>-r</strong> <em>pidfile</em>, <strong>--pidfile</strong>=<em>pidfile</em></a></strong><br /> </dt> <dd> Write the process ID of the spamd parent to the file specified by <em>pidfile</em>. The file will be unlinked when the parent exits. Note that when running with the <strong>-u</strong> option, the file must be writable by that user. </dd> <p></p> <dt><strong><a name="item_%2dv%2c_%2d%2dvpopmail"><strong>-v</strong>, <strong>--vpopmail</strong></a></strong><br /> </dt> <dd> Enable vpopmail config (only useful with <strong>-u</strong> set to vpopmail user). This option is useful for vpopmail virtual users who do not have an entry in the system /etc/passwd file. This allows spamd to lookup/create user_prefs in the vpopmail users own maildir. </dd> <p></p> <dt><strong><a name="item_%2ds_facility%2c_%2d%2dsyslog%3dfacility"><strong>-s</strong> <em>facility</em>, <strong>--syslog</strong>=<em>facility</em></a></strong><br /> </dt> <dd> Specify the syslog facility to use (default: mail). If <code>stderr</code> is specified, output will be written to stderr. This is useful if you're running <code>spamd</code> under the <code>daemontools</code> package. </dd> <p></p> <dt><strong><a name="item_%2d%2dsyslog%2dsocket%3dtype"><strong>--syslog-socket</strong>=<em>type</em></a></strong><br /> </dt> <dd> Specify how spamd should send messages to syslogd. The options are <code>unix</code>, <code>inet</code> or <code>none</code>. The default is to try <code>unix</code> first, falling back to <code>inet</code> if perl detects errors in its <code>unix</code> support. </dd> <dd> <p>Some platforms, or versions of perl, are shipped with dysfunctional versions of the <strong>Sys::Syslog</strong> package which do not support some socket types, so you may need to set this. If you get error messages regarding <strong>__PATH_LOG</strong> or similar from spamd, try changing this setting.</p> </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> Run as the named user. The alternative, default behaviour is to <code>setuid()</code> to the user running <code>spamc</code>, if <code>spamd</code> is running as root. </dd> <p></p> <dt><strong><a name="item_%2dx%2c_%2d%2dnouser%2dconfig%2c_%2d%2duser%2dconf"><strong>-x</strong>, <strong>--nouser-config</strong>, <strong>--user-config</strong></a></strong><br /> </dt> <dd> Turn <code>off(on)</code> per-user config files. All users will just get the default configuration. </dd> <p></p> <dt><strong><a name="item_%2da_host%2c%2e%2e%2e%2c_%2d%2dallowed%2dips%3dhos"><strong>-A</strong> <em>host,...</em>, <strong>--allowed-ips</strong>=<em>host,...</em></a></strong><br /> </dt> <dd> Specify a list of authorized hosts or networks which can connect to this spamd instance. Single IP addresses can be given, or ranges of ip addresses in address/masklength format. This option can be specified multiple times or can take a list of addresses separated by commas. Examples: </dd> <dd> <p><strong>-A 10.11.12.13,10.11.12.14</strong> -- only allow connections from 10.11.12.13 and 10.11.12.14</p> </dd> <dd> <p>-<strong>A 10.200.300.0/24</strong> -- allow connections from any machine in the range 10.200.300.*</p> </dd> <dd> <p>By default, connections are only accepted from localhost [127.0.0.1].</p> </dd> <p></p> <dt><strong><a name="item_%2dd%2c_%2d%2ddebug"><strong>-D</strong>, <strong>--debug</strong></a></strong><br /> </dt> <dd> Print debugging messages </dd> <p></p> <dt><strong><a name="item_%2dl%2c_%2d%2dlocal"><strong>-L</strong>, <strong>--local</strong></a></strong><br /> </dt> <dd> Perform only local tests on all mail. In other words, skip DNS and other network tests. Works the same as the <code>-L</code> flag to <code>spamassassin(1)</code>. </dd> <p></p> <dt><strong><a name="item_%2dp%2c_%2d%2dparanoid"><strong>-P</strong>, <strong>--paranoid</strong></a></strong><br /> </dt> <dd> Die on user errors (for the user passed from spamc) instead of falling back to user <em>nobody</em> and using the default configuration. </dd> <p></p> <dt><strong><a name="item_%2dm_number%2c_%2d%2dmax%2dchildren%3dnumber"><strong>-m</strong> <em>number</em>, <strong>--max-children</strong>=<em>number</em></a></strong><br /> </dt> <dd> This option is not recommended -- see below. </dd> <dd> <p>Specify a maximum number of children to spawn. Spamd will wait until another child finishes before forking again. Meanwhile, incoming connections will be queued.</p> </dd> <dd> <p>Use of this option is not recommended in most circumstances, as we have received reports of the perl interpreter dumping core. It seems that some versions of Perl on some OSes have issues with tracking child processes and signal handling, which the perl interpreter to crash.</p> </dd> <dd> <p>Please note that there is a OS specific maximum of connections that can be queued (Try <code>perl -MSocket -e'print SOMAXCONN'</code> to find this maximum).</p> </dd> <p></p> <dt><strong><a name="item_%2dh_directory%2c_%2d%2dhelper%2dhome%2ddir%3ddire"><strong>-H</strong> <em>directory</em>, <strong>--helper-home-dir</strong>=<em>directory</em></a></strong><br /> </dt> <dd> Specify that external programs such as Razor, DCC, and Pyzor should have a HOME environment variable set to a specific directory. The default is to use the HOME environment variable setting from the shell running spamd. By specifying no argument, spamd will use the spamc caller's home directory instead. </dd> <p></p></dl> <p> </p> <hr /> <h1><a name="bugs">BUGS</a></h1> <p>Perl 5.005_03 seems to have a bug which spamd triggers, causing messages to pass through unscanned. Upgrading to Perl 5.6 seems to fix the problem, so that's the current workaround. More information can be found at <a href="http://www.hughes-family.org/bugzilla/show_bug.cgi?id=497">http://www.hughes-family.org/bugzilla/show_bug.cgi?id=497</a></p> <p>The <code>-m</code> switch seems to trigger signal-handling bugs in many versions of Perl.</p> <p> </p> <hr /> <h1><a name="see_also">SEE ALSO</a></h1> <p><code>spamc(1)</code> <code>spamassassin(1)</code> Mail::SpamAssassin(3) Mail::SpamAssassin::Conf(3)</p> <p> </p> <hr /> <h1><a name="author">AUTHOR</a></h1> <p>Craig R Hughes <<a href="mailto:craig@hughes-family.org">craig@hughes-family.org</a>></p> <p> </p> <hr /> <h1><a name="prerequisites">PREREQUISITES</a></h1> <p><code>Mail::SpamAssassin</code></p> </body> </html>
