From: Kyle Meyer <kyle@kyleam.com> To: meta@public-inbox.org Subject: [PATCH 2/2] doc: add lei-overview(7) Date: Mon, 1 Feb 2021 00:57:03 -0500 [thread overview] Message-ID: <20210201055704.26683-3-kyle@kyleam.com> (raw) In-Reply-To: <20210201055704.26683-1-kyle@kyleam.com> --- 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<lei(1)> is a local email interface for public-inbox. This document +provides some basic examples. + +=head1 LEI STORE + +L<lei-init(1)> initializes writable local storage based on +L<public-inbox-v2-format(5)>. + +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<lei-add-external(1)>. +For local paths, the external needs to be indexed with +L<public-inbox-index(1)> (in the case of a regular inbox) or +L<public-inbox-extindex(1)> (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<lei-q(1)> command searches the local store and externals. The +search prefixes match those available via L<public-inbox-httpd(1)>. + +=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<mutt -f %f>. + +=back + +=head1 CONTACT + +Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org> + +The mail archives are hosted at L<https://public-inbox.org/meta/> +and L<http://hjrcffqmbrq6wope.onion/meta/> + +=head1 COPYRIGHT + +Copyright 2021 all contributors L<mailto:meta@public-inbox.org> + +License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt> 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
next prev parent reply other threads:[~2021-02-01 5:57 UTC|newest] Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top 2021-02-01 5:57 [PATCH 0/2] doc: initial lei manpages Kyle Meyer 2021-02-01 5:57 ` [PATCH 1/2] doc: start manpages for lei commands Kyle Meyer 2021-02-06 9:01 ` lei-q doc thoughts... [was: doc: start manpages for lei commands] Eric Wong 2021-02-06 19:57 ` Kyle Meyer 2021-02-07 3:33 ` Eric Wong 2021-02-07 19:58 ` lei q --output vs --mfolder [was: [PATCH 1/2] " Eric Wong 2021-02-07 20:33 ` Kyle Meyer 2021-02-07 20:59 ` Eric Wong 2021-02-07 21:47 ` Kyle Meyer 2021-02-07 21:55 ` Eric Wong 2021-02-01 5:57 ` Kyle Meyer [this message] 2021-02-01 6:40 ` [PATCH 2/2] doc: add lei-overview(7) Eric Wong 2021-02-01 11:37 ` Eric Wong
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=20210201055704.26683-3-kyle@kyleam.com \ --to=kyle@kyleam.com \ --cc=meta@public-inbox.org \ --subject='Re: [PATCH 2/2] doc: add lei-overview(7)' \ /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
Code repositories for project(s) associated with this inbox: https://80x24.org/public-inbox.git 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).