X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Flei.pod;h=3af9e2eeacf71425dd84e041245928fb5ba2a3f6;hb=69b5ab18a594fa434d79cacee35c4d9a0df7b55c;hp=6c8cfc3d23e6cda4702a289415b11d5c34c152b1;hpb=510b02746ca53e80b9bfed82ab589f43e20bacab;p=public-inbox.git diff --git a/Documentation/lei.pod b/Documentation/lei.pod index 6c8cfc3d..3af9e2ee 100644 --- a/Documentation/lei.pod +++ b/Documentation/lei.pod @@ -1,6 +1,6 @@ =head1 NAME -lei - local email interface for public-inbox +lei - local email interface =head1 SYNOPSIS @@ -8,15 +8,17 @@ lei [OPTIONS] COMMAND =head1 DESCRIPTION -Unlike the C10K-oriented L, lei is designed -exclusively to handle trusted local clients with read/write access to -the file system, using as many system resources as the local user has -access to. lei supports a local, writable store built on top of +lei is a command-line tool for importing and searching email, +regardless of whether it is from a personal mailbox or a public-inbox. +lei supports a local, writable store built on top of L and L. L provides an interface for querying messages across the lei store and read-only local and remote "externals" (inboxes and external indices). +Warning: lei is still in its early stages and may destroy mail. +Be sure to have backups of destinations lei writes to. + Available in public-inbox 1.7.0+. =head1 OPTIONS @@ -46,7 +48,7 @@ Subcommands for initializing and managing local, writable storage: =item * L -=item * L +=item * L =back @@ -70,10 +72,24 @@ store and configured externals are =item * L +=item * L + +=item * L + +=item * L + +=item * L + +=item * L + =item * L =item * L +=item * L + +=item * L + =back Other subcommands include @@ -82,12 +98,16 @@ Other subcommands include =item * L +=item * L + =item * L =item * L =item * L +=item * L + =back =head1 FILES @@ -99,8 +119,8 @@ configuration for lei resides at C<$XDG_CONFIG_HOME/lei/config>. 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