diff lisp/mh-e/mh-junk.el @ 67758:6b063593fdad

Follow Emacs coding conventions. Use default setting of emacs-lisp-docstring-fill-column which is 65.

--- a/lisp/mh-e/mh-junk.el	Fri Dec 23 05:40:21 2005 +0000
+++ b/lisp/mh-e/mh-junk.el	Fri Dec 23 07:40:40 2005 +0000
@@ -41,14 +41,15 @@
 (defun mh-junk-blacklist (range)
   "Blacklist RANGE as spam.
 
-This command trains the spam program in use (see the option `mh-junk-program')
-with the content of RANGE and then handles the message(s) as specified by the
-option `mh-junk-disposition'.
+This command trains the spam program in use (see the option
+`mh-junk-program') with the content of RANGE and then handles the
+message(s) as specified by the option `mh-junk-disposition'.
 
-Check the documentation of `mh-interactive-range' to see how RANGE is read in
-interactive use.
+Check the documentation of `mh-interactive-range' to see how RANGE is
+read in interactive use.
 
-For more information about using your particular spam fighting program, see:
+For more information about using your particular spam fighting
+program, see:
 
   - `mh-spamassassin-blacklist'
   - `mh-bogofilter-blacklist'
@@ -80,12 +81,12 @@
 (defun mh-junk-whitelist (range)
   "Whitelist RANGE as ham.
 
-This command reclassifies the RANGE as ham if it were incorrectly classified
-as spam (see the option `mh-junk-program'). It then refiles the message into
-the \"+inbox\" folder.
+This command reclassifies the RANGE as ham if it were incorrectly
+classified as spam (see the option `mh-junk-program'). It then
+refiles the message into the \"+inbox\" folder.
 
-Check the documentation of `mh-interactive-range' to see how RANGE is read in
-interactive use."
+Check the documentation of `mh-interactive-range' to see how
+RANGE is read in interactive use."
   (interactive (list (mh-interactive-range "Whitelist")))
   (let ((whitelist-func (nth 2 (assoc mh-junk-choice mh-junk-function-alist))))
     (unless whitelist-func
@@ -107,8 +108,8 @@
 (defun mh-spamassassin-blacklist (msg)
   "Blacklist MSG with SpamAssassin.
 
-SpamAssassin is one of the more popular spam filtering programs. Get it from
-your local distribution or from http://spamassassin.org/.
+SpamAssassin is one of the more popular spam filtering programs. Get
+it from your local distribution or from http://spamassassin.org/.
 
 To use SpamAssassin, add the following recipes to `.procmailrc':
 
@@ -129,52 +130,56 @@
 
 If you don't use `spamc', use `spamassassin -P -a'.
 
-Note that one of the recipes above throws away messages with a score greater
-than or equal to 10. Here's how you can determine a value that works best for
-you.
+Note that one of the recipes above throws away messages with a score
+greater than or equal to 10. Here's how you can determine a value that
+works best for you.
 
-First, run `spamassassin -t' on every mail message in your archive and use
-Gnumeric to verify that the average plus the standard deviation of good mail
-is under 5, the SpamAssassin default for \"spam\".
+First, run `spamassassin -t' on every mail message in your archive and
+use Gnumeric to verify that the average plus the standard deviation of
+good mail is under 5, the SpamAssassin default for \"spam\".
 
-Using Gnumeric, sort the messages by score and view the messages with the
-highest score. Determine the score which encompasses all of your interesting
-messages and add a couple of points to be conservative. Add that many dots to
-the `X-Spam-Level:' header field above to send messages with that score down
-the drain.
+Using Gnumeric, sort the messages by score and view the messages with
+the highest score. Determine the score which encompasses all of your
+interesting messages and add a couple of points to be conservative.
+Add that many dots to the `X-Spam-Level:' header field above to send
+messages with that score down the drain.
 
-In the example above, messages with a score of 5-9 are set aside in the
-`+spam' folder for later review. The major weakness of rules-based filters is
-a plethora of false positives so it is worthwhile to check.
+In the example above, messages with a score of 5-9 are set aside in
+the `+spam' folder for later review. The major weakness of rules-based
+filters is a plethora of false positives so it is worthwhile to check.
 
-If SpamAssassin classifies a message incorrectly, or is unsure, you can use
-the MH-E commands \\[mh-junk-blacklist] and \\[mh-junk-whitelist].
+If SpamAssassin classifies a message incorrectly, or is unsure, you
+can use the MH-E commands \\[mh-junk-blacklist] and
+\\[mh-junk-whitelist].
 
 The \\[mh-junk-blacklist] command adds a `blacklist_from' entry to
-`~/spamassassin/user_prefs', deletes the message, and sends the message to the
-Razor, so that others might not see this spam. If the `sa-learn' command is
-available, the message is also recategorized as spam.
+`~/spamassassin/user_prefs', deletes the message, and sends the
+message to the Razor, so that others might not see this spam. If the
+`sa-learn' command is available, the message is also recategorized as
+spam.
 
 The \\[mh-junk-whitelist] command adds a `whitelist_from' rule to the
-`~/.spamassassin/user_prefs' file. If the `sa-learn' command is available, the
-message is also recategorized as ham.
+`~/.spamassassin/user_prefs' file. If the `sa-learn' command is
+available, the message is also recategorized as ham.
 
-Over time, you'll observe that the same host or domain occurs repeatedly in
-the `blacklist_from' entries, so you might think that you could avoid future
-spam by blacklisting all mail from a particular domain. The utility function
-`mh-spamassassin-identify-spammers' helps you do precisely that. This function
-displays a frequency count of the hosts and domains in the `blacklist_from'
-entries from the last blank line in `~/.spamassassin/user_prefs' to the end of
-the file. This information can be used so that you can replace multiple
+Over time, you'll observe that the same host or domain occurs
+repeatedly in the `blacklist_from' entries, so you might think that
+you could avoid future spam by blacklisting all mail from a particular
+domain. The utility function `mh-spamassassin-identify-spammers' helps
+you do precisely that. This function displays a frequency count of the
+hosts and domains in the `blacklist_from' entries from the last blank
+line in `~/.spamassassin/user_prefs' to the end of the file. This
+information can be used so that you can replace multiple
 `blacklist_from' entries with a single wildcard entry such as:
 
     blacklist_from *@*amazingoffersdirect2u.com
 
-In versions of SpamAssassin (2.50 and on) that support a Bayesian classifier,
-\\[mh-junk-blacklist] uses the `sa-learn' program to recategorize the message
-as spam. Neither MH-E, nor SpamAssassin, rebuilds the database after adding
-words, so you will need to run `sa-learn --rebuild' periodically. This can be
-done by adding the following to your crontab:
+In versions of SpamAssassin (2.50 and on) that support a Bayesian
+classifier, \\[mh-junk-blacklist] uses the `sa-learn' program to
+recategorize the message as spam. Neither MH-E, nor SpamAssassin,
+rebuilds the database after adding words, so you will need to run
+`sa-learn --rebuild' periodically. This can be done by adding the
+following to your crontab:
 
     0 * * * *	sa-learn --rebuild > /dev/null 2>&1"
   (unless mh-spamassassin-executable
@@ -210,9 +215,9 @@
 (defun mh-spamassassin-whitelist (msg)
   "Whitelist MSG with SpamAssassin.
 
-The \\[mh-junk-whitelist] command adds a `whitelist_from' rule to the
-`~/.spamassassin/user_prefs' file. If the `sa-learn' command is available, the
-message is also recategorized as ham.
+The \\[mh-junk-whitelist] command adds a `whitelist_from' rule to
+the `~/.spamassassin/user_prefs' file. If the `sa-learn' command
+is available, the message is also recategorized as ham.
 
 See `mh-spamassassin-blacklist' for more information."
   (unless mh-spamassassin-executable
@@ -263,11 +268,11 @@
 (defun mh-spamassassin-identify-spammers ()
   "Identify spammers who are repeat offenders.
 
-This function displays a frequency count of the hosts and domains in the
-`blacklist_from' entries from the last blank line in
-`~/.spamassassin/user_prefs' to the end of the file. This information can be
-used so that you can replace multiple `blacklist_from' entries with a single
-wildcard entry such as:
+This function displays a frequency count of the hosts and domains
+in the `blacklist_from' entries from the last blank line in
+`~/.spamassassin/user_prefs' to the end of the file. This
+information can be used so that you can replace multiple
+`blacklist_from' entries with a single wildcard entry such as:
 
     blacklist_from *@*amazingoffersdirect2u.com"
   (interactive)
@@ -312,8 +317,8 @@
 (defun mh-bogofilter-blacklist (msg)
   "Blacklist MSG with bogofilter.
 
-Bogofilter is a Bayesian spam filtering program. Get it from your local
-distribution or from http://bogofilter.sourceforge.net/.
+Bogofilter is a Bayesian spam filtering program. Get it from your
+local distribution or from http://bogofilter.sourceforge.net/.
 
 Bogofilter is taught by running:
 
@@ -324,9 +329,9 @@
     bogofilter -s < spam-message
 
 on every spam message. This is called a full training; three other
-training methods are described in the FAQ that is distributed with bogofilter.
-Note that most Bayesian filters need 1000 to 5000 of each type of message to
-start doing a good job.
+training methods are described in the FAQ that is distributed with
+bogofilter. Note that most Bayesian filters need 1000 to 5000 of each
+type of message to start doing a good job.
 
 To use bogofilter, add the following recipes to `.procmailrc':
 
@@ -344,9 +349,9 @@
     * ^X-Bogosity: Unsure, tests=bogofilter
     spam/unsure/.
 
-If bogofilter classifies a message incorrectly, or is unsure, you can use the
-MH-E commands \\[mh-junk-blacklist] and \\[mh-junk-whitelist] to update
-bogofilter's training.
+If bogofilter classifies a message incorrectly, or is unsure, you can
+use the MH-E commands \\[mh-junk-blacklist] and \\[mh-junk-whitelist]
+to update bogofilter's training.
 
 The \"Bogofilter FAQ\" suggests that you run the following
 occasionally to shrink the database:
@@ -399,9 +404,9 @@
     *^X-SpamProbe: SPAM
     spam/.
 
-If SpamProbe classifies a message incorrectly, you can use the MH-E commands
-\\[mh-junk-blacklist] and \\[mh-junk-whitelist] to update SpamProbe's
-training."
+If SpamProbe classifies a message incorrectly, you can use the
+MH-E commands \\[mh-junk-blacklist] and \\[mh-junk-whitelist] to
+update SpamProbe's training."
   (unless mh-spamprobe-executable
     (error "Unable to find the spamprobe executable"))
   (let ((msg-file (mh-msg-filename msg mh-current-folder)))