source-git / bogofilter

Clone
Source Code
GIT

Blame doc/bogotune.htmlin

c8 c8s master
  1.   c8
  2.   doc
  3.   bogotune.htmlin
Blob History Raw
Packit Service 8f0814 
<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">
Name
bogotune —  find optimum parameter settings for
Packit Service 8f0814 
    bogofilter 
Synopsis
bogotune  [-v] [-c config] [-C] [-d dir] [-D] [-r value] [-T value]  -n okfile [[-n]
Packit Service 8f0814 
	     okfile [...]]   -s spamfile
Packit Service 8f0814 
	     [[-s] spamfile [...]]  [-M file ]
bogotune  [-h]
DESCRIPTION
Bogotune tries to find optimum
Packit Service 8f0814 
    parameter settings for bogofilter.  It
Packit Service 8f0814 
    needs at least one set each of spam and non-spam messages.  The
Packit Service 8f0814 
    production wordlist is normally used, but it can be directed to
Packit Service 8f0814 
    read a different wordlist, or to build its own from half the
Packit Service 8f0814 
    supplied messages.
In order to produce useful results,
Packit Service 8f0814 
    bogotune has minimum message count
Packit Service 8f0814 
    requirements.  The wordlist it uses must have at least 2,000 spam
Packit Service 8f0814 
    and 2,000 non-spam in it and the message files must contain at
Packit Service 8f0814 
    least 500 spam and 500 non-spam messages.  Also, the ratio of spam
Packit Service 8f0814 
    to non-spam should be in the range 0.2 to 5.  If you direct
Packit Service 8f0814 
    bogotune to build its own wordlist, it
Packit Service 8f0814 
    will use the half the input or 2000 messages (whichever is larger)
Packit Service 8f0814 
    for the wordlist.
Message files may be in mbox, maildir, or MH folder or any
Packit Service 8f0814 
    combination.  Msg-count files can also be used, but not mixed with
Packit Service 8f0814 
    other formats.
OPTIONS
The -h option prints the help message and exits.
The -v option increases the verbosity
Packit Service 8f0814 
    level.  Level 1 displays the scan output in detail instead of using a progress meter.
The -c filename
Packit Service 8f0814 
    option tells bogofilter to read the
Packit Service 8f0814 
    config file named.  
The -C option prevents bogotune from
Packit Service 8f0814 
    reading a configuration file.
The -d dir
Packit Service 8f0814 
    option specifies the directory for the database.  See the
Packit Service 8f0814 
    ENVIRONMENT section for other directory setting options.
The -D option tells
Packit Service 8f0814 
    bogotune to build a wordlist in memory
Packit Service 8f0814 
    using the input messages.  The messages are read and divided into
Packit Service 8f0814 
    two groups.  The first group is used to build a wordlist (in ram)
Packit Service 8f0814 
    and the second is used for tuning.  To meet the minimum
Packit Service 8f0814 
    requirements of 2000 messages in the wordlist and 500 messages for
Packit Service 8f0814 
    testing, when -D is used, there must be 2500
Packit Service 8f0814 
    non-spam and 2500 spam in the input files.  If there are enough
Packit Service 8f0814 
    messages (more than 4000), they will be split evenly between
Packit Service 8f0814 
    wordlist and testing.  Otherwise, they will be split
Packit Service 8f0814 
    proportionately.
The -n option tells
Packit Service 8f0814 
    bogotune that the following argument
Packit Service 8f0814 
    is a file (or folder) containing non-spam. Since version 1.0.3,
Packit Service 8f0814 
    multiple arguments to the -n option can be given.
Packit Service 8f0814 
    All non-option arguments until the next -s option
Packit Service 8f0814 
    will be treated as though they had been preceded by
Packit Service 8f0814 
    -n
The -s option tells
Packit Service 8f0814 
    bogotune that the following argument
Packit Service 8f0814 
    is a file (or folder) containing spam. It can be repeated as often
Packit Service 8f0814 
    as necessary. Since version 1.0.3, multiple arguments to the
Packit Service 8f0814 
    -s can be given. All non-option arguments until the
Packit Service 8f0814 
    next -n option will be treated as though they had
Packit Service 8f0814 
    been preceded by -s.
The -r value
Packit Service 8f0814 
    option tells bogotune to use the
Packit Service 8f0814 
    following parameter as the robx value.
The -T value
Packit Service 8f0814 
    option tells bogotune to use the
Packit Service 8f0814 
    following parameter as fp target value.
The -M file
Packit Service 8f0814 
    option tells bogotune to convert the
Packit Service 8f0814 
    file to message count format.  This format provides a sorted list
Packit Service 8f0814 
    of each message's unique tokens, along with their ham and spam
Packit Service 8f0814 
    counts.  Sorting hides the sense of the messages quite
Packit Service 8f0814 
    effectively, thus protecting privacy.  The message-count format
Packit Service 8f0814 
    allows bogotune and
Packit Service 8f0814 
    bogofilter to score messages quickly
Packit Service 8f0814 
    without needing the original token database.  
ENVIRONMENT
Bogofilter uses a database directory,
Packit Service 8f0814 
    which can be set in the config file.  If not set there,
Packit Service 8f0814 
    bogofilter will use the value of
Packit Service 8f0814 
    BOGOFILTER_DIR.  Both can be overridden by the
Packit Service 8f0814 
    -ddir option.  If none
Packit Service 8f0814 
    of that is available, bogofilter will use
Packit Service 8f0814 
    directory $HOME/.bogofilter.
Bugs
Bogotune is not particularly robust when presented with garbage input.
Packit Service 8f0814 
AUTHOR
The bogofilter developer team.
Packit Service 8f0814 
       For updates, see
Packit Service 8f0814 
       the bogofilter project page.
Packit Service 8f0814 
    
SEE ALSO 
bogofilter(1), bogolexer(1), bogoupgrade(1), bogoutil(1)
</body></html>

Powered by Pagure 5.14.1

SSH Hostkey/Fingerprint | Documentation