From: epg <> Date: Sun, 29 Dec 2002 00:05:34 +0000 (+0000) Subject: Doc fixes. X-Git-Url: https://diplodocus.org/git/minc/commitdiff_plain/60efaae41b3b7a4edbc8092288700d9a6f5bca7f?hp=a91932723f3ac1c57c72874e09914b42c0a1f421 Doc fixes. --- diff --git a/minc b/minc index c95bec2..fd8625e 100755 --- a/minc +++ b/minc @@ -19,7 +19,7 @@ spam-checking function, and optionally filters mail into separate mh folders. The filtering is quite sophisticated, as it is done using real Perl -substitution (s//) commands. +matching (m//) commands. =cut @@ -135,13 +135,13 @@ expected to define the FILTERS list. =item $HOME/.mincspam -If this file exists, minc will include it with the expectation that it +If this file exists, B will include it with the expectation that it will define a B function. This function takes a message 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 +If this file does not exist, B will define a simple function that always returns 0. -One of minc's global variables is available to the user-defined +One of B'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. @@ -151,25 +151,25 @@ the code. =item `mhpath +`/logs/minc.log -Where minc logs what it does, unless in -n mode. +Where B logs what it does, unless in -n mode. =item `mhpath +`/logs/dryrun.log -Where minc logs what it would do; used in -n mode. - -=back +Where B logs what it would do; used in -n mode. =item `mhpath +`/.minc.context -minc uses this file for context (i.e. current folder) instead of +B uses this file for context (i.e. current folder) instead of `mhpath +`/context. This allows you some amount of freedom to use mh -while minc is running. For example, you can changed folders without +while B is running. For example, you can changed folders without causing a message to be stored in the wrong folder. Care must still be taken, however, about the unseen sequence; if you change it (whether via show, or mark, or anything else) while in the same folder -as minc, it is likely the new message minc stores will not end up +as B, it is likely the new message B stores will not end up marked unseen. +=back + =cut our @FILTERS; @@ -615,6 +615,7 @@ MAIN: { } } + __END__ =head1 THE FILTERS STRUCTURE