DSPAM STREAMLINED BLACKHOLE LIST CLIENT v1.0
Copyright (c) 2004-2005 Network Dweebs Corporation
http://www.nuclearelephant.com/projects/sbl/

LICENSE

This program 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.

This program 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 this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

TABLE OF CONTENTS

General Client Information

  1.0 About the SBL Client
  1.1 Installation
  1.2 Running the Client

1.0 ABOUT SBL CLIENT

The DSPAM SBL Client is an open-source, freely available streamlined blackhole
client.  Please see http://www.nuclearelephant.com/projects/sbl/ for more
information about the streamlined blackhole list.

1.1 INSTALLATION

To install the SBL client, run:

./configure && make && make install

The configuration file sbl_client.conf will be installed, by default, in
/usr/local/etc. This file should be edited to reflect the correct sbl server
information. If you have a write account on the SBL server, you'll need to
set ServerUID and ServerSecret also.

1.2 RUNNING THE CLIENT

The client supports two different modes of operation: commandline query/post
and directory-watch mode.  

  COMMANDLINE
  There are presently two commandline functions to perform single functions:
    -c [address]  Check/Query: Checks whether a particular address is BL'd
    -s [address]  Spam:        Reports the address as a spam sender

  DIRECTORY WATCH
  To use the client's directory watch mode, use the -d flag followed by the
  path to an empty directory on your server.  Have your controlling software
  (namely your statistical filter) create or touch blank files in this
  directory using the ip address of the spammer as the filename.  The
  directory watcher will automatically send out new addresses and perform
  hourly cleanup of the directory.

  NOTE: In order to perform any 'write' operations to the SBL server, you 
        must have an account.
 
BUGS AND FEEDBACK

The SBL is still in its infancy, and this version is a development 
release.  Please report any bugs, constructive feedback, and code
to jonathan@nuclearelephant.com.

