The Annoyance Filter.pdf - Fourmilab

§4 ANNOYANCE-FILTER OPTIONS 7
−−phraselimit n
Limit the length of phrases assembled according to the −−phrasemin and −−phrasemax
options to n characters. This permits ignoring “phrases” consisting of gibberish from mail
headers and un-decoded content. In most cases these items will be discarded by a −−prune
in any case, but skipping them as they are generated keeps the dictionary from bloating
in the first place. The default value is 48 characters.
−−phrasemin n
Calculate probabilities of phrases consisting of a minumum of n words. The default of 1
calculates probabilities for single words.
−−phrasemax n
Calculate probabilities of phrases consisting of a maximum of n words. The default of 1
calculates probabilities for single words. If you set this too large, the dictionary may grow
to an absurd size.
−−plot fname
After loading the dictionary, create a plot in fname.png of the histogram of words, binned
by their probability of appearance in junk mail. In order to generate the histogram the
GNUPLOT and NETPbm utilities must be installed on the system; if they are absent, the
−−plot option will not be available.
−−pop3port n
The POP3 proxy server activated by a subsequent −−pop3server option will listen for
connections on port n. If no −−pop3port is specified, the server will listen on the default
port of 9110. On most systems, you’ll have to run the program as root if you wish the
proxy server to listen on a port numbered 1023 or less.
−−pop3server server[:port]
Activate a POP3 proxy server which relays requests made on the previously specified
−−pop3port or the default of 9110 if no port is specified, to the specified server, which
may be given either as an IP address in “dotted quad” notion such as 10.89.11.131 or a
fully-qualified domain name like pop.someisp.tld. The port on which the server listens
for POP3 connections may be specified after the server prefixed by a colon (“:”); if no
port is specified, the IANA assigned POP3 port 110 will be used. The POP3 proxy server
will pass each message received on behalf of a requestor through the classifier and return
the annotated transcript to the requestor, who may then filter it based on the classification
appended to the message header. You must load a dictionary before activating the POP3
proxy server, and the −−pop3server option must be the last on the command line. The
server continues to run and service requests until manually terminated.
−−pop3trace
Write a trace of POP3 proxy server operations to standard error. Each trace message
(apart from the dump of the body of multi-line replies to clients) is prefixed with the label
“POP3:␣”.
−−prune
After loading the dictionary from −−mail and −−junk folders, this option discards words
which appear sufficiently infrequently that their probability cannot be reliably estimated.
One usually −−prunes the dictionary before using −−write to save it for subsequent runs.
−−ptrace
Include a token-by-token trace in the −−pdiag output file. This helps when adjusting
the parser’s criteria for recognising tokens. Setting this option without also specifying a
−−pdiag file will have no effect other than perhaps to exercise your fingers typing it on
the command line.
−−read, −r fname
Load a dictionary (previously created with the −−write option) from file fname.