BOGOTUNE(1)

✨ BOGOTUNE(1) ✨

okay bestie, gather round, because this is bogotune from the Bogofilter Reference Manual and it is literally here to find the optimum parameter settings for bogofilter 🎀

💖 NAME 💖

bogotune — find optimum parameter settings for bogofilter 👑

🦋 SYNOPSIS 🦋

bogotune [-v] [-c config] [-C] [-d dir] [-D] [-r value] [-T value]
         -n okfile [[-n] okfile [...]] -s spamfile [[-s] spamfile [...]]
         [-M file]

bogotune [-h]

🌸 DESCRIPTION 🌸

so basically bogotune is out here trying to find the optimum parameter settings for bogofilter. no cap. but here's the thing — it needs at least one set each of spam and non-spam messages. like, minimum. it can't do its little thing without both. 🙈

normally it uses the production wordlist, but you can also point it at a different wordlist, or make it build its own from half the supplied messages. main character energy honestly.

now, to produce useful results, bogotune has minimum message count requirements and it is not subtle about them:

• the wordlist it uses must have at least 2,000 spam and 2,000 non-spam in it
• 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

and if you tell bogotune to build its own wordlist? it will use half the input or 2000 messages (whichever is larger) for the wordlist. slay. 💅

message files may be in mbox, maildir, or MH folder — or any combination of those, we love a flexible queen. msg-count files can also be used, but not mixed with other formats. do not test her. 🫶

💅 OPTIONS 💅

• -h — prints the help message and then exits. bye bestie 👋
• -v — increases the verbosity level. level 1 displays the scan output in detail instead of using a progress meter. so if you wanna see everything, this is your girl.
• -c filename — tells bogofilter to read the config file named. 🎀
• -C — prevents bogotune from reading a configuration file. no config, no problem.
• -d dir — specifies the directory for the database. peek the ENVIRONMENT section for other directory setting options 👀
• -D — tells bogotune to build a wordlist in memory using the input messages. the messages get read and divided into two groups: the first group builds a wordlist (in ram) and the second is used for tuning. and because of the minimum requirements of 2000 messages in the wordlist and 500 messages for testing, when -D is used there must be 2500 non-spam and 2500 spam in the input files. if there are enough messages (more than 4000), they'll be split evenly between wordlist and testing. otherwise they get split proportionately. math but make it fashion. ✨
• -n — tells bogotune that the following argument is a file (or folder) containing non-spam. since version 1.0.3, multiple arguments to the -n option can be given. all non-option arguments until the next -s option will be treated as though they had been preceded by -n 🦋
• -s — tells bogotune 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 -s can be given. all non-option arguments until the next -n option will be treated as though they had been preceded by -s 🌈
• -r value — tells bogotune to use the following parameter as the robx value.
• -T value — tells bogotune to use the following parameter as fp target value.
• -M file — tells bogotune 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 bogotune and bogofilter to score messages quickly without needing the original token database.

🌈 ENVIRONMENT 🌈

bogofilter uses a database directory, which can be set in the config file. if it's not set there, bogofilter will use the value of BOGOFILTER_DIR. both of those can be overridden by the -ddir option. and if none of that is available? bogofilter will use the directory $HOME/.bogofilter. the backup plan has a backup plan, periodt. 💜

💀 BUGS 💀

bogotune is not particularly robust when presented with garbage input. so like... don't do that. she's doing her best. 😭

👑 AUTHOR 👑

the bogofilter developer team. 🫶

for updates, see the bogofilter project page[1].

⭐ SEE ALSO ⭐

bogofilter(1), bogolexer(1), bogoupgrade(1), bogoutil(1)

🎀 NOTES 🎀

1. the bogofilter project page http://bogofilter.sourceforge.net/

okay that's the whole vibe check 💖 this was the Bogofilter manual page, dated 05/19/2019, and yes it's giving iconic documentation energy. go tune those parameters, bestie, you got this 🦋✨💅