* [PATCH 0/3] doc: lei updates around lei-q
@ 2021-04-28 4:51 7% Eric Wong
2021-04-28 4:51 6% ` [PATCH 3/3] doc: lei q: split --output and --format, note "text" Eric Wong
0 siblings, 1 reply; 2+ 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 7%]
* [PATCH 3/3] doc: lei q: split --output and --format, note "text"
2021-04-28 4:51 7% [PATCH 0/3] doc: lei updates around lei-q Eric Wong
@ 2021-04-28 4:51 6% ` Eric Wong
0 siblings, 0 replies; 2+ results
From: Eric Wong @ 2021-04-28 4:51 UTC (permalink / raw)
To: meta
I guess --format makes sense for stdout, after all;
and I'm enjoying "-f text" quite a bit, so far.
---
Documentation/lei-q.pod | 26 +++++++++++++++-----------
1 file changed, 15 insertions(+), 11 deletions(-)
diff --git a/Documentation/lei-q.pod b/Documentation/lei-q.pod
index 2b9936b8..bf7a5f70 100644
--- a/Documentation/lei-q.pod
+++ b/Documentation/lei-q.pod
@@ -42,15 +42,11 @@ C<imap://> or C<imaps://>. URLs requiring
authentication must use L<netrc(5)> and/or L<git-credential(1)> to
fill in the username and password.
-The prefix can instead specify the format of the output: C<maildir>,
-C<mboxrd>, C<mboxcl2>, C<mboxcl>, C<mboxo>, C<json>, C<jsonl>, or
-C<concatjson>. When a format isn't specified, it's chosen based on
-the destination. C<json> is used for the default destination
-(stdout), and C<maildir> is used for an existing directory or
-non-existing path.
+A prefix can specify the format of the output: C<maildir>,
+C<mboxrd>, C<mboxcl2>, C<mboxcl>, C<mboxo>. For a description of
+mail formats, see L<lei-mail-formats(5)>.
-=for comment
-TODO: Provide description of formats?
+C<maildir> is the default for an existing directory or non-existing path.
Default: C<-> (stdout)
@@ -58,9 +54,17 @@ Default: C<-> (stdout)
=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:>
-prefix with the C<--output> destination is preferred otherwise.
+Format of results to stdout. This option exists as a convenient
+way to specify the format for the default stdout destination.
+C<text>, C<json>, C<jsonl>, or C<concatjson> are all supported,
+as are the various mbox variants described in L</--output>.
+
+When a format isn't specified, it's chosen based on the
+L</--output> destination or prefix. C<json> is used for the
+default destination (stdout).
+
+Using a C<format:> prefix with the C<--output> destination is
+preferred when not writing to stdout.
=item --pretty
^ permalink raw reply related [relevance 6%]
Results 1-2 of 2 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2021-04-28 4:51 7% [PATCH 0/3] doc: lei updates around lei-q Eric Wong
2021-04-28 4:51 6% ` [PATCH 3/3] doc: lei q: split --output and --format, note "text" 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).