aboutsummaryrefslogtreecommitdiffstats
path: root/general/genutils/bogofilter.xml
blob: fedd2e62e5cc18d4e065690eaec6f00185bdd3d5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY bogofilter-download-http "&sourceforge-dl;/bogofilter/bogofilter-&bogofilter-version;.tar.xz">
  <!ENTITY bogofilter-download-ftp  " ">
  <!ENTITY bogofilter-md5sum        "8763f87adfff7b802ced177d8c654539">
  <!ENTITY bogofilter-size          "784 KB">
  <!ENTITY bogofilter-buildsize     "19 MB">
  <!ENTITY bogofilter-time          "0.1 SBU">
]>

<sect1 id="bogofilter" xreflabel="Bogofilter-&bogofilter-version;">
  <?dbhtml filename="bogofilter.html"?>


  <title>Bogofilter-&bogofilter-version;</title>

  <indexterm zone="bogofilter">
    <primary sortas="a-Bogofilter">Bogofilter</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Bogofilter</title>

    <para>
      The <application>Bogofilter</application> application is a mail filter that classifies
      mail as spam or ham (non-spam) by a statistical analysis of the message's header and
      content (body).
    </para>

    &lfs121_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&bogofilter-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&bogofilter-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &bogofilter-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &bogofilter-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &bogofilter-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &bogofilter-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Bogofilter Dependencies</bridgehead>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gsl"/>,
      <xref linkend="libxml2"/>, and
      <!-- 'required' to make this strong to jhalfs -->
      <xref role='required' linkend="sqlite"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="lmdb"/>,
      <xref linkend="xmlto"/>,
      &berkeley-db;,
      <ulink url="https://dbmx.net/qdbm/">QDBM</ulink> and
      <ulink url="https://dbmx.net/tokyocabinet/">TokyoCabinet</ulink>
    </para>

    <note>
      <para>
        If you do not install the recommended <xref linkend="gsl"/> package
        then a statically linked shipped version will be used instead.
      </para>
    </note>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Bogofilter</title>

    <note>
      <para>
        If you plan to change the version of your database library on an
        existing installation, or to change to a different database, read the
        warning at the top of the RELEASE.NOTES file.
      </para>
    </note>

    <para>
      Install <application>Bogofilter</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr                \
            --sysconfdir=/etc/bogofilter \
            --with-database=sqlite3      &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue <command>make check</command>.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>--with-database=sqlite3</parameter>: This switch makes
      Bogofilter use <xref linkend='sqlite'/> as the database, instead of
      Berkeley DB<!-- which is beyond the scope of BLFS (slated for removal)-->.
    </para>

    <para>
      <option>--with-database={lmdb,qdbm,tokyocabinet}</option>: This switch
      also allows to use lmdb, qdbm, or tokyocabinet as the database.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          bf_compact, bf_copy, bf_tar, bogofilter, bogolexer, bogotune,
          bogoupgrade and bogoutil
        </seg>
        <seg>
          None
        </seg>
        <seg>
          /etc/bogofilter
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="bf_compact">
        <term><command>bf_compact</command></term>
        <listitem>
          <para>
            creates a more compact bogofilter working directory with a
            dump/load cycle
          </para>
          <indexterm zone="bogofilter bf_compact">
            <primary sortas="b-bf_compact">bf_compact</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="bf_copy">
        <term><command>bf_copy</command></term>
        <listitem>
          <para>
            copies a bogofilter working directory to another directory
          </para>
          <indexterm zone="bogofilter bf_copy">
            <primary sortas="b-bf_copy">bf_copy</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="bf_tar">
        <term><command>bf_tar</command></term>
        <listitem>
          <para>
            bundles a bogofilter working directory in tar format and
            copies it to standard output
          </para>
          <indexterm zone="bogofilter bf_tar">
            <primary sortas="b-bf_tar">bf_tar</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="bogofilter-prog">
        <term><command>bogofilter</command></term>
        <listitem>
          <para>
            is a fast Bayesian spam filter
          </para>
          <indexterm zone="bogofilter bogofilter-prog">
            <primary sortas="b-bogofilter">bogofilter</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="bogolexer">
        <term><command>bogolexer</command></term>
        <listitem>
          <para>
            is used to separate messages into tokens and to test new
            versions of the lexer.l code
          </para>
          <indexterm zone="bogofilter bogolexer">
            <primary sortas="b-bogolexer">bogolexer</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="bogotune">
        <term><command>bogotune</command></term>
        <listitem>
          <para>
            attempts to find optimum parameter settings for bogofilter
          </para>
          <indexterm zone="bogofilter bogotune">
            <primary sortas="b-bogotune">bogotune</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="bogoupgrade">
        <term><command>bogoupgrade</command></term>
        <listitem>
          <para>
            upgrades the bogofilter database to the current version
          </para>
          <indexterm zone="bogofilter bogoupgrade">
            <primary sortas="b-bogoupgrade">bogoupgrade</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="bogoutil">
        <term><command>bogoutil</command></term>
        <listitem>
          <para>
            dumps, loads, and maintains bogofilter database files
          </para>
          <indexterm zone="bogofilter bogoutil">
            <primary sortas="b-bogoutil">bogoutil</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>