# -*- text -*-
#
# Copyright 2003 Laurent Wacrenier
#
# This file is part of clamd-stream-client.
#
# clamd-stream-client is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# clamd-stream-client is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with PLL popd; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
# $Id: README,v 1.2 2006/03/16 19:04:54 lwa Exp $


*** What is it ?

This is a clamd client. Clamd is a server, part of ClamAV antivirus.
You can found it from http://clamav.sourceforge.net/

It uses the clamd(8) STREAM command, so you have to open your firewall
to allow any connections from your client to your server on high
ports.

It runs on FreeBSD 5 and maybe on POSIX plateforms. Clamav libraries
are not needed to compile.

I trust it enough to pass my mail trough it.

*** Procmail usage

You may add something like this in your .procmailrc to seek virus and
archive them in a compressed folder (here junk/virus.gz)

VIRUS=`clamd-stream-client -t 3 -d clamd-server-name`

:0
* VIRUS ?? .
{
        :0fw
        |formail -A "X-Virus: $VIRUS"

        :0W:
        | gzip -9 >> junk/virus.gz
}

*** Maildrop usage

As Maildrop expect the filter commands returns true, you have to get
the virus name like this

VIRUS=`/usr/local/bin/clamd-stream-client -d clamd.local ; true`

Then check if the $VIRUS string is empty.

*** Author

If you find a bug or have useful comment or improvement, please send it to
Laurent Wacrenier <laurent.wacrenier@gmail.com>