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=-3.2 required=3.0 tests=AWL,BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_BLOCKED, SPF_HELO_NONE,SPF_PASS shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from out1.migadu.com (out1.migadu.com [IPv6:2001:41d0:2:863f::]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by dcvr.yhbt.net (Postfix) with ESMTPS id 73AD11F4B4 for ; Mon, 1 Feb 2021 05:57:28 +0000 (UTC) X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=kyleam.com; s=key1; t=1612159045; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=y1S95O0rFhr0xR7fBcB00EnAZ0c3D1X8BNpqEh8BQ8k=; b=EISabLcJvRsCCHYfSj83QwrmAz++aOIztFIz73PcytXupzYs1nBMr5UoMAMyyjWsNGOw/Z ronF+HmlaxYQZfX38u+MtpH3HXoZXJ+Atp/I9YK15YjUoSjTN8URABDl4iJb1UvlpnJWOK WkeDDz6yohdE/vGdks4KP5PKCjGL09T1tGc/rCrvcjky9BZA1CB6AlsbQg7tpFC0VXVYqw 5POFTzFj9Dc5wygo57vsvd4z7k43cuCJjsCfyWWDUlvkbEZcG8KakDVnEzm5Ua8fuQEFc+ UABlBxDUB20enLL40ZUnIDe/Quf8vcfMZ/nOe840NCcLjlhKe0zIziksQo7hZw== From: Kyle Meyer To: meta@public-inbox.org Subject: [PATCH 2/2] doc: add lei-overview(7) Date: Mon, 1 Feb 2021 00:57:03 -0500 Message-Id: <20210201055704.26683-3-kyle@kyleam.com> In-Reply-To: <20210201055704.26683-1-kyle@kyleam.com> References: <20210201055704.26683-1-kyle@kyleam.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Migadu-Flow: FLOW_OUT X-Migadu-Auth-User: kyle@kyleam.com List-Id: --- Documentation/lei-overview.pod | 72 ++++++++++++++++++++++++++++++++++ Documentation/txt2pre | 1 + MANIFEST | 1 + Makefile.PL | 2 +- 4 files changed, 75 insertions(+), 1 deletion(-) create mode 100644 Documentation/lei-overview.pod diff --git a/Documentation/lei-overview.pod b/Documentation/lei-overview.pod new file mode 100644 index 00000000..988896ce --- /dev/null +++ b/Documentation/lei-overview.pod @@ -0,0 +1,72 @@ +=head1 NAME + +lei - an overview of lei + +=head1 DESCRIPTION + +L is a local email interface for public-inbox. This document +provides some basic examples. + +=head1 LEI STORE + +L initializes writable local storage based on +L. + +TODO: Extend when lei-import and friends are added. + +=head1 EXTERNALS + +In addition to the above store, lei can make read-only queries to +"externals": inboxes and external indices. An external can be +registered by passing a URL or local path to L. +For local paths, the external needs to be indexed with +L (in the case of a regular inbox) or +L (in the case of an external index). + +=head2 EXAMPLES + +=over + +=item $ lei add-external https://public-inbox.org/meta/ + +Add a remote external for public-inbox's inbox. + +=back + +=head1 SEARCHING + +The L command searches the local store and externals. The +search prefixes match those available via L. + +=head2 EXAMPLES + +=over + +=item $ lei q s:lei s:skeleton + +Search for messages whose subject includes "lei" and "skeleton". + +=item $ lei q -t s:lei s:skeleton + +Do the same, but also report unmatched messages that are in the same +thread as a matched message. + +=item $ lei q -t -o t.mbox --format mboxrd --mua=mutt s:lei s:skeleton + +Write mboxrd-formatted results to t.mbox and enter mutt to view the +file by invoking C. + +=back + +=head1 CONTACT + +Feedback welcome via plain-text mail to L + +The mail archives are hosted at L +and L + +=head1 COPYRIGHT + +Copyright 2021 all contributors L + +License: AGPL-3.0+ L diff --git a/Documentation/txt2pre b/Documentation/txt2pre index f69323e1..604490ef 100755 --- a/Documentation/txt2pre +++ b/Documentation/txt2pre @@ -18,6 +18,7 @@ for (qw[lei(1) lei-forget-external(1) lei-init(1) lei-ls-external(1) + lei-overview(7) lei-q(1) public-inbox.cgi(1) public-inbox-compact(1) diff --git a/MANIFEST b/MANIFEST index 4d6f8b43..56fde540 100644 --- a/MANIFEST +++ b/MANIFEST @@ -28,6 +28,7 @@ Documentation/lei-daemon-pid.pod Documentation/lei-forget-external.pod Documentation/lei-init.pod Documentation/lei-ls-external.pod +Documentation/lei-overview.pod Documentation/lei-q.pod Documentation/lei.pod Documentation/marketing.txt diff --git a/Makefile.PL b/Makefile.PL index 7bfe1e4e..f1910c47 100644 --- a/Makefile.PL +++ b/Makefile.PL @@ -48,7 +48,7 @@ $v->{-m1} = [ map { lei-forget-external lei-init lei-ls-external lei-q)]; $v->{-m5} = [ qw(public-inbox-config public-inbox-v1-format public-inbox-v2-format public-inbox-extindex-format) ]; -$v->{-m7} = [ qw(public-inbox-overview public-inbox-tuning) ]; +$v->{-m7} = [ qw(lei-overview public-inbox-overview public-inbox-tuning) ]; $v->{-m8} = [ qw(public-inbox-daemon) ]; my @sections = (1, 5, 7, 8); $v->{check_80} = []; -- 2.30.0