root / README @ aebfd4cc
History | View | Annotate | Download (994 Bytes)
| 1 | SylFilter - a message filter |
|---|---|
| 2 | |
| 3 | Copyright (C) 2011 Hiroyuki Yamamoto <hiro-y@kcn.ne.jp> |
| 4 | Copyright (C) 2011 Sylpheed Development Team |
| 5 | |
| 6 | |
| 7 | About This Program |
| 8 | ================== |
| 9 | |
| 10 | This is SylFilter, a generic message filter library and command-line tools. |
| 11 | |
| 12 | SylFilter library provides simple but powerful C APIs and can be used from C |
| 13 | programs. |
| 14 | |
| 15 | SylFilter command-line tool can be used as a junk filter program like major |
| 16 | tools such as bogofilter and bsfilter etc. |
| 17 | |
| 18 | SylFilter is free software and distributed under the BSD-like license. |
| 19 | See COPYING for detail. |
| 20 | |
| 21 | Install |
| 22 | ======= |
| 23 | |
| 24 | This program requires GLib and QDBM. Install them before building. |
| 25 | |
| 26 | $ ./configure |
| 27 | $ make |
| 28 | $ sudo make install |
| 29 | |
| 30 | Usage |
| 31 | ===== |
| 32 | |
| 33 | Learning junk mails |
| 34 | |
| 35 | $ sylfilter -j ~/Mail/junk/* |
| 36 | |
| 37 | Learning clean mails |
| 38 | |
| 39 | $ sylfilter -c ~/Mail/clean/* |
| 40 | |
| 41 | Classifying mails |
| 42 | |
| 43 | $ sylfilter ~/Mail/inbox/1234 |
| 44 | |
| 45 | Show help message |
| 46 | |
| 47 | $ sylfilter -h |
| 48 | |
| 49 | Other information |
| 50 | ================= |
| 51 | |
| 52 | Token database files are created under ~/.sylfilter/ . |