From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-Status: No, score=-4.0 required=3.0 tests=ALL_TRUSTED,BAYES_00 shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from localhost (dcvr.yhbt.net [127.0.0.1]) by dcvr.yhbt.net (Postfix) with ESMTP id CD10C1FA01 for ; Mon, 29 Mar 2021 08:04:16 +0000 (UTC) From: Eric Wong To: meta@public-inbox.org Subject: [PATCH 4/4] doc: lei: update description, add warnings Date: Mon, 29 Mar 2021 08:04:16 +0000 Message-Id: <20210329080416.18587-5-e@80x24.org> In-Reply-To: <20210329080416.18587-1-e@80x24.org> References: <20210329080416.18587-1-e@80x24.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit List-Id: 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, 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