about summary refs log tree commit homepage
path: root/script/public-inbox-purge
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2020-09-01 01:15:00 +0000
committerEric Wong <e@80x24.org>2020-09-02 08:53:54 +0000
commit6accd690b16aa0bce7117286944d69f378611eb8 (patch)
tree188c4b7078ee7c2e274d737af54e01d3a916e237 /script/public-inbox-purge
parent256b3566e4d57a64bb349a7b896da10381a2a363 (diff)
downloadpublic-inbox-6accd690b16aa0bce7117286944d69f378611eb8.tar.gz
And while we're at it, note edit is *destructive* to encourage
reading the fine manual.
Diffstat (limited to 'script/public-inbox-purge')
-rwxr-xr-xscript/public-inbox-purge17
1 files changed, 14 insertions, 3 deletions
diff --git a/script/public-inbox-purge b/script/public-inbox-purge
index 82a63b80..7bca11ea 100755
--- a/script/public-inbox-purge
+++ b/script/public-inbox-purge
@@ -13,10 +13,21 @@ use PublicInbox::Filter::Base qw(REJECT);
 use PublicInbox::Eml;
 require PublicInbox::V2Writable;
 
-my $usage = "$0 [--all] [INBOX_DIRS] </path/to/message";
+my $help = <<EOF;
+usage: public-inbox-purge [--all] [INBOX_DIRS] </path/to/message
+
+  erase message entirely from an inbox (including history)
+
+options:
+
+  --all               purge from all configured inboxes
+
+See public-inbox-purge(1) man page for full documentation.
+EOF
+
 my $opt = { verbose => 1, all => 0, -min_inbox_version => 2 };
-GetOptions($opt, @PublicInbox::AdminEdit::OPT) or
-        die "bad command-line args\n$usage\n";
+GetOptions($opt, @PublicInbox::AdminEdit::OPT) or die $help;
+if ($opt->{help}) { print $help; exit 0 };
 
 my @ibxs = PublicInbox::Admin::resolve_inboxes(\@ARGV, $opt);
 PublicInbox::AdminEdit::check_editable(\@ibxs);