diff options
author | Kyle Meyer <kyle@kyleam.com> | 2021-02-22 22:45:52 -0500 |
---|---|---|
committer | Eric Wong <e@80x24.org> | 2021-02-23 01:51:46 -0400 |
commit | 56b3493c79087979f10f5a3cae7deedaf4ec9fa3 (patch) | |
tree | 9d21bc5dc44497bf7baa2b97580071de654d327d /Documentation | |
parent | c1ad789a90c274f9912d53bb1c7f1a3cc07cb233 (diff) | |
download | public-inbox-56b3493c79087979f10f5a3cae7deedaf4ec9fa3.tar.gz |
The --format argument is redundant and may be dropped entirely. Update the lei manpages to prefer the format prefix. cf. https://public-inbox.org/meta/20210217044032.GA17934@dcvr/
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/lei-import.pod | 10 | ||||
-rw-r--r-- | Documentation/lei-overview.pod | 4 | ||||
-rw-r--r-- | Documentation/lei-q.pod | 20 |
3 files changed, 22 insertions, 12 deletions
diff --git a/Documentation/lei-import.pod b/Documentation/lei-import.pod index 14ca2d45..2051e6bc 100644 --- a/Documentation/lei-import.pod +++ b/Documentation/lei-import.pod @@ -11,8 +11,10 @@ lei import [OPTIONS] --stdin =head1 DESCRIPTION Import messages into the local storage of L<lei(1)>. C<LOCATION> is a -source of messages: a directory (Maildir) or a file (whose format is -specified via C<--format>). +source of messages: a directory (Maildir) or a file. For a regular +file, the location must have a C<E<lt>formatE<gt>:> prefix specifying +one of the following formats: C<eml>, C<mboxrd>, C<mboxcl2>, +C<mboxcl>, or C<mboxo>. TODO: Update when URL support is added. @@ -22,8 +24,8 @@ TODO: Update when URL support is added. =item -f MAIL_FORMAT, --format=MAIL_FORMAT -Message input format: C<eml>, C<mboxrd>, C<mboxcl2>, C<mboxcl>, -C<mboxo>. +Message input format. Unless messages are given on C<stdin>, using a +format prefix with C<LOCATION> is preferred. =item --stdin diff --git a/Documentation/lei-overview.pod b/Documentation/lei-overview.pod index 840d011b..62b62280 100644 --- a/Documentation/lei-overview.pod +++ b/Documentation/lei-overview.pod @@ -16,7 +16,7 @@ L<public-inbox-v2-format(5)>. =over -=item $ lei import --format=mboxrd t.mbox +=item $ lei import mboxrd:t.mbox Import the messages from an mbox into the local storage. @@ -64,7 +64,7 @@ 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 -f mboxcl2 --mua=mutt s:lei s:skeleton +=item $ lei q -t -o mboxcl2:t.mbox --mua=mutt s:lei s:skeleton Write mboxcl2-formatted results to t.mbox and enter mutt to view the file by invoking C<mutt -f %f>. diff --git a/Documentation/lei-q.pod b/Documentation/lei-q.pod index c8df6fc7..75fdc613 100644 --- a/Documentation/lei-q.pod +++ b/Documentation/lei-q.pod @@ -26,17 +26,25 @@ Read search terms from stdin. =item -o MFOLDER, --output=MFOLDER, --mfolder=MFOLDER -Destination for results (e.g., C<path/to/Maildir> or - for stdout). +Destination for results (e.g., C<path/to/Maildir> or +C<mboxcl2:path/to/mbox>). The format can be specified by adding a +C<E<lt>formatE<gt>:> prefix with any of these values: C<maildir>, +C<mboxrd>, C<mboxcl2>, C<mboxcl>, C<mboxo>, C<json>, C<jsonl>, or +C<concatjson>. + +TODO: Provide description of formats? + +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. Default: - =item -f FORMAT, --format=FORMAT -Format of results: C<maildir>, C<mboxrd>, C<mboxcl2>, C<mboxcl>, -C<mboxo>, C<json>, C<jsonl>, or C<concatjson>. The default format -used depends on C<--output>. - -TODO: Provide description of formats? +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. =item --pretty |