]> Sergey Matveev's repositories - public-inbox.git/commitdiff
doc: lei: update description, add warnings
authorEric Wong <e@80x24.org>
Mon, 29 Mar 2021 08:04:16 +0000 (08:04 +0000)
committerEric Wong <e@80x24.org>
Mon, 29 Mar 2021 17:43:50 +0000 (13:43 -0400)
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.

Documentation/lei.pod

index 6c8cfc3d23e6cda4702a289415b11d5c34c152b1..248e5931c4730b6a5606d3197676f7c5a7f092c2 100644 (file)
@@ -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