about summary refs log tree commit homepage
path: root/script/public-inbox-learn
diff options
authorEric Wong <e@80x24.org>2020-09-01 01:15:03 +0000
committerEric Wong <e@80x24.org>2020-09-02 08:53:57 +0000
commit6c252b62bef579207ca417939076a9896d8a791b (patch)
tree32f3aa286595dcc56f6053d6cbf1523b4e18e94c /script/public-inbox-learn
parenta48e37f10fd5de2a28d9fca95425603f4fa42e6d (diff)
"use Getopt::Long" doesn't seem too slow on a hot page cache,
and it's probably used frequently enough to be in cache.

We'll also start reducing the amount of markup in the .pod and
favoring verbatim text in documentation for readability in
source form, since the bold text seems excessive.
Diffstat (limited to 'script/public-inbox-learn')
1 files changed, 18 insertions, 5 deletions
diff --git a/script/public-inbox-learn b/script/public-inbox-learn
index 5cd08d49..fb2d86ec 100755
--- a/script/public-inbox-learn
+++ b/script/public-inbox-learn
@@ -4,9 +4,22 @@
 # Used for training spam (via SpamAssassin) and removing messages from a
 # public-inbox
-my $usage = "$0 <spam|ham|rm> </path/to/message";
+my $help = <<EOF;
+usage: public-inbox-learn [OPTIONS] [spam|ham|rm] </path/to/RFC2822_message
+required action argument:
+   spam  unindex the message and train as spam
+     rm  remove the message without training as spam
+    ham  index the message (based on To:/Cc: headers) and train as ham
+  --all  scan all inboxes on `rm'
+See public-inbox-learn(1) man page for full documentation.
 use strict;
-use warnings;
 use PublicInbox::Config;
 use PublicInbox::InboxWritable;
 use PublicInbox::Eml;
@@ -14,11 +27,11 @@ use PublicInbox::Address;
 use PublicInbox::Spamcheck::Spamc;
 use Getopt::Long qw(:config gnu_getopt no_ignore_case auto_abbrev);
 my %opt = (all => 0);
-GetOptions(\%opt, 'all') or die "bad command-line args\n";
+GetOptions(\%opt, qw(all help|h)) or die $help;
-my $train = shift or die "usage: $usage\n";
+my $train = shift or die $help;
 if ($train !~ /\A(?:ham|spam|rm)\z/) {
-        die "`$train' not recognized.\nusage: $usage\n";
+        die "`$train' not recognized.\n$help";
 die "--all only works with `rm'\n" if $opt{all} && $train ne 'rm';