]> Sergey Matveev's repositories - public-inbox.git/commitdiff
doc: lei-overview: favor Maildir for mutt examples
authorEric Wong <e@80x24.org>
Wed, 31 Mar 2021 00:41:09 +0000 (00:41 +0000)
committerEric Wong <e@80x24.org>
Wed, 31 Mar 2021 07:23:57 +0000 (07:23 +0000)
mboxes are generally horrible for interactive read-write use due
to locking.  Describe our parallel behavior with mutt, since
writing mail can take a long while and being able to read
results as they're written is nice.

We'll also use a gzipped mboxrd for the import example, since
we can decompress gzipped mboxrds automatically, now.

Documentation/lei-overview.pod

index c1f952c9455d68d1d83ad30d713f318014c07d44..70dbf2b52a29cbcab15dd2f93bd934379d30d4a2 100644 (file)
@@ -23,9 +23,9 @@ to memoize messages from remotes.
 
 =over
 
-=item $ lei import mboxrd:t.mbox
+=item $ lei import mboxrd:t.mbox.gz
 
-Import the messages from an mbox into the local storage.
+Import the messages from a gzipped mboxrd into the local storage.
 
 =item $ lei blob 59ec517f9
 
@@ -82,10 +82,11 @@ Search for messages whose subject includes "lei" and "skeleton".
 Do the same, but also report unmatched messages that are in the same
 thread as a matched message.
 
-=item $ lei q -t -o mboxcl2:t.mbox --mua=mutt s:lei s:skeleton
+=item $ lei q -t -o mdir --mua=mutt s:lei s:skeleton
 
-Write mboxcl2-formatted results to t.mbox and enter mutt to view the
-file by invoking C<mutt -f %f>.
+Write results to a Maildir at "mdir".  Mutt will be invoked
+to open mfolder (C<mutt -f %f>) while results are being fetched
+and written.
 
 =item $ lei q kw:flagged L:next