about summary refs log tree commit homepage
path: root/Documentation
diff options
authorEric Wong <e@80x24.org>2021-10-22 08:22:47 +0000
committerEric Wong <e@80x24.org>2021-10-22 19:07:39 +0000
commit6f8e16a266b30819ff74c40bc532f8c3f4a9f4b7 (patch)
treed95be5a1ef82bde0ce6d1a29cd45ad74c143d8d8 /Documentation
parent70a3ebbe4f277938d2a129c661a22b93b5f24d80 (diff)
lei forget-search: support --prune=<local|remote>
Instead of:

	lei forget-search $OUTPUT && rm -r $OUTPUT

we'll also allow a user to do:

	rm -r $OUTPUT && lei forget-search --prune

This gives users flexibility to choose whatever flow
is most natural to them.
Diffstat (limited to 'Documentation')
1 files changed, 13 insertions, 0 deletions
diff --git a/Documentation/lei-forget-search.pod b/Documentation/lei-forget-search.pod
index f3f043f9..3a7f493c 100644
--- a/Documentation/lei-forget-search.pod
+++ b/Documentation/lei-forget-search.pod
@@ -10,6 +10,19 @@ lei forget-search [OPTIONS] OUTPUT
 Forget a saved search at C<OUTPUT>.
+=head1 OPTIONS
+=item --prune[=<local|remote>]
+C<--prune> will forget saved searches if the C<OUTPUT> no longer
+exists.  C<--all=local> only prunes local mailboxes,
+C<--all=remote> only prunes remote mailboxes (currently
+C<imap://> and C<imaps://>).
 =head1 CONTACT
 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>