* [PATCH 0/9] doc: lei manpages, round 5
@ 2021-05-17 3:35 6% Kyle Meyer
0 siblings, 0 replies; 5+ 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 6%]
* Re: [PATCH 2/3] doc: lei q: split =item aliases onto separate lines
2021-04-29 1:39 7% ` Kyle Meyer
@ 2021-04-29 1:57 7% ` Eric Wong
0 siblings, 0 replies; 5+ results
From: Eric Wong @ 2021-04-29 1:57 UTC (permalink / raw)
To: Kyle Meyer; +Cc: meta
Kyle Meyer <kyle@kyleam.com> wrote:
> Eric Wong writes:
>
> > It makes L</--augment> look nicer without resorting to
> > L<--augment|/-a, --augment> and similarly verbose nastiness.
> >
> > Having each option as a separate =item (with a blank line in
> > between each =item) seems to be the preferred style used within
> > Perl core documentation (I used perlrun.pod as an example),
> > so we'll follow Perl core style, here.
>
> Okay, thanks providing a rationale for using separate lines. I went
> with the single line style based on some combination of a subjective
> visual preference and looking at other manpages (presumably git's).
Yeah, also the existing public-inbox-* manpages were using
commas or slash; probably because I based them on git manpages :x
> > This needs to be done for other manpages, at some point...
>
> I should be able to get to another round of lei doc updates this
> weekend.
Thanks in advance. Also, in response to
https://public-inbox.org/meta/20210227180328.28057-1-kyle@kyleam.com/
w.r.t. lei-convert; I think it's helpful to document
since the WWW interface provides gzipped mboxrd and
IMAP|Maildir are probably the most commonly used.
^ permalink raw reply [relevance 7%]
* Re: [PATCH 2/3] doc: lei q: split =item aliases onto separate lines
2021-04-28 4:51 5% ` [PATCH 2/3] doc: lei q: split =item aliases onto separate lines Eric Wong
@ 2021-04-29 1:39 7% ` Kyle Meyer
2021-04-29 1:57 7% ` Eric Wong
0 siblings, 1 reply; 5+ results
From: Kyle Meyer @ 2021-04-29 1:39 UTC (permalink / raw)
To: Eric Wong; +Cc: meta
Eric Wong writes:
> It makes L</--augment> look nicer without resorting to
> L<--augment|/-a, --augment> and similarly verbose nastiness.
>
> Having each option as a separate =item (with a blank line in
> between each =item) seems to be the preferred style used within
> Perl core documentation (I used perlrun.pod as an example),
> so we'll follow Perl core style, here.
Okay, thanks providing a rationale for using separate lines. I went
with the single line style based on some combination of a subjective
visual preference and looking at other manpages (presumably git's).
> This needs to be done for other manpages, at some point...
I should be able to get to another round of lei doc updates this
weekend.
^ permalink raw reply [relevance 7%]
* [PATCH 0/3] doc: lei updates around lei-q
@ 2021-04-28 4:51 6% Eric Wong
2021-04-28 4:51 5% ` [PATCH 2/3] doc: lei q: split =item aliases onto separate lines Eric Wong
0 siblings, 1 reply; 5+ results
From: Eric Wong @ 2021-04-28 4:51 UTC (permalink / raw)
To: meta
1/3 is probably a game changer and will help anybody supporting
this project sleep easier at night :)
Eric Wong (3):
doc: lei: use /tmp for search results pathnames
doc: lei q: split =item aliases onto separate lines
doc: lei q: split --output and --format, note "text"
Documentation/lei-overview.pod | 4 +-
Documentation/lei-q.pod | 88 +++++++++++++++++++++++-----------
2 files changed, 63 insertions(+), 29 deletions(-)
^ permalink raw reply [relevance 6%]
* [PATCH 2/3] doc: lei q: split =item aliases onto separate lines
2021-04-28 4:51 6% [PATCH 0/3] doc: lei updates around lei-q Eric Wong
@ 2021-04-28 4:51 5% ` Eric Wong
2021-04-29 1:39 7% ` Kyle Meyer
0 siblings, 1 reply; 5+ results
From: Eric Wong @ 2021-04-28 4:51 UTC (permalink / raw)
To: meta
It makes L</--augment> look nicer without resorting to
L<--augment|/-a, --augment> and similarly verbose nastiness.
Having each option as a separate =item (with a blank line in
between each =item) seems to be the preferred style used within
Perl core documentation (I used perlrun.pod as an example),
so we'll follow Perl core style, here.
This needs to be done for other manpages, at some point...
---
Documentation/lei-q.pod | 58 +++++++++++++++++++++++++++++++----------
1 file changed, 44 insertions(+), 14 deletions(-)
diff --git a/Documentation/lei-q.pod b/Documentation/lei-q.pod
index b938746a..2b9936b8 100644
--- a/Documentation/lei-q.pod
+++ b/Documentation/lei-q.pod
@@ -26,10 +26,14 @@ TODO: mention curl options?
Read search terms from stdin.
-=item -o MFOLDER, --output=MFOLDER, --mfolder=MFOLDER
+=item --output=MFOLDER
+
+=item -o MFOLDER
+
+=item --mfolder=MFOLDER
Warning: this clobbers and overwrites the output destination unless
-L</-a, --augment> is specified.
+L</--augment> is specified.
Destination for results (e.g., C</tmp/results-Maildir>,
C<imaps://user@mail.example.com/INBOX.test>, or
@@ -50,7 +54,9 @@ TODO: Provide description of formats?
Default: C<-> (stdout)
-=item -f FORMAT, --format=FORMAT
+=item --format=FORMAT
+
+=item -f FORMAT
Format of results. This option exists as a convenient way to specify
the format for the default stdout destination. Using a C<format:>
@@ -81,7 +87,9 @@ This option may be given multiple times.
Default: C<:WINCH,:bell> when C<--mua> is specified and C<--output>
doesn't point to stdout, nothing otherwise.
-=item -a, --augment
+=item --augment
+
+=item -a
Augment output destination instead of clobbering it.
@@ -90,7 +98,9 @@ Augment output destination instead of clobbering it.
Do not importing keywords before writing to an existing output
destination.
-=item -t, --threads
+=item --threads
+
+=item -t
Return all messages in the same thread as the actual match(es).
@@ -102,7 +112,9 @@ of the same thread.
TODO: Warning: this flag may become persistent and saved in
lei/store unless an MUA unflags it! (Behavior undecided)
-=item -d STRATEGY, --dedupe=STRATEGY
+=item --dedupe=STRATEGY
+
+=item -d STRATEGY
Strategy for deduplicating messages: C<content>, C<oid>, C<mid>, or
C<none>.
@@ -126,7 +138,9 @@ Limit operations to those requiring network access.
Don't include results from externals.
-=item -I LOCATION, --include=LOCATION
+=item --include=LOCATION
+
+=item -I LOCATION
Include specified external in search. This option may be given
multiple times.
@@ -141,7 +155,9 @@ multiple times.
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 -g, --globoff
+=item --globoff
+
+=item -g
Do not match locations using C<*?> wildcards and C<[]> ranges. This
option applies to C<--include>, C<--exclude>, and C<--only>.
@@ -158,7 +174,11 @@ C<none>.
Default: fcntl,dotlock
-=item -NUMBER, -n NUMBER, --limit=NUMBER
+=item --limit=NUMBER
+
+=item -NUMBER
+
+=item -n NUMBER
Limit the number of matches.
@@ -170,26 +190,36 @@ Shift start of search results.
Default: 0
-=item -r, --reverse
+=item --reverse
+
+=item -r
Reverse the results. Note that this applies before C<--limit>.
-=item -s KEY, --sort=KEY
+=item --sort=KEY
+
+=item -s KEY
Order the results by KEY. Valid keys are C<received>, C<relevance>,
and C<docid>.
Default: C<received>
-=item -v, --verbose
+=item --verbose
+
+=item -v
Provide more feedback on stderr.
-=item -q, --quiet
+=item --quiet
+
+=item -q
Suppress feedback messages.
-=item --torsocks=auto|no|yes, --no-torsocks
+=item --torsocks=auto|no|yes
+
+=item --no-torsocks
Whether to wrap L<git(1)> and L<curl(1)> commands with torsocks.
^ permalink raw reply related [relevance 5%]
Results 1-5 of 5 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2021-04-28 4:51 6% [PATCH 0/3] doc: lei updates around lei-q Eric Wong
2021-04-28 4:51 5% ` [PATCH 2/3] doc: lei q: split =item aliases onto separate lines Eric Wong
2021-04-29 1:39 7% ` Kyle Meyer
2021-04-29 1:57 7% ` Eric Wong
2021-05-17 3:35 6% [PATCH 0/9] doc: lei manpages, round 5 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).