X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Flei-overview.pod;h=e80cb094cecc00198dc619e3286adc132f415a8a;hb=63807b9322151773d746303041c84dc37701bac2;hp=7c7337ab4f3cda123ebc55e0145f8f442695166b;hpb=510b02746ca53e80b9bfed82ab589f43e20bacab;p=public-inbox.git diff --git a/Documentation/lei-overview.pod b/Documentation/lei-overview.pod index 7c7337ab..e80cb094 100644 --- a/Documentation/lei-overview.pod +++ b/Documentation/lei-overview.pod @@ -9,16 +9,23 @@ provides some basic examples. =head1 LEI STORE -L initializes writable local storage based on -L. +lei has writable local storage based on L. +Commands will automatically initialize the store behind the scenes if +needed, but you can call L directly if you want to use a +store location other than the default C<$XDG_DATA_HOME/lei/store>. + +The L command provides the primary interface for +importing messages into the local storage. In addition, other +commands, such as L and L, use the local store +to memoize messages from remotes. =head2 EXAMPLES =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 @@ -26,7 +33,7 @@ Show message with the git blob OID of 59ec517f9. If a message with that OID isn't found, check if the current git repository has the blob, trying to reconstruct it from a message if needed. -=item $ lei blob 59ec517f9 | lei mark - -F eml +kw:flagged +L:next +=item $ lei blob 59ec517f9 | lei tag - -F eml +kw:flagged +L:next Set the "flagged" keyword and "next" label on the message with the blob OID of 59ec517f9. @@ -75,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. -=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. +Write results to a Maildir at "mdir". Mutt will be invoked +to open mfolder (C) 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 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. +=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 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 @@ -113,8 +133,8 @@ welcome. Feedback welcome via plain-text mail to L -The mail archives are hosted at L -and L +The mail archives are hosted at L and +L =head1 COPYRIGHT