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