X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Flei-overview.pod;h=40a7b0aadd044580555a0c8897cccd6cb7b5b089;hb=2074d96eaa930e330624786b13e7cfebeebb1b2d;hp=4a34bc16268e2ec5225225cbb71b59e4f0bbfafe;hpb=0b15dfc58ceaecdcb1c9285c3ad55813006c8338;p=public-inbox.git diff --git a/Documentation/lei-overview.pod b/Documentation/lei-overview.pod index 4a34bc16..40a7b0aa 100644 --- a/Documentation/lei-overview.pod +++ b/Documentation/lei-overview.pod @@ -33,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 tag - -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. @@ -92,23 +92,37 @@ and written. Search for all flagged messages that also have a "next" label. -=item $ lei p2q HEAD | lei q --stdin -tt -o /tmp/mdir +=item $ lei p2q HEAD | lei q -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:MESSAGE-ID | 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 -L is recommended for performance. To enable it, create -C<~/.cache/public-inbox/inline-c/>. +L is required, lei runs as a background daemon to reduce +startup costs and can provide real-time L/L +Maildir monitoring. L (p5-IO-KQueue on FreeBSD) and +L (liblinux-inotify2-perl and perl-Linux-Inotify2 in +.deb and .rpm-based distros, respectively) are recommended. -If Socket::MsgHdr is installed (libsocket-msghdr-perl in Debian), the -first invocation of lei starts a daemon, reducing the startup cost of -for future invocations (which is particularly important for Bash -completion). +L is optional (libsocket-msghdr-perl in Debian), +and further improves startup performance. Its effect is most felt +when using shell completion. =head1 BASH COMPLETION