doc: lei-config: document various knobs

[public-inbox.git] / Documentation / lei-overview.pod

diff --git a/Documentation/lei-overview.pod b/Documentation/lei-overview.pod
index c1f952c9455d68d1d83ad30d713f318014c07d44..e80cb094cecc00198dc619e3286adc132f415a8a 100644 (file)
--- a/Documentation/lei-overview.pod
+++ b/Documentation/lei-overview.pod
@@ -23,9 +23,9 @@ to memoize messages from remotes.
 
 =over
 
 
 =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
 
 
 =item $ lei blob 59ec517f9
 


@@ -82,21 +82,34 @@ 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.
 
 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 /tmp/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
 
 Search for all flagged messages that also have a "next" label.
 
 
 =item $ lei q kw:flagged L:next
 
 Search for all flagged messages that also have a "next" label.
 

-=item $ lei p2q HEAD | lei q --stdin -tt -o mdir
+=item $ lei p2q HEAD | lei q --stdin -tt -o /tmp/mdir

 
 Search for messages that have post-image git blob IDs that match those
 of the current repository's HEAD commit, writing them to the Maildir
 directory "mdir" and flagging the messages that were an exact match.
 
 
 Search for messages that have post-image git blob IDs that match those
 of the current repository's HEAD commit, writing them to the Maildir
 directory "mdir" and flagging the messages that were an exact match.
 

+=item $ git show -s HEAD | lei lcat -
+
+Display a local message for the public-inbox link contained in a
+commit message.
+
+=item $ lei q -f text m:MID | lei rediff -U5 -
+
+Feed a message containing a diff to L<lei-rediff(1)> to regenerate its
+diff with five context lines.  Unless C<--git-dir> is specified, this
+requires the current working directory to be within the associated
+code repository.
+

 =back
 
 =head1 PERFORMANCE NOTES
 =back
 
 =head1 PERFORMANCE NOTES


@@ -120,8 +133,8 @@ welcome.
 
 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
 
 
 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
 

-The mail archives are hosted at L<https://public-inbox.org/meta/>
-and L<http://hjrcffqmbrq6wope.onion/meta/>
+The mail archives are hosted at L<https://public-inbox.org/meta/> and
+L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>

 
 =head1 COPYRIGHT
 
 
 =head1 COPYRIGHT