1 Bogofilter -- fast Bayesian spam filtering 2 3Summary: 4 50. Important 61. What is Bogofilter? 72. Documentation 83. Installing Bogofilter 94. How to contribute 105. How to request features 116. Building & Installing Bogofilter from Source Tarball or Git 12 a. Downloading 13 b. Building & Installing 14 c. Configuring 15 d. Changing Bogofilter 167. License 17 18 190. IMPORTANT 20------------ 21 22If you are using bogofilter with the Berkeley DB data base library 23(which is the default, received most testing, is the most powerful of 24the data base engines that bogofilter supports and hence recommended), 25do read the doc/README.db file, it contains important information. 26 27The doc/README.db file contains troubleshooting information and 28requirements that should be read ahead of time so you can fix problems 29quickly should they arise later. 30 31 321. What is Bogofilter? 33---------------------- 34 35Bogofilter is a fast Bayesian spam filter along the lines suggested by 36Paul Graham in his article "A Plan For Spam": 37 38 http://www.paulgraham.com/spam.html 39 40with algorithmic changes suggested by Gary Robinson in: 41 42 http://radio.weblogs.com/0101454/stories/2002/09/16/spamDetection.html 43 44and in "A Statistical Approach to the Spam Problem": 45 46 http://www.linuxjournal.com/article.php?sid=6467 47 48This version improves on the papers by doing smarter lexical analysis. 49In particular, hostames and IP addresses are retained as recognition 50features rather than broken up. Various kinds of MTA cruft such as 51dates and message-IDs are discarded so as not to bloat the word lists. 52 53 542. Documentation 55---------------- 56 57It is recommended, although not necessary, that you install the GNU 58Scientific Library (GSL) version 1.4 or newer before configuring 59bogofilter. This allows bogofilter to link dynamically against a 60system-wide GSL rather than statically against a shipped GSL subset, 61conserving memory and disk space. 62 63When installed, there are man pages for bogofilter, bogoutil, 64bogolexer, and bogoupgrade. Additional documentation is in 65/usr/share/doc/bogofilter-x.y.z or comparable directory (depending on 66your operating system). 67 68If you've installed the source code, the doc directory and its 69subdirectories contain most of bogofilter's documentation. In it are 70a variety of README files, the xml originals for the man pages , and 71other documents. Additionally, many of the directories in the 72bogofilter hierarchy have their own README files. 73 74If you use mutt, see the bogofilter(1) manual page for helpful macros 75you can add to your .muttrc. 76 77 783. Installing Bogofilter 79---------------------- 80 81When updating, check the RELEASE.NOTES files. 82 83For fresh installs, check the rest of this file and the INSTALL file. 84 85You can safely ignore any of these compile time warnings: 86 87warning: unused parameter ... 88warning: format not a string literal, argument types not checked 89 90 914. How to contribute 92-------------------- 93 94The best way to contribute to bogofilter is through the bogofilter 95mailing list, bogofilter@bogofilter.org. You can subscribe to it by 96sending a message to bogofilter-subscribe@bogofilter.org and 97responding to the confirmation message it sends to you. More 98information is available on the bogofilter home page at 99http://www.bogofilter.org/ or http://bogofilter.sourceforge.net/ 100 101Bugs can be reported via the bogfilter mailing list or through the 102issue trackers: 103https://gitlab.com/bogofilter/bogofilter/issues 104http://sourceforge.net/tracker/?atid=499997&group_id=62265&func=browse 105 106If you have code to contribute, please post it on the bogofilter 107mailing list or file it to one of the issue trackers (Gitlab preferred). 108 109 1105. How to request features 111-------------------------- 112 113Ask around in the bogofilter mailing list. The idea may have been 114already suggested, considered, accepted, rejected, ... You won't know 115until you ask! 116 117Alternatively, you might want to hack at the code and develop the 118feature on your own, which would be great! You can then send a patch 119to the list. 120 121 1226. Building & Installing Bogofilter from Source Tarball or Git 123-------------------------------------------------------------- 124 125 a. Downloading 126 -------------- 127 128 The most recent version of this software is available at: 129 130 http://sourceforge.net/projects/bogofilter/ 131 132 The latest stable version can be downloaded. The development source 133 is in a Subversion repository on SourceForge. To download the latest Git 134 source, cd to the directory to which you wish to download and type 135 EITHER ONE of the following commands: 136 137 git clone https://gitlab.com/bogofilter/bogofilter.git 138 OR 139 git clone git://git.code.sf.net/p/bogofilter/git bogofilter-git 140 141 b. Building & Installing 142 ------------------------ 143 144 To compile and install the standard configuration from a tarball, use 145 the following commands: 146 147 cd bogofilter-1.2.5 [change to project directory] 148 ./configure [add configure options as required] 149 make all check 150 make install [as root] 151 152 To compile and install the standard configuration from Git, use 153 the following commands: 154 155 cd bogofilter [change to project directory] 156 ./autogen.sh [add configure options as required] 157 make install [as root] 158 159 Be sure to read README.git for additional preparations required. 160 161 You will need a full set of development tools installed to be able 162 to run autogen.sh, including recent automake and autoconf. 163 164 configure does not have these requirements. 165 166 c. Configuring 167 -------------- 168 169 After using ./autogen.sh, which builds the standard configuration 170 and runs "make check" to ensure it works in your environment and on 171 your hardware, you might wish to further customize bogofilter for 172 your use. 173 174 Running "./configure --help" will list all the configuration 175 options. The most notable ones are, with examples: 176 177 --prefix=PREFIX install architecture-independent files in PREFIX 178 [default: /usr/local] 179 --with-database=ENGINE Choose database engine 180 {db|qdbm|sqlite3|tokyocabinet|kyotocabinet|lmdb} 181 [default: db] 182 CPPFLAGS=-I/opt/csw/include 183 Choose additional include file path /opt/csw/include 184 LDFLAGS=-L/opt/csw/lib Ditto, for library files 185 186 d. Changing Bogofilter 187 ---------------------- 188 189 If you make modifications to bogofilter, you may need to have a 190 recent DocBook XML tool chain, the xmlto program, PassiveTeX and 191 XMLTeX, recent versions of automake and autoconf. 192 193 These requirements do not apply if you are building an unmodified 194 tarball. 195 196 1977. License 198---------- 199 200Bogofilter is offered under the GNU General Public License, 201see the COPYING file for details. Note that some parts, especially in 202the contrib/ section or scripts, may be under a different license. 203