]> Sergey Matveev's repositories - public-inbox.git/commitdiff
doc: lei q: add warning for --output clobbering
authorEric Wong <e@80x24.org>
Mon, 29 Mar 2021 08:04:14 +0000 (08:04 +0000)
committerEric Wong <e@80x24.org>
Mon, 29 Mar 2021 17:43:48 +0000 (13:43 -0400)
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.

Documentation/lei-q.pod

index 8668533a5cfc2f71d60200a3bbba78b67ea2c9c9..8d5053cd3f54355ad5a5dfc70cacad15b284e1fb 100644 (file)
@@ -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: