From: Eric Wong <e@80x24.org>
Date: Mon, 29 Mar 2021 08:04:14 +0000 (+0000)
Subject: doc: lei q: add warning for --output clobbering
X-Git-Tag: v1.7.0~865
X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=80b0bb3aef4878e681acd3bc7ef201ae17af07bf;p=public-inbox.git

doc: lei q: add warning for --output clobbering

The behavior matching mairix still frightens me a bit when it
comes to supporting new users.  On the other hand, I've rarely
ever used --augment with mairix, so I still think the current
(dangerous) behavior makes sense in the context of search results.
---

diff --git a/Documentation/lei-q.pod b/Documentation/lei-q.pod
index 8668533a..8d5053cd 100644
--- a/Documentation/lei-q.pod
+++ b/Documentation/lei-q.pod
@@ -28,6 +28,9 @@ Read search terms from stdin.
 
 =item -o MFOLDER, --output=MFOLDER, --mfolder=MFOLDER
 
+Warning: this clobbers and overwrites the output destination unless
+L</-a, --augment> is specified.
+
 Destination for results (e.g., C<path/to/Maildir>,
 C<imaps://user@mail.example.com/INBOX.test>, or
 C<mboxcl2:path/to/mbox>).  The prefix may be a supported protocol: