[cvs] bogofilter README,1.11,1.12
Fast Bayesian spam filter along lines suggested by Paul Graham
Brought to you by:
m-a
Menu
▾
▴
[cvs] bogofilter README,1.11,1.12
|
From: <re...@us...> - 2004-06-30 04:18:36
|
Update of /cvsroot/bogofilter/bogofilter In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv30209 Modified Files: README Log Message: Reformat and update. Index: README =================================================================== RCS file: /cvsroot/bogofilter/bogofilter/README,v retrieving revision 1.11 retrieving revision 1.12 diff -u -d -r1.11 -r1.12 --- README 27 Jun 2004 15:58:58 -0000 1.11 +++ README 30 Jun 2004 04:18:27 -0000 1.12 @@ -1,9 +1,28 @@ + Bogofilter -- fast Bayesian spam filtering + # $Id$ - bogofilter -- fast Bayesian spam filtering +Summary: + +1. What is Bogofilter? +2. Documentation +3. Building Bogofilter. +4. How to contribute +5. How to request features +6. Installing Bogofilter from source tarball or CVS + a. Downloading + b. Installing + c. Configuring + d. Changing Bogofilter + -This package implements a fast Bayesian spam filter along the lines suggested -by Paul Graham in his article "A Plan For Spam": + +1. What is Bogofilter? +---------------------- + +Bogofilter is a fast Bayesian spam filtering, which implements a fast +Bayesian spam filter along the lines suggested by Paul Graham in his +article "A Plan For Spam": http://www.paulgraham.com/spam.html @@ -20,7 +39,10 @@ features rather than broken up. Various kinds of MTA cruft such as dates and message-IDs are discarded so as not to bloat the word lists. -*** DOCUMENTATION *** + + +2. Documentation +---------------- It is recommended, although not necessary, that you install the GNU Scientific Library (GSL) version 1.4 or newer before configuring @@ -30,7 +52,7 @@ When installed, there are man pages for bogofilter, bogoutil, bogolexer, and bogoupgrade. Additional documentation is in -/usr/src/bogofilter-1.2.3/doc or comparable directory (depending on +/usr/share/doc/bogofilter-x.y.z or comparable directory (depending on your operating system). If you've installed the source code, the doc directory and its @@ -43,7 +65,9 @@ you can add to your .muttrc. -*** BUILDING BOGOFILTER *** + +3. Building Bogofilter +---------------------- When updating, check the RELEASE.NOTES files. @@ -55,30 +79,99 @@ warning: format not a string literal, argument types not checked -*** CONFIGURATION *** -The default location for the configuration files is /etc on Linux and -/usr/local/etc on all other systems, unless you override with ---sysconfdir=/etc. A sample config file, bogofilter.cf.example is -included with the distribution. +3. How to contribute +-------------------- +The best way to contribute to bogofilter is through the bogofilter +mailing list, bog...@bo.... You can subscribe to it by +sending a message to bog...@bo... and +responding to the confirmation message it sends to you. More +information is available on the bogofilter home page at +http://bogofilter.sourceforge.net -*** CHANGING BOGOFILTER *** +Bugs can be reported via the bogfilter mailing list or through +http://sourceforge.net/tracker/?atid=499997&group_id=62265&func=browse -If you make modifications to bogofilter, you may need to have a recent -DocBook XML tool chain, the xmlto program, PassiveTeX and XMLTeX, a -recent automake (1.7) and autoconf (2.5X) and Perl 5.6 or newer -installed to be able to rebuild bogofilter. +If you have code to contribute, please post it on the bogofilter +mailing list or mail it to David Relson (re...@us...) -These requirements do not apply if you are building an unmodified -tarball. -*** NEWEST SOFTWARE *** +5. How to request features +-------------------------- -For the most recent version of this software, see: +Ask around in the bogofilter mailing list. The idea may have been +already suggested, considered, accepted, rejected, ... You won't know +until you ask! + +Alternatively, you might want to hack at the code and develop the +feature on your own, which would be great! You can then send a patch +to the list. + + + +6. Installing Bogofilter from CVS +--------------------------------- + + a. Downloading + -------------- + + The most recent version of this software is available at: http://sourceforge.net/projects/bogofilter/ -The latest stable version can be downloaded. The development source -is in a CVS repository on SourceForge and can also be downloaded. + The latest stable version can be downloaded. The development source + is in a CVS repository on SourceForge. To download the latest cvs + source, cd to the directory to which you wish to download and type + the following commands: + + cvs -d:pserver:ano...@cv...:/cvsroot/bogofilter login + + When prompted for a password press the RETURN key. + After anonymously logging in: + + cvs -z3 -d:pserver:ano...@cv...:/cvsroot/bogofilter co bogofilter + + b. Installing + ------------- + + To compile and install the standard configuration, use the following + commands: + + cd bogofilter [change to project directory] + ./autogen.sh [add configure options as required] + make + make install [as root] + + You will need a full set of development tools installed to be able + to run autogen.sh, including recent automake (1.7) and autoconf + (2.5X). + + c. Configuring + -------------- + + After using ./autogen.sh, which builds the standard configuration + and runs "make check" to ensure it works in your environment and on + your hardware, you might wish to further customize bogofilter for + your use. + + Running "./configure --help" will list all the configuration + options. The most notable ones are: + + --prefix=PREFIX install architecture-independent files in PREFIX + [default: /usr/local] + --with-database=ENGINE Choose database engine {db|tdb|qdbm} + [default: db] + --with-libdb-prefix[=DIR] search for libdb in DIR/include and DIR/lib + + + d. Changing Bogofilter + ---------------------- + + If you make modifications to bogofilter, you may need to have a + recent DocBook XML tool chain, the xmlto program, PassiveTeX and + XMLTeX, recent versions of automake (1.7) and autoconf (2.5X). + + These requirements do not apply if you are building an unmodified + tarball. |