doc lei: add manpage for convert

Link: https://public-inbox.org/meta/20210429015738.GA30172@dcvr/

diff --git a/Documentation/lei-convert.pod b/Documentation/lei-convert.pod
new file mode 100644 (file)
index 0000000..e8a7139
--- /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 58646577e4fb43da3272d2ddf2af465f0f308c54..78e1fb1e6f9c8a98de1a6cafae5a1f8cd4168ac7 100644 (file)
--- 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 25d81cf9585565f5f962e68a02a2b124eef671fc..201566ee5242811a3f5998f5bcf839f1eb65896a 100755 (executable)
--- 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 a6d94c774cdcac530c9f9bcceb139b3cd96c20b4..29e62880a9de6514bff26ce92f0fac980784cbec 100644 (file)
--- 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 b06b6ab892d3cf1befff24143817c7a3edd23772..d149a1647b24dee4e771066f022b71188f6d70fc 100644 (file)
--- 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