NAME
    spamd - daemonized version of spamassassin

SYNOPSIS
    spamd [options]

    Options:

     -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)
     -r pidfile, --pidfile              Write the process id to pidfile
     -s facility, --syslog=facility     Specify the syslog facility (default: mail)
     -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
     -F 0|1, --add-from, --noadd-from   Remove/add 'From ' line (default: add)
     -L, --local                        Use local tests only (no DNS)
     -P, --paranoid                     Die upon user errors
     -S, --stop-at-threshold            Stop tests after the threshold is reached

OPTIONS
    Options of the long form can be shortened as long as they remain
    unambiguous. (i.e. --dae can be used instead of --daemonize) Also,
    boolean options (like --auto-whitelist) can be negated by adding *--no*
    (--noauto-whitelist), however, this is usually unnecessary.

    -a, --auto-whitelist, --whitelist
        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.

    -c, --create-prefs
        Create user preferences files if they don't exist (default: don't).

    -C *path*, --configpath=*path*
        Use the specified path for locating configuration files. Ignore the
        default directories.

    -d, --daemonize
        Detach from starting process and run in background (daemonize).

    -h, --help
        Print a brief help message, then exit without further action.

    -i *ipaddress*, --listen-ip=*ipaddress*, --ip-address=*ipaddress*
        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.

    -p *port*, --port=*port*
        Optionally specifies the port number for the server to listen on.

    -q, --sql-config
        Turn on SQL lookups even when per-user config files have been
        disabled with -x. 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.

    -r *pidfile*, --pidfile=*pidfile*
        Write the process ID of the spamd parent to the file specified by
        *pidfile*. The file will be unlinked when the parent exits.

    -v, --vpopmail
        Enable vpopmail config (only useful with -u 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.

    -s *facility*, --syslog=*facility*
        Specify the syslog facility to use (default: mail).

    -u *username*, --username=*username*
        Run as the named user. The alternative, default behaviour is to
        setuid() to the user running "spamc", if "spamd" is running as root.

    -x, --nouser-config, --user-config
        Turn off(on) per-user config files. All users will just get the
        default configuration.

    -A *host,...*, --allowed-ips=*host,...*
        Specify a list of authorized hosts which can connect to this spamd
        instance. The list is one of valid IP addresses, separated by
        commas. By default, connections are only accepted from localhost
        (127.0.0.1).

    -D, --debug
        Print debugging messages

    -L, --local
        Perform only local tests on all mail. In other words, skip DNS and
        other network tests. Works the same as the "-L" flag to
        spamassassin(1).

    -S, --stop-at-threshold
        Stop spam checking as soon as the spam threshold is reached, to
        increase performance. This option also turns off Razor reporting.

    -P, --paranoid
        Die on user errors (for the user passed from spamc) instead of
        falling back to user *nobody* and using the default configuration.

    -F *0 | 1*, --add-from, --noadd-from
        Ensure that the output email message either always starts with a
        'From ' line (*1*) for UNIX mbox format, or ensure that this line is
        stripped from the output (*0*). (default: 1)

    -m *number*, --max-children=*number*
        Specify a maximum number of children to spawn. Spamd will wait until
        another child finishes before forking again. Meanwhile, incoming
        connections will be queued. Please note that there is a OS specific
        maximum of connections that can be queued. (Try "perl -MSocket
        -e'print SOMAXCONN'" to find this maximum)

DESCRIPTION
    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.

    This is intended to be used alongside "spamc", a fast, low-overhead C
    client program.

    See the README file in the "spamd" directory of the SpamAssassin
    distribution for more details.

    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.

SEE ALSO
    spamc(1) spamassassin(1) Mail::SpamAssassin(3)
    Mail::SpamAssassin::Conf(3)

AUTHOR
    Craig R Hughes <craig@hughes-family.org>

PREREQUISITES
    "Mail::SpamAssassin"

