Documentation/lei-convert.pod

   1 =head1 NAME
   2
   3 lei-convert - one-time conversion from one mail format to another
   4
   5 =head1 SYNOPSIS
   6
   7 lei convert -o OUTPUT [OPTIONS] LOCATION
   8
   9 lei convert -o OUTPUT [OPTIONS] (--stdin|-)
  10
  11 =head1 DESCRIPTION
  12
  13 Convert messages to another format.  C<LOCATION> is a source of
  14 messages: a directory (Maildir), a file (various mbox), or a URL
  15 (C<imap://>, C<imaps://>, C<nntp://>, or C<nntps://>).  URLs
  16 requiring authentication use L<git-credential(1)> to
  17 fill in the username and password.
  18
  19 For a regular file, the location must have a C<E<lt>formatE<gt>:>
  20 prefix specifying one of the following formats: C<mboxrd>,
  21 C<mboxcl2>, C<mboxcl>, or C<mboxo>.
  22
  23 =head1 OPTIONS
  24
  25 =over
  26
  27 =item -F MAIL_FORMAT
  28
  29 =item --in-format=MAIL_FORMAT
  30
  31 Message input format.  Unless messages are given on stdin, using a
  32 format prefix with C<LOCATION> is preferred.
  33
  34 =back
  35
  36 The following options are also supported and are described in
  37 L<lei-q(1)>.
  38
  39 =over
  40
  41 =item -o MFOLDER, --output=MFOLDER
  42
  43 =item --lock METHOD
  44
  45 =item --no-kw
  46
  47 =item --torsocks=auto|no|yes
  48
  49 =item --no-torsocks
  50
  51 =item --proxy=PROTOCOL://HOST[:PORT]
  52
  53 =back
  54
  55 =head1 CONTACT
  56
  57 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  58
  59 The mail archives are hosted at L<https://public-inbox.org/meta/>
  60 and L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
  61
  62 =head1 COPYRIGHT
  63
  64 Copyright all contributors L<mailto:meta@public-inbox.org>
  65
  66 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  67
  68 =head1 SEE ALSO
  69
  70 L<lei-mail-formats(5)>