* Re: [PATCH 2/2] doc: add lei-overview(7)
2021-02-01 6:40 5% ` Eric Wong
@ 2021-02-01 11:37 5% ` Eric Wong
0 siblings, 0 replies; 4+ results
From: Eric Wong @ 2021-02-01 11:37 UTC (permalink / raw)
To: Kyle Meyer; +Cc: meta
Eric Wong <e@80x24.org> wrote:
> Kyle Meyer <kyle@kyleam.com> wrote:
> > +=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>.
>
> Thanks for this series. I'll take a closer look later (or
> tomorrow)
It seems fine, pushed as commit e49cf9c629c0fd3024bdb63b5c5e84b590814c4e
Thanks again
> mutt actually uses mboxcl2, so it's probably better to use
> mboxcl2 in examples involving mutt. I would also prefer "-f" in
> examples if the rest of the args are using short switches.
>
> No need to resend just for that, I can fix up locally before
> pushing.
diff --git a/Documentation/lei-overview.pod b/Documentation/lei-overview.pod
index 988896ce..d1903045 100644
--- a/Documentation/lei-overview.pod
+++ b/Documentation/lei-overview.pod
@@ -51,9 +51,9 @@ Search for messages whose subject includes "lei" and "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
+=item $ lei q -t -o t.mbox -f mboxcl2 --mua=mutt s:lei s:skeleton
-Write mboxrd-formatted results to t.mbox and enter mutt to view the
+Write mboxcl2-formatted results to t.mbox and enter mutt to view the
file by invoking C<mutt -f %f>.
=back
^ permalink raw reply related [relevance 5%]
* Re: [PATCH 2/2] doc: add lei-overview(7)
2021-02-01 5:57 4% ` [PATCH 2/2] doc: add lei-overview(7) Kyle Meyer
@ 2021-02-01 6:40 5% ` Eric Wong
2021-02-01 11:37 5% ` Eric Wong
0 siblings, 1 reply; 4+ results
From: Eric Wong @ 2021-02-01 6:40 UTC (permalink / raw)
To: Kyle Meyer; +Cc: meta
Kyle Meyer <kyle@kyleam.com> wrote:
> +=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>.
Thanks for this series. I'll take a closer look later (or
tomorrow)
mutt actually uses mboxcl2, so it's probably better to use
mboxcl2 in examples involving mutt. I would also prefer "-f" in
examples if the rest of the args are using short switches.
No need to resend just for that, I can fix up locally before
pushing.
^ permalink raw reply [relevance 5%]
* [PATCH 2/2] doc: add lei-overview(7)
2021-02-01 5:57 7% [PATCH 0/2] doc: initial lei manpages Kyle Meyer
@ 2021-02-01 5:57 4% ` Kyle Meyer
2021-02-01 6:40 5% ` Eric Wong
0 siblings, 1 reply; 4+ results
From: Kyle Meyer @ 2021-02-01 5:57 UTC (permalink / raw)
To: meta
---
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
^ permalink raw reply related [relevance 4%]
* [PATCH 0/2] doc: initial lei manpages
@ 2021-02-01 5:57 7% Kyle Meyer
2021-02-01 5:57 4% ` [PATCH 2/2] doc: add lei-overview(7) Kyle Meyer
0 siblings, 1 reply; 4+ results
From: Kyle Meyer @ 2021-02-01 5:57 UTC (permalink / raw)
To: meta
Prompted by <20210124120217.GA12880@dcvr>, here's my attempt to start
lei's manpages. The first patch adds a manpage for lei and each of
its currently implemented subcommands. The second patch adds an
overview/quickstart.
I'm not really sure this is in a good state. I ran out of time to
give it a complete read-through, I feel like it may need a bit more
flesh just to be a good _start_, and I probably injected a good amount
of my own confusion into them. Anyway, it still may be useful to get
feedback on, especially because I probably won't be able to work on it
in the next couple of days.
[1/2] doc: start manpages for lei commands
[2/2] doc: add lei-overview(7)
Documentation/.gitignore | 1 +
Documentation/lei-add-external.pod | 49 ++++++++++
Documentation/lei-config.pod | 26 ++++++
Documentation/lei-daemon-kill.pod | 28 ++++++
Documentation/lei-daemon-pid.pod | 28 ++++++
Documentation/lei-forget-external.pod | 40 ++++++++
Documentation/lei-init.pod | 42 +++++++++
Documentation/lei-ls-external.pod | 38 ++++++++
Documentation/lei-overview.pod | 72 +++++++++++++++
Documentation/lei-q.pod | 127 ++++++++++++++++++++++++++
Documentation/lei.pod | 90 ++++++++++++++++++
Documentation/txt2pre | 12 ++-
MANIFEST | 10 ++
Makefile.PL | 7 +-
14 files changed, 567 insertions(+), 3 deletions(-)
create mode 100644 Documentation/lei-add-external.pod
create mode 100644 Documentation/lei-config.pod
create mode 100644 Documentation/lei-daemon-kill.pod
create mode 100644 Documentation/lei-daemon-pid.pod
create mode 100644 Documentation/lei-forget-external.pod
create mode 100644 Documentation/lei-init.pod
create mode 100644 Documentation/lei-ls-external.pod
create mode 100644 Documentation/lei-overview.pod
create mode 100644 Documentation/lei-q.pod
create mode 100644 Documentation/lei.pod
base-commit: dd1a1bceb56692722b1fb4a27391c80307403d86
--
2.30.0
^ permalink raw reply [relevance 7%]
Results 1-4 of 4 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2021-02-01 5:57 7% [PATCH 0/2] doc: initial lei manpages Kyle Meyer
2021-02-01 5:57 4% ` [PATCH 2/2] doc: add lei-overview(7) Kyle Meyer
2021-02-01 6:40 5% ` Eric Wong
2021-02-01 11:37 5% ` Eric Wong
Code repositories for project(s) associated with this public 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).