unofficial mirror of meta@public-inbox.org
 help / color / mirror / Atom feed
From: Eric Wong <e@80x24.org>
To: meta@public-inbox.org
Subject: [PATCH 4/4] doc: lei: update description, add warnings
Date: Mon, 29 Mar 2021 08:04:16 +0000	[thread overview]
Message-ID: <20210329080416.18587-5-e@80x24.org> (raw)
In-Reply-To: <20210329080416.18587-1-e@80x24.org>

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 | 12 +++++++-----
 1 file 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

  parent reply	other threads:[~2021-03-29  8:04 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-29  8:04 [PATCH 0/4] doc: some clarifications and warnings Eric Wong
2021-03-29  8:04 ` [PATCH 1/4] doc: lei q: drop NNTP from --output description Eric Wong
2021-03-29  8:04 ` [PATCH 2/4] doc: lei q: add warning for --output clobbering Eric Wong
2021-03-29  8:04 ` [PATCH 3/4] doc: lei q: clarify default output as stdout Eric Wong
2021-03-29  8:04 ` Eric Wong [this message]
2021-03-29 21:13 ` [PATCH 0/4] doc: some clarifications and warnings Kyle Meyer

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://public-inbox.org/README

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210329080416.18587-5-e@80x24.org \
    --to=e@80x24.org \
    --cc=meta@public-inbox.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).