diff options
author | Eric Wong <e@80x24.org> | 2021-03-29 08:04:16 +0000 |
---|---|---|
committer | Eric Wong <e@80x24.org> | 2021-03-29 13:43:50 -0400 |
commit | f844e21ecc703f7a1285ba88edee490a8e8fe462 (patch) | |
tree | ebfb196772b3c1b5847c0730e2de1de20483822e /Documentation | |
parent | 51ec9714d3406634f5f5fbef2c4560e2ad43534e (diff) | |
download | public-inbox-f844e21ecc703f7a1285ba88edee490a8e8fe462.tar.gz |
Describing the design details and architecture doesn't seem appropriate for a section 1 manpage. We'll also add a warning about it being in the early stages.
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/lei.pod | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/Documentation/lei.pod b/Documentation/lei.pod index 6c8cfc3d..248e5931 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<public-inbox-daemon(8)>, 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<public-inbox-v2-format(5)> and L<public-inbox-extindex(1)>. L<lei-q(1)> 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 |