[bb535118] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[8dfc5c3] | 7 | <!ENTITY bogofilter-download-http "&sourceforge-dl;/bogofilter/bogofilter-&bogofilter-version;.tar.gz">
|
---|
[bb535118] | 8 | <!ENTITY bogofilter-download-ftp " ">
|
---|
[c45eca2] | 9 | <!ENTITY bogofilter-md5sum "94aee3ced558c2a354547083735f2ba7">
|
---|
[bb535118] | 10 | <!ENTITY bogofilter-size "1.9 MB">
|
---|
| 11 | <!ENTITY bogofilter-buildsize "16 MB">
|
---|
| 12 | <!ENTITY bogofilter-time "0.1 SBU">
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="bogofilter" xreflabel="Bogofilter-&bogofilter-version;" revision="systemd">
|
---|
| 16 | <?dbhtml filename="bogofilter.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>Bogofilter-&bogofilter-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="bogofilter">
|
---|
| 26 | <primary sortas="a-Bogofilter">Bogofilter</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to Bogofilter</title>
|
---|
| 31 |
|
---|
| 32 | <para>
|
---|
[e4758caa] | 33 | The <application>Bogofilter</application> application is a mail filter that classifies
|
---|
[bb535118] | 34 | mail as spam or ham (non-spam) by a statistical analysis of the message's header and
|
---|
| 35 | content (body).
|
---|
| 36 | </para>
|
---|
| 37 |
|
---|
[cf475801] | 38 | &lfs83_checked;
|
---|
[bb535118] | 39 |
|
---|
| 40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 41 | <itemizedlist spacing="compact">
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>
|
---|
| 44 | Download (HTTP): <ulink url="&bogofilter-download-http;"/>
|
---|
| 45 | </para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>
|
---|
| 49 | Download (FTP): <ulink url="&bogofilter-download-ftp;"/>
|
---|
| 50 | </para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>
|
---|
| 54 | Download MD5 sum: &bogofilter-md5sum;
|
---|
| 55 | </para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>
|
---|
| 59 | Download size: &bogofilter-size;
|
---|
| 60 | </para>
|
---|
| 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
| 63 | <para>
|
---|
| 64 | Estimated disk space required: &bogofilter-buildsize;
|
---|
| 65 | </para>
|
---|
| 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
| 68 | <para>
|
---|
| 69 | Estimated build time: &bogofilter-time;
|
---|
| 70 | </para>
|
---|
| 71 | </listitem>
|
---|
| 72 | </itemizedlist>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect3">Bogofilter Dependencies</bridgehead>
|
---|
| 75 |
|
---|
| 76 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 77 | <para role="required">
|
---|
| 78 | <xref linkend="db"/>
|
---|
| 79 | </para>
|
---|
| 80 |
|
---|
| 81 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 82 | <para role="recommended">
|
---|
| 83 | <xref linkend="gsl"/>
|
---|
| 84 | </para>
|
---|
| 85 |
|
---|
| 86 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 87 | <para role="optional">
|
---|
| 88 | <xref linkend="sqlite"/>,
|
---|
| 89 | <ulink url="http://fallabs.com/qdbm/">QDBM</ulink> and
|
---|
| 90 | <ulink url="http://fallabs.com/tokyocabinet/">TokyoCabinet</ulink>
|
---|
| 91 | </para>
|
---|
| 92 |
|
---|
| 93 | <note>
|
---|
| 94 | <para>
|
---|
| 95 | If you do not install the recommended <xref linkend="gsl"/> package
|
---|
| 96 | then a statically linked shipped version will be used instead.
|
---|
| 97 | </para>
|
---|
| 98 | </note>
|
---|
| 99 |
|
---|
| 100 | <para condition="html" role="usernotes">
|
---|
| 101 | User Notes: <ulink url="&blfs-wiki;/bogofilter"/>
|
---|
| 102 | </para>
|
---|
| 103 | </sect2>
|
---|
| 104 |
|
---|
| 105 | <sect2 role="installation">
|
---|
| 106 | <title>Installation of Bogofilter</title>
|
---|
| 107 |
|
---|
[ef0d8f4] | 108 | <note>
|
---|
| 109 | <para>
|
---|
| 110 | If you plan to change the version of your database library on an
|
---|
| 111 | existing installation, or to change to a different database, read the
|
---|
| 112 | warning at the top of the RELEASE.NOTES file.
|
---|
| 113 | </para>
|
---|
| 114 | </note>
|
---|
| 115 |
|
---|
[bb535118] | 116 | <para>
|
---|
| 117 | Install <application>Bogofilter</application> by running the following
|
---|
| 118 | commands:
|
---|
| 119 | </para>
|
---|
| 120 |
|
---|
| 121 | <screen><userinput>./configure --prefix=/usr --sysconfdir=/etc/bogofilter &&
|
---|
| 122 | make</userinput></screen>
|
---|
| 123 |
|
---|
| 124 | <para>
|
---|
| 125 | This application does not come with a test suite.
|
---|
| 126 | </para>
|
---|
| 127 |
|
---|
| 128 | <para>
|
---|
| 129 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 130 | </para>
|
---|
| 131 |
|
---|
| 132 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 133 |
|
---|
| 134 | </sect2>
|
---|
| 135 |
|
---|
| 136 | <sect2 role="commands">
|
---|
| 137 | <title>Command Explanations</title>
|
---|
| 138 |
|
---|
| 139 | <para>
|
---|
| 140 | <option>--with-database=</option>: This switch allows you to change
|
---|
| 141 | the default database from db to either qdbm, sqlite3 or tokyocabinet.
|
---|
| 142 | </para>
|
---|
| 143 |
|
---|
| 144 | </sect2>
|
---|
| 145 |
|
---|
| 146 | <sect2 role="content">
|
---|
| 147 | <title>Contents</title>
|
---|
| 148 |
|
---|
| 149 | <segmentedlist>
|
---|
| 150 | <segtitle>Installed Programs</segtitle>
|
---|
| 151 | <segtitle>Installed Libraries</segtitle>
|
---|
| 152 | <segtitle>Installed Directories</segtitle>
|
---|
| 153 |
|
---|
| 154 | <seglistitem>
|
---|
| 155 | <seg>
|
---|
| 156 | bf_compact, bf_copy, bf_tar, bogofilter, bogolexer, bogotune,
|
---|
| 157 | bogoupgrade and bogoutil
|
---|
| 158 | </seg>
|
---|
| 159 | <seg>
|
---|
| 160 | None
|
---|
| 161 | </seg>
|
---|
| 162 | <seg>
|
---|
| 163 | /etc/bogofilter
|
---|
| 164 | </seg>
|
---|
| 165 | </seglistitem>
|
---|
| 166 | </segmentedlist>
|
---|
| 167 |
|
---|
| 168 | <variablelist>
|
---|
| 169 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 170 | <?dbfo list-presentation="list"?>
|
---|
| 171 | <?dbhtml list-presentation="table"?>
|
---|
| 172 |
|
---|
| 173 | <varlistentry id="bf_compact">
|
---|
| 174 | <term><command>bf_compact</command></term>
|
---|
| 175 | <listitem>
|
---|
| 176 | <para>
|
---|
| 177 | creates a more compact bogofilter working directory with a
|
---|
| 178 | dump/load cycle.
|
---|
| 179 | </para>
|
---|
| 180 | <indexterm zone="bogofilter bf_compact">
|
---|
| 181 | <primary sortas="b-bf_compact">bf_compact</primary>
|
---|
| 182 | </indexterm>
|
---|
| 183 | </listitem>
|
---|
| 184 | </varlistentry>
|
---|
| 185 |
|
---|
| 186 | <varlistentry id="bf_copy">
|
---|
| 187 | <term><command>bf_copy</command></term>
|
---|
| 188 | <listitem>
|
---|
| 189 | <para>
|
---|
| 190 | copies a bogofilter working directory to another directory.
|
---|
| 191 | </para>
|
---|
| 192 | <indexterm zone="bogofilter bf_copy">
|
---|
| 193 | <primary sortas="b-bf_copy">bf_copy</primary>
|
---|
| 194 | </indexterm>
|
---|
| 195 | </listitem>
|
---|
| 196 | </varlistentry>
|
---|
| 197 |
|
---|
| 198 | <varlistentry id="bf_tar">
|
---|
| 199 | <term><command>bf_tar</command></term>
|
---|
| 200 | <listitem>
|
---|
| 201 | <para>
|
---|
| 202 | bundles a bogofilter working directory in tar format and
|
---|
| 203 | copies it to standard output.
|
---|
| 204 | </para>
|
---|
| 205 | <indexterm zone="bogofilter bf_tar">
|
---|
| 206 | <primary sortas="b-bf_tar">bf_tar</primary>
|
---|
| 207 | </indexterm>
|
---|
| 208 | </listitem>
|
---|
| 209 | </varlistentry>
|
---|
| 210 |
|
---|
| 211 | <varlistentry id="bogofilter-prog">
|
---|
| 212 | <term><command>bogofilter</command></term>
|
---|
| 213 | <listitem>
|
---|
| 214 | <para>
|
---|
| 215 | is a fast Bayesian spam filter.
|
---|
| 216 | </para>
|
---|
| 217 | <indexterm zone="bogofilter bogofilter-prog">
|
---|
| 218 | <primary sortas="b-bogofilter">bogofilter</primary>
|
---|
| 219 | </indexterm>
|
---|
| 220 | </listitem>
|
---|
| 221 | </varlistentry>
|
---|
| 222 |
|
---|
| 223 | <varlistentry id="bogolexer">
|
---|
| 224 | <term><command>bogolexer</command></term>
|
---|
| 225 | <listitem>
|
---|
| 226 | <para>
|
---|
| 227 | used to separate messages into tokens and to test new
|
---|
| 228 | versions of the lexer.l code.
|
---|
| 229 | </para>
|
---|
| 230 | <indexterm zone="bogofilter bogolexer">
|
---|
| 231 | <primary sortas="b-bogolexer">bogolexer</primary>
|
---|
| 232 | </indexterm>
|
---|
| 233 | </listitem>
|
---|
| 234 | </varlistentry>
|
---|
| 235 |
|
---|
| 236 | <varlistentry id="bogotune">
|
---|
| 237 | <term><command>bogotune</command></term>
|
---|
| 238 | <listitem>
|
---|
| 239 | <para>
|
---|
| 240 | tries to find optimum parameter settings for bogofilter.
|
---|
| 241 | </para>
|
---|
| 242 | <indexterm zone="bogofilter bogotune">
|
---|
| 243 | <primary sortas="b-bogotune">bogotune</primary>
|
---|
| 244 | </indexterm>
|
---|
| 245 | </listitem>
|
---|
| 246 | </varlistentry>
|
---|
| 247 |
|
---|
| 248 | <varlistentry id="bogoupgrade">
|
---|
| 249 | <term><command>bogoupgrade</command></term>
|
---|
| 250 | <listitem>
|
---|
| 251 | <para>
|
---|
| 252 | upgrades bogofilter database to current version.
|
---|
| 253 | </para>
|
---|
| 254 | <indexterm zone="bogofilter bogoupgrade">
|
---|
| 255 | <primary sortas="b-bogoupgrade">bogoupgrade</primary>
|
---|
| 256 | </indexterm>
|
---|
| 257 | </listitem>
|
---|
| 258 | </varlistentry>
|
---|
| 259 |
|
---|
| 260 | <varlistentry id="bogoutil">
|
---|
| 261 | <term><command>bogoutil</command></term>
|
---|
| 262 | <listitem>
|
---|
| 263 | <para>
|
---|
| 264 | dumps, loads, and maintains bogofilter database files.
|
---|
| 265 | </para>
|
---|
| 266 | <indexterm zone="bogofilter bogoutil">
|
---|
| 267 | <primary sortas="b-bogoutil">bogoutil</primary>
|
---|
| 268 | </indexterm>
|
---|
| 269 | </listitem>
|
---|
| 270 | </varlistentry>
|
---|
| 271 |
|
---|
| 272 | </variablelist>
|
---|
| 273 |
|
---|
| 274 | </sect2>
|
---|
| 275 |
|
---|
| 276 | </sect1>
|
---|