($run): Declare with our instead of my so it will be available to the

user-defined is_spam function.  Document this.

diff --git a/minc b/minc
index e048dd6..a2de5d6 100755 (executable)
--- a/minc
+++ b/minc
@@ -70,7 +70,7 @@ maildir.
 
 my $dumpfilters = 0;
 my $filteronly = 0;
 
 my $dumpfilters = 0;
 my $filteronly = 0;

-my $run = 1;
+our $run = 1;

 my $spamonly = 0;
 
 our $opt_d;
 my $spamonly = 0;
 
 our $opt_d;


@@ -141,6 +141,11 @@ filename as an argument and returns 1 if the message is spam, else 0.
 If this file does not exist, minc will define a simple function that
 always returns 0.
 
 If this file does not exist, minc will define a simple function that
 always returns 0.
 

+One of minc's global variables is available to the user-defined
+is_spam function: $run.  This boolean should be honored; is_spam
+should only take real action (i.e. removing or creating files, running
+external programs, etc.) if $run is non-zero.
+

 XXX: need more details about the spam-handling process; for now read
 the code.
 
 XXX: need more details about the spam-handling process; for now read
 the code.