source: general/genutils/bogofilter.xml@ 785d5974

10.0 10.1 11.0 9.1 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 785d5974 was 785d5974, checked in by Xi Ruoyao <xry111@…>, 21 months ago

bogofilter: run test suite

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@22690 af4574ff-66df-0310-9fd7-8a98e5e911e0

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