mda+learn: add --help / -h support

[public-inbox.git] / Documentation / public-inbox-learn.pod

diff --git a/Documentation/public-inbox-learn.pod b/Documentation/public-inbox-learn.pod
index addcbcb5113f327b884f32a6116c25e1e4bd94b8..94c96fd5a469f26ec9b4d22f3dff670244b42158 100644 (file)
--- a/Documentation/public-inbox-learn.pod
+++ b/Documentation/public-inbox-learn.pod
@@ -4,7 +4,7 @@ public-inbox-learn - spam trainer and remover for public-inbox
 
 =head1 SYNOPSIS
 
-B<public-inbox-learn> <spam|ham|rm> E<lt>MESSAGE
+  public-inbox-learn <spam|ham|rm> </path/to/RFC2822_message
 
 =head1 DESCRIPTION
 
@@ -50,8 +50,13 @@ C<publicinboxmda.spamcheck> is C<none> in L<public-inbox-config(5)>.
 
 =item rm
 
-This is identical to the C<spam> command above, but does
-not feed the message to L<spamc(1)>
+This is similar to the C<spam> command above, but does
+not feed the message to L<spamc(1)> and only removes messages
+which match on any of the C<To:>, C<Cc:>, and C<List-ID:> headers.
+
+The C<--all> option may be used match C<spam> semantics in removing
+the message from all configured inboxes.  C<--all> will be
+available in public-inbox 1.6.0 (PENDING).
 
 =back