~ubuntu-branches/ubuntu/oneiric/bogofilter/oneiric

.\"Generated by db2man.xsl. Don't modify this, modify the source.

.de Sh \" Subsection

.br

.if t .Sp

.ne 5

.PP

\fB\\$1\fR

.PP

..

.de Sp \" Vertical space (when we can't use .PP)

.if t .sp .5v

.if n .sp

..

.de Ip \" List item

.br

.ie \\n(.$>=3 .ne \\$3

.el .ne 3

.IP "\\$1" \\$2

..

.TH "BOGOUTIL" 1 "" "" ""

.SH NAME

bogoutil \- Dumps, loads, and maintains bogofilter database files

.SH "SYNOPSIS"

.ad l

.hy 0

.HP 9

\fBbogoutil\fR [options] {\fB\-d\ \fIfile\fR\fR | \fB\-H\fR | \fB\-l\ \fIfile\fR\fR | \fB\-m\fR | \fB\-w\ \fIfile_or_dir\fR\fR | \fB\-p\ \fIfile_or_dir\fR\fR} \fIfile\&.db\fR

.ad

.hy

.ad l

.hy 0

.HP 9

\fBbogoutil\fR {\fB\-r\fR | \fB\-R\fR} \fIdirectory\fR

.ad

.hy

.ad l

.hy 0

.HP 9

\fBbogoutil\fR {\fB\-h\fR | \fB\-V\fR}

.ad

.hy

 

.PP

where \fBoptions\fR is

.ad l

.hy 0

.HP 1

[\-v] [\-n] [\-D] [\-a\ \fIage\fR] [\-c\ \fIcount\fR] [\-s\ \fImin,max\fR] [\-y\ \fIdate\fR] [\-I\ \fIfile\fR] [\-x\ \fIflags\fR]

.ad

.hy

 

.SH "DESCRIPTION"

 

.PP

Bogoutil is part of the bogofilter Bayesian spam filter package\&.

 

.PP

It is used to dump and load bogofilter's Berkeley DB databases to and from text files, perform database maintenance functions, and to display the values for specific words\&.

 

.SH "OPTIONS"

 

.PP

The \fB\-d \fIfile\fR\fR option tells bogoutil to print the contents of the database file to \fBstdout\fR\&.

 

.PP

The \fB\-H \fIfile_or_dir\fR\fR option tells bogoutil to print a histogram of the specified database file to \fBstdout\fR\&. The output is similar to bogofilter \-vv\&. Finally, hapaxes (tokens which were only seen once) and pure tokens (tokens which were encountered only in ham or only in spam) are counted\&.

 

.PP

The \fB\-l \fIfile\fR\fR option tells bogoutil to load to load the data from \fBstdin\fR into the database file\&.

 

.PP

The \fB\-m\fR option tells bogoutil to perform maintenance functions on the specified database, i\&.e\&. discard tokens that are older than desired, have counts that are too small, or sizes (lengths) that are too long or too short\&.

 

.PP

The \fB\-w \fIfile_or_dir\fR\fR option tells bogoutil to display token information from the database\&. The option takes an argument, which is either the name of the wordlist (usually wordlist\&.db) or the name of the directory containing it\&. Tokens can be listed on the command line or piped to bogoutil\&. When there are extra arguments on the command line, bogoutil will use them as the tokens to lookup\&. If there are no extra arguments, bogoutil will read tokens from \fBstdin\fR\&.

 

.PP

The \fB\-p \fIfile_or_dir\fR\fR option tells bogoutil to display the database information for one or more tokens\&. The display includes a probability column with the token's spam score (computed using bogofilter's default values)\&. Option \fB\-p\fR takes the same arguments as option \fB\-w\fR \&.

 

.PP

The \fB\-r\fR option tells bogoutil to recalculate the ROBX value and print it as a six\-digit fraction\&.

 

.PP

The \fB\-R\fR option does the same as \fB\-r\fR, but prints more information and saves the result in the training database\&.

 

.PP

The \fB\-I \fIfile\fR\fR option tells bogoutil to read its input from \fIfile\fR rather than stdin\&.

 

.PP

The \fB\-v\fR option produces verbose output on \fBstderr\fR\&. This option is primarily useful for debugging\&.

 

.PP

The \fB\-D\fR redirects debug output to stdout (it usually goes to stderr)\&.

 

.PP

The \fB\-x \fIflags\fR\fR option sets debugging flags\&.

 

.PP

Option \fB\-n\fR stands for "replace non\-ascii characters"\&. It will replace characters with the high bit (0x80) by question marks\&. This can be useful if a word list has lots of unreadable tokens, for example from asian spam\&. The "bad" characters will be converted to question marks and matching tokens will be combined when used with '\-m' or '\-l', but not with '\-d'\&.

 

.PP

Option \fB\-a age\fR indicates an acceptable token age, with older ones being discarded\&. The age can be a date (in form YYYYMMMDD) or a day count, i\&.e\&. discard tokens older than \fBage\fR days\&.

 

.PP

Option \fB\-c value\fR indicates that tokens with counts less than or equal to \fBvalue\fR are to be discarded\&.

 

.PP

Option \fB\-s min,max\fR is used to discard tokens based on their size, i\&.e\&. length\&. All tokens shorter than \fBmin\fR or longer than \fBmax\fR will be discarded\&.

 

.PP

Option \fB\-y date\fR is specifies the date to give to tokens that don't have dates\&.

 

.PP

The \fB\-h\fR option prints the help message and exits\&.

 

.PP

The \fB\-V\fR option prints the version number and exits\&.

 

.SH "DATA FORMAT"

 

.PP

 Bogoutil reads and writes text files where each nonblank line consists of a word, any amount of horizontal whitespace, a numeric word count, more whitespace, and (optionally) a date in form YYYYMMDD\&. Blank lines are skipped\&.

 

.SH "RETURN VALUES"

 

.PP

0 for successful operation\&. 1 for most errors\&. 3 for I/O or other errors\&. Error 3 usually means that something is seriously wrong with the database files\&.

 

.SH "AUTHOR"

 

.PP

Gyepi Sam <gyepi@praxis\-sw\&.com>\&.

 

.PP

Matthias Andree <matthias\&.andree@gmx\&.de>\&.

 

.PP

David Relson <relson@osagesoftware\&.com>\&.

 

.PP

For updates, see the bogofilter project page: \fIhttp://bogofilter.sourceforge.net/\fR\&.