about summary refs log tree commit homepage
path: root/Documentation/lei-import.pod
diff options
context:
space:
mode:
authorKyle Meyer <kyle@kyleam.com>2021-02-22 22:45:52 -0500
committerEric Wong <e@80x24.org>2021-02-23 01:51:46 -0400
commit56b3493c79087979f10f5a3cae7deedaf4ec9fa3 (patch)
tree9d21bc5dc44497bf7baa2b97580071de654d327d /Documentation/lei-import.pod
parentc1ad789a90c274f9912d53bb1c7f1a3cc07cb233 (diff)
downloadpublic-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/lei-import.pod')
-rw-r--r--Documentation/lei-import.pod10
1 files changed, 6 insertions, 4 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