From 9f6ebba618b3cb02938e3ab3c4bd314c9d07e5d1 Mon Sep 17 00:00:00 2001 From: Kyle Meyer Date: Sun, 16 May 2021 23:35:26 -0400 Subject: doc lei: add manpage for convert Link: https://public-inbox.org/meta/20210429015738.GA30172@dcvr/ --- Documentation/lei-convert.pod | 73 +++++++++++++++++++++++++++++++++++++++++++ Documentation/lei.pod | 2 ++ Documentation/txt2pre | 1 + MANIFEST | 1 + Makefile.PL | 6 ++-- 5 files changed, 80 insertions(+), 3 deletions(-) create mode 100644 Documentation/lei-convert.pod 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 is a source of +messages: a directory (Maildir), a file, or a URL (C, +C, C, or C). URLs requiring +authentication must use L and/or L to +fill in the username and password. + +For a regular file, the location must have a CformatE:> +prefix specifying one of the following formats: C, C, +C, C, or C. + +=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 is preferred. + +=back + +The following options are also supported and are described in +L. + +=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 + +The mail archives are hosted at L +and L + +=head1 COPYRIGHT + +Copyright 2021 all contributors L + +License: AGPL-3.0+ L + + +=head1 SEE ALSO + +L 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 +=item * L + =item * L =item * L 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) diff --git a/MANIFEST b/MANIFEST index a6d94c77..29e62880 100644 --- a/MANIFEST +++ b/MANIFEST @@ -24,6 +24,7 @@ Documentation/include.mk Documentation/lei-add-external.pod Documentation/lei-blob.pod Documentation/lei-config.pod +Documentation/lei-convert.pod Documentation/lei-daemon-kill.pod Documentation/lei-daemon-pid.pod Documentation/lei-forget-external.pod diff --git a/Makefile.PL b/Makefile.PL index b06b6ab8..d149a164 100644 --- a/Makefile.PL +++ b/Makefile.PL @@ -45,9 +45,9 @@ $v->{-m1} = [ map { } } @EXE_FILES, qw( - lei-add-external lei-blob lei-config lei-daemon-kill lei-daemon-pid - lei-forget-external lei-import lei-init lei-ls-external lei-ls-label - lei-p2q lei-q lei-tag)]; + lei-add-external lei-blob lei-config lei-convert lei-daemon-kill + lei-daemon-pid lei-forget-external lei-import lei-init lei-ls-external + lei-ls-label lei-p2q lei-q lei-tag)]; $v->{-m5} = [ qw(public-inbox-config public-inbox-v1-format public-inbox-v2-format public-inbox-extindex-format lei-mail-formats lei-store-format -- cgit v1.2.3-24-ge0c7