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