* Re: [PATCH 8/9] doc lei: add manpages for new commands
2021-05-17 8:09 6% ` Eric Wong
@ 2021-05-17 23:24 6% ` Kyle Meyer
0 siblings, 0 replies; 8+ results
From: Kyle Meyer @ 2021-05-17 23:24 UTC (permalink / raw)
To: Eric Wong; +Cc: meta
Eric Wong writes:
> I squashed this fix in, though ('make check' revealed it):
Oy, sorry about that. Thanks for the fixup.
^ permalink raw reply [relevance 6%]
* Re: [PATCH 8/9] doc lei: add manpages for new commands
2021-05-17 3:35 2% ` [PATCH 8/9] doc lei: add manpages for new commands Kyle Meyer
@ 2021-05-17 8:09 6% ` Eric Wong
2021-05-17 23:24 6% ` Kyle Meyer
0 siblings, 1 reply; 8+ results
From: Eric Wong @ 2021-05-17 8:09 UTC (permalink / raw)
To: Kyle Meyer; +Cc: meta
Kyle Meyer <kyle@kyleam.com> wrote:
Thanks, pushed this series out and your lcat fix as
commit 94be0536ce5eaf1d5a67f217dce112607624389c
("lei lcat: fix handling of multiple MSGID_OR_URL arguments")
> diff --git a/MANIFEST b/MANIFEST
> index 29e62880..c7084671 100644
> --- a/MANIFEST
> +++ b/MANIFEST
> @@ -23,21 +23,28 @@ Documentation/hosted.txt
> Documentation/include.mk
> Documentation/lei-add-external.pod
> Documentation/lei-blob.pod
> +Documentation/lei-cat.pod
I squashed this fix in, though ('make check' revealed it):
diff -u b/MANIFEST b/MANIFEST
--- b/MANIFEST
+++ b/MANIFEST
@@ -23,7 +23,6 @@
Documentation/include.mk
Documentation/lei-add-external.pod
Documentation/lei-blob.pod
-Documentation/lei-cat.pod
Documentation/lei-config.pod
Documentation/lei-convert.pod
Documentation/lei-daemon-kill.pod
@@ -33,6 +32,7 @@
Documentation/lei-forget-search.pod
Documentation/lei-import.pod
Documentation/lei-init.pod
+Documentation/lei-lcat.pod
Documentation/lei-ls-external.pod
Documentation/lei-ls-label.pod
Documentation/lei-ls-mail-sync.pod
^ permalink raw reply [relevance 6%]
* [PATCH 8/9] doc lei: add manpages for new commands
2021-05-17 3:35 7% [PATCH 0/9] doc: lei manpages, round 5 Kyle Meyer
@ 2021-05-17 3:35 2% ` Kyle Meyer
2021-05-17 8:09 6% ` Eric Wong
0 siblings, 1 reply; 8+ results
From: Kyle Meyer @ 2021-05-17 3:35 UTC (permalink / raw)
To: meta
---
Documentation/lei-edit-search.pod | 28 ++++++++++
Documentation/lei-forget-search.pod | 28 ++++++++++
Documentation/lei-lcat.pod | 79 +++++++++++++++++++++++++++++
Documentation/lei-ls-mail-sync.pod | 55 ++++++++++++++++++++
Documentation/lei-ls-search.pod | 65 ++++++++++++++++++++++++
Documentation/lei-overview.pod | 12 +++++
Documentation/lei-q.pod | 2 +-
Documentation/lei-rediff.pod | 79 +++++++++++++++++++++++++++++
Documentation/lei-up.pod | 48 ++++++++++++++++++
Documentation/lei.pod | 16 ++++++
Documentation/txt2pre | 8 +++
MANIFEST | 7 +++
Makefile.PL | 8 +--
13 files changed, 431 insertions(+), 4 deletions(-)
create mode 100644 Documentation/lei-edit-search.pod
create mode 100644 Documentation/lei-forget-search.pod
create mode 100644 Documentation/lei-lcat.pod
create mode 100644 Documentation/lei-ls-mail-sync.pod
create mode 100644 Documentation/lei-ls-search.pod
create mode 100644 Documentation/lei-rediff.pod
create mode 100644 Documentation/lei-up.pod
diff --git a/Documentation/lei-edit-search.pod b/Documentation/lei-edit-search.pod
new file mode 100644
index 00000000..7908b5a2
--- /dev/null
+++ b/Documentation/lei-edit-search.pod
@@ -0,0 +1,28 @@
+=head1 NAME
+
+lei-edit-search - edit saved search
+
+=head1 SYNOPSIS
+
+lei edit-search [OPTIONS] OUTPUT
+
+=head1 DESCRIPTION
+
+Invoke C<git config --edit> to edit the saved search at C<OUTPUT>.
+
+=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>
+
+=head1 SEE ALSO
+
+L<lei-ls-search(1)>, L<lei-forget-search(1)>, L<lei-up(1)>, L<lei-q(1)>
diff --git a/Documentation/lei-forget-search.pod b/Documentation/lei-forget-search.pod
new file mode 100644
index 00000000..49bc1d68
--- /dev/null
+++ b/Documentation/lei-forget-search.pod
@@ -0,0 +1,28 @@
+=head1 NAME
+
+lei-forget-search - forget saved search
+
+=head1 SYNOPSIS
+
+lei forget-search [OPTIONS] OUTPUT
+
+=head1 DESCRIPTION
+
+Forget a saved search at C<OUTPUT>.
+
+=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>
+
+=head1 SEE ALSO
+
+L<lei-edit-search(1)>, L<lei-ls-search(1)>, L<lei-up(1)>, L<lei-q(1)>
diff --git a/Documentation/lei-lcat.pod b/Documentation/lei-lcat.pod
new file mode 100644
index 00000000..5a2bdb5a
--- /dev/null
+++ b/Documentation/lei-lcat.pod
@@ -0,0 +1,79 @@
+=head1 NAME
+
+lei-lcat - display local copy of messages(s)
+
+=head1 SYNOPSIS
+
+lei lcat [OPTIONS] MSGID_OR_URL [MSGID_OR_URL...]
+
+lei lcat [OPTIONS] (--stdin|-)
+
+=head1 DESCRIPTION
+
+lcat (local cat) is a wrapper around L<lei-q(1)> that displays local
+messages by Message-ID. It is able to extract Message-IDs from URLs
+as well as from common formats such as C<E<lt>$MSGIDE<gt>> and
+C<id:$MSGID>. When reading from stdin, input that isn't understood is
+discarded, so the caller doesn't have to bother extracting the
+Message-ID or link from surrounding text (e.g., a "Link: $URL" line).
+
+=head1 OPTIONS
+
+The following options, described in L<lei-q(1)>, are supported.
+
+=over
+
+=item --[no-]remote
+
+=item --no-local
+
+=item --no-external
+
+=item --no-import-remote
+
+=item --torsocks=auto|no|yes, --no-torsocks
+
+=item --proxy=PROTO://HOST[:PORT]
+
+=item -o MFOLDER, --output=MFOLDER
+
+=item -d STRATEGY, --dedupe=STRATEGY
+
+=item -t, --threads
+
+=item -s KEY, --sort=KEY
+
+=item -r, --reverse
+
+=item --offset=NUMBER
+
+=item -g, --globoff
+
+=item -a, --augment
+
+=item --lock=METHOD
+
+=item --alert=COMMAND
+
+=item --mua=COMMAND
+
+=item --no-color
+
+=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>
+
+=head1 SEE ALSO
+
+L<lei-q(1)>, L<lei-blob(1)>
diff --git a/Documentation/lei-ls-mail-sync.pod b/Documentation/lei-ls-mail-sync.pod
new file mode 100644
index 00000000..37aa910f
--- /dev/null
+++ b/Documentation/lei-ls-mail-sync.pod
@@ -0,0 +1,55 @@
+=head1 NAME
+
+lei-ls-mail-sync - list mail sync folders
+
+=head1 SYNOPSIS
+
+lei mail-sync [OPTIONS] [FILTER]
+
+=head1 DESCRIPTION
+
+List mail sync folders. If C<FILTER> is given, restrict the output to
+matching entries.
+
+=head1 OPTIONS
+
+=over
+
+=item -g
+
+=item --globoff
+
+Do not match C<FILTER> using C<*?> wildcards and C<[]> ranges.
+
+=item --local
+
+Limit operations to the local filesystem.
+
+=item --remote
+
+Limit operations to those requiring network access.
+
+=item -z
+
+=item -0
+
+Use C<\0> (NUL) instead of newline (CR) to delimit lines.
+
+=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>
+
+=head1 SEE ALSO
+
+L<lei-q(1)>, L<lei-up(1)>
diff --git a/Documentation/lei-ls-search.pod b/Documentation/lei-ls-search.pod
new file mode 100644
index 00000000..138dbbff
--- /dev/null
+++ b/Documentation/lei-ls-search.pod
@@ -0,0 +1,65 @@
+=head1 NAME
+
+lei-ls-search - list saved search queries
+
+=head1 SYNOPSIS
+
+lei ls-search [OPTIONS] [PREFIX]
+
+=head1 DESCRIPTION
+
+List saved search queries. If C<PREFIX> is given, restrict the output
+to entries that start with the specified value.
+
+=head1 OPTIONS
+
+=over
+
+=item -f FORMAT
+
+=item --format=FORMAT
+
+Display JSON output rather than default short output that includes
+only the saved search location. Possible values are C<json>,
+C<jsonl>, or C<concatjson>.
+
+=item --pretty
+
+Pretty print C<json> or C<concatjson> output. If stdout is opened to
+a tty and used as the C<--output> destination, C<--pretty> is enabled
+by default.
+
+=item -l
+
+Long listing format (shortcut for C<--format=json>).
+
+=item --ascii
+
+Escape non-ASCII characters.
+
+=item -z
+
+=item -0
+
+Use C<\0> (NUL) instead of newline (CR) to delimit lines. This option
+is incompatible with C<--format>.
+
+=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>
+
+=head1 SEE ALSO
+
+L<lei-q(1)>, L<lei-up(1)>, L<lei-edit-search(1)>,
+L<lei-forget-search(1)>
diff --git a/Documentation/lei-overview.pod b/Documentation/lei-overview.pod
index 4a34bc16..e80cb094 100644
--- a/Documentation/lei-overview.pod
+++ b/Documentation/lei-overview.pod
@@ -98,6 +98,18 @@ Search for messages that have post-image git blob IDs that match those
of the current repository's HEAD commit, writing them to the Maildir
directory "mdir" and flagging the messages that were an exact match.
+=item $ git show -s HEAD | lei lcat -
+
+Display a local message for the public-inbox link contained in a
+commit message.
+
+=item $ lei q -f text m:MID | lei rediff -U5 -
+
+Feed a message containing a diff to L<lei-rediff(1)> to regenerate its
+diff with five context lines. Unless C<--git-dir> is specified, this
+requires the current working directory to be within the associated
+code repository.
+
=back
=head1 PERFORMANCE NOTES
diff --git a/Documentation/lei-q.pod b/Documentation/lei-q.pod
index 39199849..c4a7eea3 100644
--- a/Documentation/lei-q.pod
+++ b/Documentation/lei-q.pod
@@ -246,5 +246,5 @@ License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
=head1 SEE ALSO
-L<lei-add-external(1)>,
+L<lei-add-external(1)>, L<lei-lcat(1)>, L<lei-up(1)>,
L<Xapian::QueryParser Syntax|https://xapian.org/docs/queryparser.html>
diff --git a/Documentation/lei-rediff.pod b/Documentation/lei-rediff.pod
new file mode 100644
index 00000000..5fdde230
--- /dev/null
+++ b/Documentation/lei-rediff.pod
@@ -0,0 +1,79 @@
+=head1 NAME
+
+lei-rediff - regenerate a diff with different options
+
+=head1 SYNOPSIS
+
+lei rediff [OPTIONS] LOCATION [LOCATION...]
+
+lei rediff [OPTIONS] (--stdin|-)
+
+=head1 DESCRIPTION
+
+Read a message from C<LOCATION> or stdin and regenerate its diff with
+the specified L<git-diff(1)> options. This is useful if you want to
+change the display of the original patch (e.g., increasing context,
+coloring moved lines differently, or using an external diff viewer).
+
+=head1 OPTIONS
+
+In addition to many L<git-diff(1)>, the following options are
+supported.
+
+=over
+
+=item --stdin
+
+Read message from stdin.
+
+=item --git-dir=DIR
+
+Specify an additional .git/ directory to scan. This option may be
+given multiple times.
+
+=item --no-cwd
+
+Do not look in the git repository of the current working directory.
+
+=item -v
+
+=item --verbose
+
+Provide more feedback on stderr.
+
+=back
+
+The options below, described in L<lei-q(1)>, are also supported.
+
+=over
+
+=item --[no-]remote
+
+=item --no-local
+
+=item --no-external
+
+=item --no-import-remote
+
+=item --torsocks=auto|no|yes, --no-torsocks
+
+=item --proxy=PROTO://HOST[:PORT]
+
+=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>
+
+=head1 SEE ALSO
+
+L<lei-q(1)>, L<lei-blob(1)>, L<lei-p2q(1)>
diff --git a/Documentation/lei-up.pod b/Documentation/lei-up.pod
new file mode 100644
index 00000000..cea0f619
--- /dev/null
+++ b/Documentation/lei-up.pod
@@ -0,0 +1,48 @@
+=head1 NAME
+
+lei-up - update a saved search
+
+=head1 SYNOPSIS
+
+lei up [OPTIONS] OUTPUT
+
+lei up [OPTIONS] --all=TYPE
+
+=head1 DESCRIPTION
+
+Update the saved search at C<OUTPUT> or all saved searches of C<TYPE>
+(currently C<local> is the only supported value).
+
+=head1 OPTIONS
+
+The following options, described in L<lei-q(1)>, are supported.
+
+=over
+
+=item --lock=METHOD
+
+=item --alert=CMD
+
+=item --mua=CMD
+
+This option is incompatible with C<--all>.
+
+=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>
+
+=head1 SEE ALSO
+
+L<lei-q(1)>, L<lei-ls-search(1)>, L<lei-edit-search(1)>,
+L<lei-forget-search(1)>
diff --git a/Documentation/lei.pod b/Documentation/lei.pod
index 78e1fb1e..3af9e2ee 100644
--- a/Documentation/lei.pod
+++ b/Documentation/lei.pod
@@ -72,10 +72,24 @@ store and configured externals are
=item * L<lei-blob(1)>
+=item * L<lei-config(1)>
+
+=item * L<lei-edit-search(1)>
+
+=item * L<lei-forget-search(1)>
+
+=item * L<lei-lcat(1)>
+
+=item * L<lei-ls-search(1)>
+
=item * L<lei-p2q(1)>
=item * L<lei-q(1)>
+=item * L<lei-rediff(1)>
+
+=item * L<lei-up(1)>
+
=back
Other subcommands include
@@ -92,6 +106,8 @@ Other subcommands include
=item * L<lei-ls-label(1)>
+=item * L<lei-ls-mail-sync(1)>
+
=back
=head1 FILES
diff --git a/Documentation/txt2pre b/Documentation/txt2pre
index 201566ee..d98dfdd3 100755
--- a/Documentation/txt2pre
+++ b/Documentation/txt2pre
@@ -17,15 +17,22 @@ for (qw[lei(1)
lei-convert(1)
lei-daemon-kill(1)
lei-daemon-pid(1)
+ lei-edit-search(1)
lei-forget-external(1)
+ lei-forget-search(1)
lei-import(1)
lei-init(1)
+ lei-lcat(1)
lei-ls-external(1)
lei-ls-label(1)
+ lei-ls-mail-sync(1)
+ lei-ls-search(1)
lei-overview(7)
lei-p2q(1)
lei-q(1)
+ lei-rediff(1)
lei-tag(1)
+ lei-up(1)
public-inbox.cgi(1)
public-inbox-compact(1)
public-inbox-config(5)
@@ -68,6 +75,7 @@ for (qw[git(1)
git-config(1)
git-credential(1)
git-daemon(1)
+ git-diff(1)
git-fast-import(1)
git-fetch(1)
git-filter-branch(1)
diff --git a/MANIFEST b/MANIFEST
index 29e62880..c7084671 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -23,21 +23,28 @@ Documentation/hosted.txt
Documentation/include.mk
Documentation/lei-add-external.pod
Documentation/lei-blob.pod
+Documentation/lei-cat.pod
Documentation/lei-config.pod
Documentation/lei-convert.pod
Documentation/lei-daemon-kill.pod
Documentation/lei-daemon-pid.pod
+Documentation/lei-edit-search.pod
Documentation/lei-forget-external.pod
+Documentation/lei-forget-search.pod
Documentation/lei-import.pod
Documentation/lei-init.pod
Documentation/lei-ls-external.pod
Documentation/lei-ls-label.pod
+Documentation/lei-ls-mail-sync.pod
+Documentation/lei-ls-search.pod
Documentation/lei-mail-formats.pod
Documentation/lei-overview.pod
Documentation/lei-p2q.pod
Documentation/lei-q.pod
+Documentation/lei-rediff.pod
Documentation/lei-store-format.pod
Documentation/lei-tag.pod
+Documentation/lei-up.pod
Documentation/lei.pod
Documentation/lei_design_notes.txt
Documentation/marketing.txt
diff --git a/Makefile.PL b/Makefile.PL
index d149a164..2af8c2f1 100644
--- a/Makefile.PL
+++ b/Makefile.PL
@@ -45,9 +45,11 @@ $v->{-m1} = [ map {
}
} @EXE_FILES,
qw(
- lei-add-external lei-blob lei-config lei-convert lei-daemon-kill
- lei-daemon-pid lei-forget-external lei-import lei-init lei-ls-external
- lei-ls-label lei-p2q lei-q lei-tag)];
+ lei-add-external lei-blob lei-config lei-convert lei-edit-search
+ lei-daemon-kill lei-daemon-pid lei-forget-external lei-forget-search
+ lei-import lei-init lei-lcat lei-ls-external lei-ls-label
+ lei-ls-mail-sync lei-ls-search lei-p2q lei-q lei-rediff lei-tag
+ lei-up)];
$v->{-m5} = [ qw(public-inbox-config public-inbox-v1-format
public-inbox-v2-format public-inbox-extindex-format
lei-mail-formats lei-store-format
--
2.31.1
^ permalink raw reply related [relevance 2%]
* [PATCH 0/9] doc: lei manpages, round 5
@ 2021-05-17 3:35 7% Kyle Meyer
2021-05-17 3:35 2% ` [PATCH 8/9] doc lei: add manpages for new commands Kyle Meyer
0 siblings, 1 reply; 8+ results
From: Kyle Meyer @ 2021-05-17 3:35 UTC (permalink / raw)
To: meta
This series updates the lei manpages, continuing from
<20210329031117.28516-1-kyle@kyleam.com>. It covers changes up to the
current tip of master (236831da32b1240d..8cc23ac6f7a38479).
The second patch touches outside of lei manpages as a followup to
e226f18934eb7291 (doc: lei q: split =item aliases onto separate lines,
2021-04-28).
[1/9] doc lei blob: avoid combined description of separate options
[2/9] doc: split option variants into separate items
[3/9] doc lei blob: point to lei-q for shared options
[4/9] doc lei: resort lei-tag entries
[5/9] doc lei q: fix a typo
[6/9] doc lei q: add missing value for --lock
[7/9] doc lei: add manpage for convert
[8/9] doc lei: add manpages for new commands
[9/9] doc lei: update manpages with new options
Documentation/lei-add-external.pod | 12 ++-
Documentation/lei-blob.pod | 62 +++++++--------
.../{lei-import.pod => lei-convert.pod} | 40 ++++++----
Documentation/lei-edit-search.pod | 28 +++++++
Documentation/lei-forget-external.pod | 4 +-
Documentation/lei-forget-search.pod | 28 +++++++
Documentation/lei-import.pod | 20 ++++-
Documentation/lei-init.pod | 4 +-
Documentation/lei-lcat.pod | 79 +++++++++++++++++++
Documentation/lei-ls-external.pod | 8 +-
Documentation/lei-ls-label.pod | 8 +-
...i-ls-external.pod => lei-ls-mail-sync.pod} | 22 +++---
Documentation/lei-ls-search.pod | 65 +++++++++++++++
Documentation/lei-overview.pod | 12 +++
Documentation/lei-p2q.pod | 8 +-
Documentation/lei-q.pod | 16 +++-
Documentation/lei-rediff.pod | 79 +++++++++++++++++++
Documentation/lei-tag.pod | 8 +-
Documentation/lei-up.pod | 48 +++++++++++
Documentation/lei.pod | 18 +++++
Documentation/public-inbox-compact.pod | 6 +-
Documentation/public-inbox-convert.pod | 4 +-
Documentation/public-inbox-daemon.pod | 16 +++-
Documentation/public-inbox-extindex.pod | 4 +-
Documentation/public-inbox-imapd.pod | 4 +-
Documentation/public-inbox-index.pod | 12 ++-
Documentation/public-inbox-init.pod | 20 +++--
Documentation/public-inbox-nntpd.pod | 4 +-
Documentation/public-inbox-xcpdb.pod | 14 +++-
Documentation/txt2pre | 11 ++-
MANIFEST | 8 ++
Makefile.PL | 8 +-
32 files changed, 580 insertions(+), 100 deletions(-)
copy Documentation/{lei-import.pod => lei-convert.pod} (54%)
create mode 100644 Documentation/lei-edit-search.pod
create mode 100644 Documentation/lei-forget-search.pod
create mode 100644 Documentation/lei-lcat.pod
copy Documentation/{lei-ls-external.pod => lei-ls-mail-sync.pod} (64%)
create mode 100644 Documentation/lei-ls-search.pod
create mode 100644 Documentation/lei-rediff.pod
create mode 100644 Documentation/lei-up.pod
base-commit: 8cc23ac6f7a3847977ec57c2a3e9e391fdb94da6
--
2.31.1
^ permalink raw reply [relevance 7%]
* Re: [PATCH 6/8] doc lei: add manpages for new commands
2021-03-29 3:25 6% ` Eric Wong
@ 2021-03-29 3:35 6% ` Kyle Meyer
0 siblings, 0 replies; 8+ results
From: Kyle Meyer @ 2021-03-29 3:35 UTC (permalink / raw)
To: Eric Wong; +Cc: meta
Eric Wong writes:
> Kyle Meyer <kyle@kyleam.com> wrote:
>> +=for comment
>
>> +TODO: The below options are shared with lei-q. Any good approaches to
>> +not repeating the text?
>
> I don't know about natively in POD. Perhaps just a list of
> switches and a pointer to lei-q(1)?
Yeah, this sounds like the way to go to me. I'll make a note to do it
for the next round.
Thanks.
^ permalink raw reply [relevance 6%]
* Re: [PATCH 6/8] doc lei: add manpages for new commands
2021-03-29 3:11 2% ` [PATCH 6/8] doc lei: add manpages for new commands Kyle Meyer
@ 2021-03-29 3:25 6% ` Eric Wong
2021-03-29 3:35 6% ` Kyle Meyer
0 siblings, 1 reply; 8+ results
From: Eric Wong @ 2021-03-29 3:25 UTC (permalink / raw)
To: Kyle Meyer; +Cc: meta
Kyle Meyer <kyle@kyleam.com> wrote:
> +=for comment
> +TODO: The below options are shared with lei-q. Any good approaches to
> +not repeating the text?
I don't know about natively in POD. Perhaps just a list of
switches and a pointer to lei-q(1)?
Or maybe we generate some .pod files via cat + sh
cat lei-blob.pod.in lei-q-common.pod.in >lei-blob.pod
I don't know if depending on cpp or some other widely-installed
preprocessor is worth it.
> +=for comment
> +TODO: Put a table of prefixes somewhere and reference that (at least
> +here and in lei-q)?
Yes, probably.
^ permalink raw reply [relevance 6%]
* [PATCH 6/8] doc lei: add manpages for new commands
2021-03-29 3:11 7% [PATCH 0/8] doc: lei manpages, round 4 Kyle Meyer
@ 2021-03-29 3:11 2% ` Kyle Meyer
2021-03-29 3:25 6% ` Eric Wong
0 siblings, 1 reply; 8+ results
From: Kyle Meyer @ 2021-03-29 3:11 UTC (permalink / raw)
To: meta
---
Documentation/lei-blob.pod | 109 +++++++++++++++++++++++++++++++++
Documentation/lei-ls-label.pod | 43 +++++++++++++
Documentation/lei-mark.pod | 58 ++++++++++++++++++
Documentation/lei-overview.pod | 21 +++++++
Documentation/lei-p2q.pod | 79 ++++++++++++++++++++++++
Documentation/lei.pod | 8 +++
Documentation/txt2pre | 4 ++
MANIFEST | 4 ++
Makefile.PL | 5 +-
9 files changed, 329 insertions(+), 2 deletions(-)
create mode 100644 Documentation/lei-blob.pod
create mode 100644 Documentation/lei-ls-label.pod
create mode 100644 Documentation/lei-mark.pod
create mode 100644 Documentation/lei-p2q.pod
diff --git a/Documentation/lei-blob.pod b/Documentation/lei-blob.pod
new file mode 100644
index 00000000..ecdd1e99
--- /dev/null
+++ b/Documentation/lei-blob.pod
@@ -0,0 +1,109 @@
+=head1 NAME
+
+lei-blob - display a git blob, reconstructing from mail if necessary
+
+=head1 SYNOPSIS
+
+lei blob [OPTIONS] OID
+
+=head1 DESCRIPTION
+
+Display a git blob. The blob may correspond to a message from the
+local store, an existing blob in the current repository, or a
+not-yet-created blob in the current repository that can be
+reconstructed from a message.
+
+=head1 OPTIONS
+
+=over
+
+=item --git-dir=DIR
+
+Specify an additional .git/ directory to scan. This option may be
+given multiple times.
+
+=item --no-cwd
+
+Do not look in the git repository of the current working directory.
+
+=item --no-mail
+
+Do not look in mail storage for C<OID>. This is implied by
+C<--oid-a>, C<--path-a>, and C<--path-b>.
+
+=item -A OID-A, --oid-a=OID-A
+
+=item -a PATH-A, --path-a=PATH-A
+
+=item -b PATH-B, --path-b=PATH-B
+
+Provide pre-image object ID, pre-image pathname, or post-image
+pathname as a hint for reconstructing C<OID>.
+
+=for comment
+TODO: The below options are shared with lei-q. Any good approaches to
+not repeating the text?
+
+=item --[no-]remote
+
+Whether to include results requiring network access. When local
+externals are configured, C<--remote> must be explicitly passed to
+enable reporting of results from remote externals.
+
+=item --no-local
+
+Limit operations to those requiring network access.
+
+=item --no-external
+
+Don't include results from externals.
+
+=item -I LOCATION, --include=LOCATION
+
+Include specified external in search. This option may be given
+multiple times.
+
+=item --exclude=LOCATION
+
+Exclude specified external from search. This option may be given
+multiple times.
+
+=item --only=LOCATION
+
+Use only the specified external for search. This option may be given
+multiple times, in which case the search uses only the specified set.
+
+=item --no-import-remote
+
+Disable the default behavior of memoizing remote messages into the
+local store.
+
+=item -v, --verbose
+
+Provide more feedback on stderr.
+
+=item --torsocks=auto|no|yes, --no-torsocks
+
+Whether to wrap L<git(1)> and L<curl(1)> commands with torsocks.
+
+Default: C<auto>
+
+=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>
+
+
+=head1 SEE ALSO
+
+L<lei-add-external(1)>
diff --git a/Documentation/lei-ls-label.pod b/Documentation/lei-ls-label.pod
new file mode 100644
index 00000000..0b4e8769
--- /dev/null
+++ b/Documentation/lei-ls-label.pod
@@ -0,0 +1,43 @@
+=head1 NAME
+
+lei-ls-label - list labels
+
+=head1 SYNOPSIS
+
+lei ls-label [OPTIONS]
+
+=head1 DESCRIPTION
+
+List all known message labels ("mailboxes" in JMAP terminology).
+
+=head1 OPTIONS
+
+=over
+
+=item -z, -0
+
+Use C<\0> (NUL) instead of newline (CR) to delimit lines.
+
+=item -q, --quiet
+
+Suppress feedback messages.
+
+=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>
+
+
+=head1 SEE ALSO
+
+L<lei-add-external(1)>
diff --git a/Documentation/lei-mark.pod b/Documentation/lei-mark.pod
new file mode 100644
index 00000000..8ef1dce2
--- /dev/null
+++ b/Documentation/lei-mark.pod
@@ -0,0 +1,58 @@
+=head1 NAME
+
+lei-mark - set/unset metadata on messages
+
+=head1 SYNOPSIS
+
+lei mark [OPTIONS] FILE [FILE...] METADATA [METADATA...]
+
+lei mark [OPTIONS] (-|--stdin) METADATA [METADATA...]
+
+=head1 DESCRIPTION
+
+Set or unset volatile metadata on messages. In JMAP terms, "volatile
+metadata" includes "mailboxes" (analogous to a folder or label) and a
+restricted set of "keywords". This supported keywords are the
+combination of system keywords (seen, answered, flagged, and draft),
+which map to Maildir flags and mbox Status/X-Status headers, as well
+as reserved keywords (forwarded, phishing, junk, and notjunk).
+
+To add a label or keyword, prefix it with "+L:" and "+kw:",
+respectively. To remove a label or keyword, use "-L:" or "-kw:". For
+example, "+kw:flagged" would set the "flagged" keyword for the
+specified messages, and "-L:INBOX" would remove the "INBOX" label.
+
+=head1 OPTIONS
+
+=over
+
+=item -F MAIL_FORMAT, --in-format=MAIL_FORMAT
+
+Message input format: C<eml>, C<mboxrd>, C<mboxcl2>, C<mboxcl>, or
+C<mboxo>.
+
+Default: C<eml>
+
+=item -q, --quiet
+
+Suppress feedback messages.
+
+=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>
+
+
+=head1 SEE ALSO
+
+L<lei-add-external(1)>
diff --git a/Documentation/lei-overview.pod b/Documentation/lei-overview.pod
index c3379caa..7c7337ab 100644
--- a/Documentation/lei-overview.pod
+++ b/Documentation/lei-overview.pod
@@ -20,6 +20,17 @@ L<public-inbox-v2-format(5)>.
Import the messages from an mbox into the local storage.
+=item $ lei blob 59ec517f9
+
+Show message with the git blob OID of 59ec517f9. If a message with
+that OID isn't found, check if the current git repository has the
+blob, trying to reconstruct it from a message if needed.
+
+=item $ lei blob 59ec517f9 | lei mark - -F eml +kw:flagged +L:next
+
+Set the "flagged" keyword and "next" label on the message with the
+blob OID of 59ec517f9.
+
=back
=head1 EXTERNALS
@@ -69,6 +80,16 @@ thread as a matched message.
Write mboxcl2-formatted results to t.mbox and enter mutt to view the
file by invoking C<mutt -f %f>.
+=item $ lei q kw:flagged L:next
+
+Search for all flagged messages that also have a "next" label.
+
+=item $ lei p2q HEAD | lei q --stdin -tt -o mdir
+
+Search for messages that have post-image git blob IDs that match those
+of the current repository's HEAD commit, writing them to the Maildir
+directory "mdir" and flagging the messages that were an exact match.
+
=back
=head1 PERFORMANCE NOTES
diff --git a/Documentation/lei-p2q.pod b/Documentation/lei-p2q.pod
new file mode 100644
index 00000000..cc342bd5
--- /dev/null
+++ b/Documentation/lei-p2q.pod
@@ -0,0 +1,79 @@
+=head1 NAME
+
+lei-p2q - use a patch to generate a lei-q query
+
+=head1 SYNOPSIS
+
+lei p2q [OPTIONS] (FILE|COMMIT)
+
+lei p2q [OPTIONS] (--stdin|-)
+
+=head1 DESCRIPTION
+
+Given a patch, create a query that can be fed on stdin to L<lei-q(1)>.
+This is useful for mapping the patch to associated messages of an
+inbox.
+
+The patch can be provided on stdin or as a file. Alternatively, when
+an argument is given that does not point to an existing file, it is
+taken as a reference to a commit in the current repository, and
+L<git-format-patch(1)> is used to generate the patch.
+
+=head1 OPTIONS
+
+=over
+
+=item -w PREFIX[,PREFIX], --want=PREFIX[,PREFIX]
+
+Search prefixes to use. C<dfpost> (post-image git blob ID) and C<dfn>
+(file names from the diff) are the most useful. Other available
+values are C<dfa>, C<dfb>, C<dfctx>, C<dfhh>, and C<dfpre>.
+
+=for comment
+TODO: Put a table of prefixes somewhere and reference that (at least
+here and in lei-q)?
+
+Appending an integer to C<dfpost> or C<dfpre> indicates a minimum ID
+length, and the generated query will be for that value up through the
+default abbreviation length. For example, if the repository's
+C<core.abbrev> is set to C<auto> and git calculates the default
+abbreviation length as 7, C<dfpost6> will expand a post-image blob ID
+of e7b4b32 (seven characters) into C<dfpost:e7b4b32 OR dfpost:e7b4b3>.
+
+This option may be given multiple times.
+
+Default: C<dfpost7>
+
+=item --stdin
+
+Read patch from stdin.
+
+=item --debug
+
+Dump output that shows the information collected for every prefix.
+This information can be useful for seeing how a patch is processed,
+but the format should not be considered stable.
+
+=item -q, --quiet
+
+Suppress feedback messages.
+
+=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>
+
+
+=head1 SEE ALSO
+
+L<lei-add-external(1)>
diff --git a/Documentation/lei.pod b/Documentation/lei.pod
index 0b81b9f3..6c8cfc3d 100644
--- a/Documentation/lei.pod
+++ b/Documentation/lei.pod
@@ -46,6 +46,8 @@ Subcommands for initializing and managing local, writable storage:
=item * L<lei-import(1)>
+=item * L<lei-mark(1)>
+
=back
The following subcommands can be used to manage and inspect external
@@ -66,6 +68,10 @@ store and configured externals are
=over
+=item * L<lei-blob(1)>
+
+=item * L<lei-p2q(1)>
+
=item * L<lei-q(1)>
=back
@@ -80,6 +86,8 @@ Other subcommands include
=item * L<lei-daemon-pid(1)>
+=item * L<lei-ls-label(1)>
+
=back
=head1 FILES
diff --git a/Documentation/txt2pre b/Documentation/txt2pre
index 244dc50c..bfffdef1 100755
--- a/Documentation/txt2pre
+++ b/Documentation/txt2pre
@@ -12,6 +12,7 @@ use PublicInbox::Hval qw(ascii_html);
my %xurls;
for (qw[lei(1)
lei-add-external(1)
+ lei-blob(1)
lei-config(1)
lei-daemon-kill(1)
lei-daemon-pid(1)
@@ -19,7 +20,10 @@ for (qw[lei(1)
lei-import(1)
lei-init(1)
lei-ls-external(1)
+ lei-ls-label(1)
+ lei-mark(1)
lei-overview(7)
+ lei-p2q(1)
lei-q(1)
public-inbox.cgi(1)
public-inbox-compact(1)
diff --git a/MANIFEST b/MANIFEST
index 913ce55c..3d521a64 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -22,6 +22,7 @@ Documentation/flow.txt
Documentation/hosted.txt
Documentation/include.mk
Documentation/lei-add-external.pod
+Documentation/lei-blob.pod
Documentation/lei-config.pod
Documentation/lei-daemon-kill.pod
Documentation/lei-daemon-pid.pod
@@ -29,7 +30,10 @@ Documentation/lei-forget-external.pod
Documentation/lei-import.pod
Documentation/lei-init.pod
Documentation/lei-ls-external.pod
+Documentation/lei-ls-label.pod
+Documentation/lei-mark.pod
Documentation/lei-overview.pod
+Documentation/lei-p2q.pod
Documentation/lei-q.pod
Documentation/lei.pod
Documentation/marketing.txt
diff --git a/Makefile.PL b/Makefile.PL
index 8165e601..cdb67214 100644
--- a/Makefile.PL
+++ b/Makefile.PL
@@ -44,8 +44,9 @@ $v->{-m1} = [ map {
}
} @EXE_FILES,
qw(
- lei-add-external lei-config lei-daemon-kill lei-daemon-pid
- lei-forget-external lei-import lei-init lei-ls-external lei-q)];
+ lei-add-external lei-blob lei-config lei-daemon-kill lei-daemon-pid
+ lei-forget-external lei-import lei-init lei-ls-external lei-ls-label
+ lei-mark lei-p2q lei-q)];
$v->{-m5} = [ qw(public-inbox-config public-inbox-v1-format
public-inbox-v2-format public-inbox-extindex-format) ];
$v->{-m7} = [ qw(lei-overview public-inbox-overview public-inbox-tuning
--
2.31.0
^ permalink raw reply related [relevance 2%]
* [PATCH 0/8] doc: lei manpages, round 4
@ 2021-03-29 3:11 7% Kyle Meyer
2021-03-29 3:11 2% ` [PATCH 6/8] doc lei: add manpages for new commands Kyle Meyer
0 siblings, 1 reply; 8+ results
From: Kyle Meyer @ 2021-03-29 3:11 UTC (permalink / raw)
To: meta
This series updates the lei manpages, continuing from
<20210227180328.28057-1-kyle@kyleam.com>. It covers changes up to the
current tip of master (c9ff20cbef45d32e..80f4192574065106).
[1/8] doc lei-q: fix typo in -tt description
[2/8] doc lei: note --stdin shortcut in synopses
[3/8] doc lei: drop an unnecessary to-do comment
[4/8] doc lei: don't render most to-do comments
[5/8] doc lei: update manpages with new options
[6/8] doc lei: add manpages for new commands
[7/8] doc lei overview: note that lei-init is usually unnecessary
[8/8] doc lei overview: better explain routes into local store
Documentation/lei-add-external.pod | 1 +
Documentation/lei-blob.pod | 109 +++++++++++++++++++++++++++++
Documentation/lei-import.pod | 2 +-
Documentation/lei-ls-label.pod | 43 ++++++++++++
Documentation/lei-mark.pod | 58 +++++++++++++++
Documentation/lei-overview.pod | 32 ++++++++-
Documentation/lei-p2q.pod | 79 +++++++++++++++++++++
Documentation/lei-q.pod | 13 +++-
Documentation/lei.pod | 14 +++-
Documentation/txt2pre | 4 ++
MANIFEST | 4 ++
Makefile.PL | 5 +-
12 files changed, 355 insertions(+), 9 deletions(-)
create mode 100644 Documentation/lei-blob.pod
create mode 100644 Documentation/lei-ls-label.pod
create mode 100644 Documentation/lei-mark.pod
create mode 100644 Documentation/lei-p2q.pod
base-commit: 80f4192574065106ae72a7a73ee0f02ebd86708a
--
2.31.0
^ permalink raw reply [relevance 7%]
Results 1-8 of 8 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2021-03-29 3:11 7% [PATCH 0/8] doc: lei manpages, round 4 Kyle Meyer
2021-03-29 3:11 2% ` [PATCH 6/8] doc lei: add manpages for new commands Kyle Meyer
2021-03-29 3:25 6% ` Eric Wong
2021-03-29 3:35 6% ` Kyle Meyer
2021-05-17 3:35 7% [PATCH 0/9] doc: lei manpages, round 5 Kyle Meyer
2021-05-17 3:35 2% ` [PATCH 8/9] doc lei: add manpages for new commands Kyle Meyer
2021-05-17 8:09 6% ` Eric Wong
2021-05-17 23:24 6% ` Kyle Meyer
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).