<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>bogotune</title><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"><a name="bogotune.1"></a><div class="titlepage"></div><div class="refnamediv"><a name="name"></a><h2>Name</h2><p>bogotune — find optimum parameter settings for
<span class="application">bogofilter</span> </p></div><div class="refsynopsisdiv"><a name="synopsis"></a><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">bogotune</code> [-v] [-c <em class="replaceable"><code>config</code></em>] [-C] [-d <em class="replaceable"><code>dir</code></em>] [-D] [-r <em class="replaceable"><code>value</code></em>] [-T <em class="replaceable"><code>value</code></em>] -n <em class="replaceable"><code>okfile</code></em> [[-n]
<em class="replaceable"><code>okfile</code></em> [...]] -s <em class="replaceable"><code>spamfile</code></em>
[[-s] <em class="replaceable"><code>spamfile</code></em> [...]] [-M <em class="replaceable"><code>file</code></em> ]</p></div><div class="cmdsynopsis"><p><code class="command">bogotune</code> [-h]</p></div></div><div class="refsect1"><a name="description"></a><h2>DESCRIPTION</h2><p><span class="application">Bogotune</span> tries to find optimum
parameter settings for <span class="application">bogofilter</span>. It
needs at least one set each of spam and non-spam messages. The
production wordlist is normally used, but it can be directed to
read a different wordlist, or to build its own from half the
supplied messages.</p><p>In order to produce useful results,
<span class="application">bogotune</span> has minimum message count
requirements. The wordlist it uses must have at least 2,000 spam
and 2,000 non-spam in it and the message files must contain at
least 500 spam and 500 non-spam messages. Also, the ratio of spam
to non-spam should be in the range 0.2 to 5. If you direct
<span class="application">bogotune</span> to build its own wordlist, it
will use the half the input or 2000 messages (whichever is larger)
for the wordlist.</p><p>Message files may be in mbox, maildir, or MH folder or any
combination. Msg-count files can also be used, but not mixed with
other formats.</p></div><div class="refsect1"><a name="options"></a><h2>OPTIONS</h2><p>The <code class="option">-h</code> option prints the help message and exits.</p><p>The <code class="option">-v</code> option increases the verbosity
level. Level 1 displays the scan output in detail instead of using a progress meter.</p><p>The <code class="option">-c</code> <em class="replaceable"><code>filename</code></em>
option tells <span class="application">bogofilter</span> to read the
config file named. </p><p>The <code class="option">-C</code> option prevents <span class="application">bogotune</span> from
reading a configuration file.</p><p>The <code class="option">-d</code> <em class="replaceable"><code>dir</code></em>
option specifies the directory for the database. See the
ENVIRONMENT section for other directory setting options.</p><p>The <code class="option">-D</code> option tells
<span class="application">bogotune</span> to build a wordlist in memory
using the input messages. The messages are read and divided into
two groups. The first group is used to build a wordlist (in ram)
and the second is used for tuning. To meet the minimum
requirements of 2000 messages in the wordlist and 500 messages for
testing, when <code class="option">-D</code> is used, there must be 2500
non-spam and 2500 spam in the input files. If there are enough
messages (more than 4000), they will be split evenly between
wordlist and testing. Otherwise, they will be split
proportionately.</p><p>The <code class="option">-n</code> option tells
<span class="application">bogotune</span> that the following argument
is a file (or folder) containing non-spam. Since version 1.0.3,
multiple arguments to the <code class="option">-n</code> option can be given.
All non-option arguments until the next <code class="option">-s</code> option
will be treated as though they had been preceded by
<code class="option">-n</code></p><p>The <code class="option">-s</code> option tells
<span class="application">bogotune</span> that the following argument
is a file (or folder) containing spam. It can be repeated as often
as necessary. Since version 1.0.3, multiple arguments to the
<code class="option">-s</code> can be given. All non-option arguments until the
next <code class="option">-n</code> option will be treated as though they had
been preceded by <code class="option">-s</code>.</p><p>The <code class="option">-r <em class="replaceable"><code>value</code></em></code>
option tells <span class="application">bogotune</span> to use the
following parameter as the robx value.</p><p>The <code class="option">-T <em class="replaceable"><code>value</code></em></code>
option tells <span class="application">bogotune</span> to use the
following parameter as fp target value.</p><p>The <code class="option">-M <em class="replaceable"><code>file</code></em></code>
option tells <span class="application">bogotune</span> to convert the
file to message count format. This format provides a sorted list
of each message's unique tokens, along with their ham and spam
counts. Sorting hides the sense of the messages quite
effectively, thus protecting privacy. The message-count format
allows <span class="application">bogotune</span> and
<span class="application">bogofilter</span> to score messages quickly
without needing the original token database. </p></div><div class="refsect1"><a name="environment"></a><h2>ENVIRONMENT</h2><p><span class="application">Bogofilter</span> uses a database directory,
which can be set in the config file. If not set there,
<span class="application">bogofilter</span> will use the value of
<code class="envar">BOGOFILTER_DIR</code>. Both can be overridden by the
<code class="option">-d<em class="replaceable"><code>dir</code></em></code> option. If none
of that is available, <span class="application">bogofilter</span> will use
directory <code class="filename">$HOME/.bogofilter</code>.</p></div><div class="refsect1"><a name="idm46002185261264"></a><h2>Bugs</h2><p><span class="application">Bogotune</span> is not particularly robust when presented with garbage input.
</p></div><div class="refsect1"><a name="author"></a><h2>AUTHOR</h2><p>The <span class="application">bogofilter</span> developer team.</p><p>
For updates, see <a class="ulink" href="http://bogofilter.sourceforge.net/" target="_top">
the bogofilter project page</a>.
</p></div><div class="refsect1"><a name="also"></a><h2>SEE ALSO </h2><p>bogofilter(1), bogolexer(1), bogoupgrade(1), bogoutil(1)</p></div></div></body></html>