diff options
author | Eric Wong <e@80x24.org> | 2021-04-28 04:51:07 +0000 |
---|---|---|
committer | Eric Wong <e@80x24.org> | 2021-04-28 19:30:48 +0000 |
commit | 83df78de12bf04ffe5906d520399dc891d167f73 (patch) | |
tree | cbdf93483a59bcd6d49f9950605d6a9026544e7f /Documentation | |
parent | e226f18934eb7291ee443a1c57719ab877437245 (diff) | |
download | public-inbox-83df78de12bf04ffe5906d520399dc891d167f73.tar.gz |
I guess --format makes sense for stdout, after all; and I'm enjoying "-f text" quite a bit, so far.
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/lei-q.pod | 26 |
1 files 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 |