diff options
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/lei-convert.pod | 73 | ||||
-rw-r--r-- | Documentation/lei.pod | 2 | ||||
-rwxr-xr-x | Documentation/txt2pre | 1 |
3 files changed, 76 insertions, 0 deletions
diff --git a/Documentation/lei-convert.pod b/Documentation/lei-convert.pod new file mode 100644 index 00000000..e8a71393 --- /dev/null +++ b/Documentation/lei-convert.pod @@ -0,0 +1,73 @@ +=head1 NAME + +lei-convert - one-time conversion from URL or filesystem to another format + +=head1 SYNOPSIS + +lei convert [OPTIONS] LOCATION + +lei convert [OPTIONS] (--stdin|-) + +=head1 DESCRIPTION + +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 must use L<netrc(5)> and/or 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>, +C<mboxcl2>, C<mboxcl>, or C<mboxo>. + +=head1 OPTIONS + +=over + +=item -F MAIL_FORMAT + +=item --in-format=MAIL_FORMAT + +Message input format. Unless messages are given on stdin, using a +format prefix with C<LOCATION> is preferred. + +=back + +The following options are also supported and are described in +L<lei-q(1)>. + +=over + +=item -o MFOLDER, --output=MFOLDER + +=item --lock METHOD + +=item --no-kw + +=item --no-import-remote + +=item --torsocks=auto|no|yes + +=item --no-torsocks + +=item --proxy=PROTO://HOST[:PORT] + +=back + +=head1 CONTACT + +Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org> + +The mail archives are hosted at L<https://public-inbox.org/meta/> +and L<http://hjrcffqmbrq6wope.onion/meta/> + +=head1 COPYRIGHT + +Copyright 2021 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 + +L<lei-add-external(1)> diff --git a/Documentation/lei.pod b/Documentation/lei.pod index 58646577..78e1fb1e 100644 --- a/Documentation/lei.pod +++ b/Documentation/lei.pod @@ -84,6 +84,8 @@ Other subcommands include =item * L<lei-config(1)> +=item * L<lei-convert(1)> + =item * L<lei-daemon-kill(1)> =item * L<lei-daemon-pid(1)> diff --git a/Documentation/txt2pre b/Documentation/txt2pre index 25d81cf9..201566ee 100755 --- a/Documentation/txt2pre +++ b/Documentation/txt2pre @@ -14,6 +14,7 @@ for (qw[lei(1) lei-add-external(1) lei-blob(1) lei-config(1) + lei-convert(1) lei-daemon-kill(1) lei-daemon-pid(1) lei-forget-external(1) |