X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Flei.pod;h=3af9e2eeacf71425dd84e041245928fb5ba2a3f6;hb=8234b8bb76c3ec98466435ab0c84301ae9788ca0;hp=e1502122571ad5214b223f8b7c306cb893df35e4;hpb=82e81eeb8925580728a6b73aae7d960ab271cffc;p=public-inbox.git diff --git a/Documentation/lei.pod b/Documentation/lei.pod index e1502122..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,21 +8,27 @@ 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 =over +=item -c NAME=VALUE + +Override configuration C to C. + =item -C DIR Change current working directory to the specified directory before @@ -42,6 +48,8 @@ Subcommands for initializing and managing local, writable storage: =item * L +=item * L + =back The following subcommands can be used to manage and inspect external @@ -62,11 +70,27 @@ store and configured externals are =over +=item * L + +=item * L + +=item * L + +=item * L + +=item * L + +=item * L + +=item * L + =item * L -=back +=item * L -TODO: Add lei-show (and perhaps others) once implemented. +=item * L + +=back Other subcommands include @@ -74,10 +98,16 @@ Other subcommands include =item * L +=item * L + =item * L =item * L +=item * L + +=item * L + =back =head1 FILES @@ -89,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