.\" Zmscanner config file manual page
.\"
.\" $Id: zmscanner.conf.5,v 1.2 2004/06/22 05:46:49 crosser Exp $
.\"
.\" $Log: zmscanner.conf.5,v $
.\" Revision 1.2  2004/06/22 05:46:49  crosser
.\" start writing content
.\"
.\" Revision 1.1  2003/12/13 20:47:37  crosser
.\" add man page placeholders
.\"
.\"
.\"        WHAT IS IT:
.\"                modularized contentfilter for Zmailer
.\"        COPYRIGHT:
.\"                (c) 2003 Eugene G. Crosser <crosser@average.org>
.\"        LICENSE:
.\"                The same set as apply to Zmailer code
.\"
.TH ZMSCANNER.CONF 5 "13 Dec 2003" ZMSCANNER ZMSCANNER
.SH NAME
zmscanner.conf \- master configuration file for Zmascanner
.SH SYNOPSYS
.B ${sysconfdir}/zmscanner.conf 
.SH DESCRIPTION
.B zmscanner.conf
is the file that controls operation of
.BR zmscanner "(8)
daemon.  Lines that contain nothing but whitespace and those starting
with a '#' sign are ignored.  Meaningful lines comprise of a keyword
and a value separated by whitespace.  The following keywords are
recognized:
.SS socket
Value for this keyword should be a path to the UNIX domain socket that
is used for communication between the daemon and the clients.
.sp
Example:
.nf
.B \tsocket\t/var/run/zmscanner
.fi
.SS pidfile
This is a path to a file that will contain the process ID of the daemon.
This can be used to send signals to the daemon.
.B NOTE:
This is not a lock file, it does not prevent start of the second instance
of the daemon.
.sp
Example:
.nf
.B \tpidfile\t/var/run/zmscanner.pid
.fi
.SS maxsize
Maximum size to scan in the messages, once that many data is scanned,
the rest is ignored.  This is to avoid denial of service conditions,
and by the way spam and virus messages are typically not very big.
Numeric value may be suffixed by 'K' or 'M' (x 1024 or x 1048576
respectively)
.sp
Example:
.nf
.B \tmaxsize\t4M
.fi
.SS initstage
Name of stage that gets entire original message.  For use with
.BR Zmailer ",
this should be
.BR zmsg ".
.sp
Example:
.nf
.B \tinitstage\tzmsg
.fi
.SS finalstage
Name of stage called after everything else.  It is given NULL data, and
the sole purpose of ots handler is to process data that could have been
collected by other stage handlers and passed in named variables.  This
handler is optional, it can be useful only with a custom set of modules,
if the final decision depends on a number of characteristics of different
parts of the message.
.sp
Example:
.nf
.B \tfinalstage\tzfin
.fi
.SS modconfdir
Directory where modules should look for their personal config files
.sp
Example:
.nf
.B \tmodconfdir\t/usr/local/etc/zmscanner
.fi
.SS moddir
This is a directory where dynamically loadable modules (shared objects)
are kept.
.br
.B THIS MUST GO BEFORE THE FIRST "module" directive!
.br
If not set, modules will be looked for in $libexecdir.
.br
It should be the same directory that was specified in
.B --with-moddir
option on ./configure stage for third party modules.
.sp
Example:
.nf
.B \tmoddir\t/usr/local/lib/zmscanner
.fi
.SS module
Name of dynamically loadable module (shared object) to include in the
running instance.  More than one directive may be specified to load
more than one module.  These sould go after the
.B moddir
directive.
.sp
Example:
.nf
.B \tmodule\tzms_clamav.so
.fi

.SH COPYRIGHT
2003-2004, Eugene G. Crosser
.br
License same as Zmailer (http://www.zmailer.org/)
.SH SEE ALSO
.BR zmscanner "(3), " zmscanner "(8), " zmsctl "(8)