 |
bmf.1 - bmf - bmf (Bayesian Mail Filter) 0.9.4 fork + patches |
 |
git clone git://git.codemadness.org/bmf |
 |
Log |
|
Files |
|
Refs |
|
README |
|
LICENSE |
|
--- |
|
bmf.1 (4854B) |
|
--- |
|
1 .\"Generated by db2man.xsl. Don't modify this, modify the source. |
|
2 .de Sh \" Subsection |
|
3 .br |
|
4 .if t .Sp |
|
5 .ne 5 |
|
6 .PP |
|
7 \fB\\$1\fR |
|
8 .PP |
|
9 .. |
|
10 .de Sp \" Vertical space (when we can't use .PP) |
|
11 .if t .sp .5v |
|
12 .if n .sp |
|
13 .. |
|
14 .de Ip \" List item |
|
15 .br |
|
16 .ie \\n(.$>=3 .ne \\$3 |
|
17 .el .ne 3 |
|
18 .IP "\\$1" \\$2 |
|
19 .. |
|
20 .TH "BMF" 1 "" "" "" |
|
21 .SH NAME |
|
22 bmf \- efficient Bayesian mail filter |
|
23 .SH "SYNOPSIS" |
|
24 |
|
25 .nf |
|
26 \fBbmf\fR [-b] [-t] [-n] [-s] [-N] [-S] [-d db] [-k n] [-m type] [-p] |
|
27 [-v] [-V] [-h] |
|
28 .fi |
|
29 |
|
30 .SH "DESCRIPTION" |
|
31 |
|
32 .PP |
|
33 bmf is a Bayesian mail filter. In its normal mode of operation, it takes… |
|
34 |
|
35 .PP |
|
36 bmf supports both mbox and maildir mail storage formats. It will automat… |
|
37 |
|
38 .SH "OPTIONS" |
|
39 |
|
40 .PP |
|
41 Without command-line options, bmf processes the input, registers it as e… |
|
42 |
|
43 .PP |
|
44 \fB-b\fR Bulk test mode, read file list from stdin, output file, TAB, sp… |
|
45 |
|
46 .PP |
|
47 \fB-t\fR Test to see if the input is spam. The word lists are not update… |
|
48 |
|
49 .PP |
|
50 \fB-n\fR Register the input as non-spam. |
|
51 |
|
52 .PP |
|
53 \fB-s\fR Register the input as spam. |
|
54 |
|
55 .PP |
|
56 \fB-N\fR Register the input as non-spam and undo a prior registration as… |
|
57 |
|
58 .PP |
|
59 \fB-S\fR Register the input as spam and undo a prior registration as non… |
|
60 |
|
61 .PP |
|
62 \fB-d db\fR Specify database or directory for loading and saving word li… |
|
63 |
|
64 .PP |
|
65 \fB-k n\fR Specify the number of extrema (keepers) to use in the Bayes c… |
|
66 |
|
67 .PP |
|
68 \fB-m fmt\fR Specify mail storage format. Valid formats are mbox and mai… |
|
69 |
|
70 .PP |
|
71 \fB-p\fR Copy the input to the output (passthrough) and insert spam head… |
|
72 |
|
73 .PP |
|
74 \fB-v\fR Be more verbose. This option is not well supported yet. |
|
75 |
|
76 .PP |
|
77 \fB-V\fR Display version information. |
|
78 |
|
79 .PP |
|
80 \fB-h\fR Display usage information. |
|
81 |
|
82 .SH "THEORY OF OPERATION" |
|
83 |
|
84 .PP |
|
85 bmf treats its input as a bag of tokens. Each token is checked against "… |
|
86 |
|
87 .PP |
|
88 While this method sounds crude compared to the more usual pattern-matchi… |
|
89 |
|
90 .PP |
|
91 bmf improves on Paul's proposal by doing smarter lexical analysis. In pa… |
|
92 |
|
93 .PP |
|
94 MIME and other attachments are not decoded. Experience from watching the… |
|
95 |
|
96 .SH "INTEGRATION WITH OTHER TOOLS" |
|
97 |
|
98 .PP |
|
99 Please see the README for samples and suggestions. |
|
100 |
|
101 .SH "RETURN VALUES" |
|
102 |
|
103 .PP |
|
104 In passthrough mode: zero for success, nonzero for failure. |
|
105 |
|
106 .PP |
|
107 In non-passthrough mode: 0 for spam; 1 for non-spam; 2 for I/O or other … |
|
108 |
|
109 .SH "FILES" |
|
110 |
|
111 .TP |
|
112 \fI~/.bmf/goodlist.txt\fR |
|
113 List of good tokens for text mode. |
|
114 |
|
115 .TP |
|
116 \fI~/.bmf/spamlist.txt\fR |
|
117 List of bad tokens for text mode. |
|
118 |
|
119 .SH "BUGS" |
|
120 |
|
121 .PP |
|
122 The lexer should recognize multiline headers. |
|
123 |
|
124 .PP |
|
125 The lexer should recognize MIME attachments. |
|
126 |
|
127 .PP |
|
128 Content-Transfer-Encoding is not decoded. |
|
129 |
|
130 .SH "AUTHOR" |
|
131 |
|
132 .PP |
|
133 Tom Marshall <[email protected]>. |
|
134 |
|
135 .PP |
|
136 The Bayes algorithm is from bogofilter by Eric S. Raymond <[email protected]… |
|
137 |
