about summary refs log tree commit homepage
path: root/Documentation
diff options
authorEric Wong <e@80x24.org>2021-10-28 11:14:56 +0000
committerEric Wong <e@80x24.org>2021-10-28 19:17:09 +0000
commitfc70bf064fd13def9a919b7cc264a3a1dcff6e79 (patch)
treefb71a6e64a19804b2df4097191e3ff57dfcbbd89 /Documentation
parentfa2df786060c55578c15295f01d47827f9246b34 (diff)
Note that "-o OUTPUT" is required in the synopsis.

Leave out "eml:" for now since it doesn't work as an output and
I doubt anybody would use it as a prefix, and it's not really

--no-import-remote is also not accepted by convert, since it
doesn't touch lei/store at all.
Diffstat (limited to 'Documentation')
1 files changed, 9 insertions, 12 deletions
diff --git a/Documentation/lei-convert.pod b/Documentation/lei-convert.pod
index 750ba54f..c113db18 100644
--- a/Documentation/lei-convert.pod
+++ b/Documentation/lei-convert.pod
@@ -1,23 +1,23 @@
 =head1 NAME
-lei-convert - one-time conversion from URL or filesystem to another format
+lei-convert - one-time conversion from one mail format to another
 =head1 SYNOPSIS
-lei convert [OPTIONS] LOCATION
-lei convert [OPTIONS] (--stdin|-)
+lei convert -o OUTPUT [OPTIONS] (--stdin|-)
 Convert messages to another format.  C<LOCATION> is a source of
-messages: a directory (Maildir), a file, or a URL (C<imap://>,
-C<imaps://>, C<nntp://>, or C<nntps://>).  URLs requiring
-authentication use L<git-credential(1)> to
+messages: a directory (Maildir), a file (various mbox), or a URL
+(C<imap://>, C<imaps://>, C<nntp://>, or C<nntps://>).  URLs
+requiring authentication use L<git-credential(1)> to
 fill in the username and password.
 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>,
+prefix specifying one of the following formats: C<mboxrd>,
 C<mboxcl2>, C<mboxcl>, or C<mboxo>.
 =head1 OPTIONS
@@ -44,8 +44,6 @@ L<lei-q(1)>.
 =item --no-kw
-=item --no-import-remote
 =item --torsocks=auto|no|yes
 =item --no-torsocks
@@ -63,11 +61,10 @@ and L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta
-Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
+Copyright all contributors L<mailto:meta@public-inbox.org>
 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 =head1 SEE ALSO