* [PATCH 7/9] doc lei: add manpage for convert
2021-05-17 3:35 7% [PATCH 0/9] doc: lei manpages, round 5 Kyle Meyer
@ 2021-05-17 3:35 4% ` Kyle Meyer
0 siblings, 0 replies; 2+ results
From: Kyle Meyer @ 2021-05-17 3:35 UTC (permalink / raw)
To: meta
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<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)
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
--
2.31.1
^ permalink raw reply related [relevance 4%]
* [PATCH 0/9] doc: lei manpages, round 5
@ 2021-05-17 3:35 7% Kyle Meyer
2021-05-17 3:35 4% ` [PATCH 7/9] doc lei: add manpage for convert Kyle Meyer
0 siblings, 1 reply; 2+ results
From: Kyle Meyer @ 2021-05-17 3:35 UTC (permalink / raw)
To: meta
This series updates the lei manpages, continuing from
<20210329031117.28516-1-kyle@kyleam.com>. It covers changes up to the
current tip of master (236831da32b1240d..8cc23ac6f7a38479).
The second patch touches outside of lei manpages as a followup to
e226f18934eb7291 (doc: lei q: split =item aliases onto separate lines,
2021-04-28).
[1/9] doc lei blob: avoid combined description of separate options
[2/9] doc: split option variants into separate items
[3/9] doc lei blob: point to lei-q for shared options
[4/9] doc lei: resort lei-tag entries
[5/9] doc lei q: fix a typo
[6/9] doc lei q: add missing value for --lock
[7/9] doc lei: add manpage for convert
[8/9] doc lei: add manpages for new commands
[9/9] doc lei: update manpages with new options
Documentation/lei-add-external.pod | 12 ++-
Documentation/lei-blob.pod | 62 +++++++--------
.../{lei-import.pod => lei-convert.pod} | 40 ++++++----
Documentation/lei-edit-search.pod | 28 +++++++
Documentation/lei-forget-external.pod | 4 +-
Documentation/lei-forget-search.pod | 28 +++++++
Documentation/lei-import.pod | 20 ++++-
Documentation/lei-init.pod | 4 +-
Documentation/lei-lcat.pod | 79 +++++++++++++++++++
Documentation/lei-ls-external.pod | 8 +-
Documentation/lei-ls-label.pod | 8 +-
...i-ls-external.pod => lei-ls-mail-sync.pod} | 22 +++---
Documentation/lei-ls-search.pod | 65 +++++++++++++++
Documentation/lei-overview.pod | 12 +++
Documentation/lei-p2q.pod | 8 +-
Documentation/lei-q.pod | 16 +++-
Documentation/lei-rediff.pod | 79 +++++++++++++++++++
Documentation/lei-tag.pod | 8 +-
Documentation/lei-up.pod | 48 +++++++++++
Documentation/lei.pod | 18 +++++
Documentation/public-inbox-compact.pod | 6 +-
Documentation/public-inbox-convert.pod | 4 +-
Documentation/public-inbox-daemon.pod | 16 +++-
Documentation/public-inbox-extindex.pod | 4 +-
Documentation/public-inbox-imapd.pod | 4 +-
Documentation/public-inbox-index.pod | 12 ++-
Documentation/public-inbox-init.pod | 20 +++--
Documentation/public-inbox-nntpd.pod | 4 +-
Documentation/public-inbox-xcpdb.pod | 14 +++-
Documentation/txt2pre | 11 ++-
MANIFEST | 8 ++
Makefile.PL | 8 +-
32 files changed, 580 insertions(+), 100 deletions(-)
copy Documentation/{lei-import.pod => lei-convert.pod} (54%)
create mode 100644 Documentation/lei-edit-search.pod
create mode 100644 Documentation/lei-forget-search.pod
create mode 100644 Documentation/lei-lcat.pod
copy Documentation/{lei-ls-external.pod => lei-ls-mail-sync.pod} (64%)
create mode 100644 Documentation/lei-ls-search.pod
create mode 100644 Documentation/lei-rediff.pod
create mode 100644 Documentation/lei-up.pod
base-commit: 8cc23ac6f7a3847977ec57c2a3e9e391fdb94da6
--
2.31.1
^ permalink raw reply [relevance 7%]
Results 1-2 of 2 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2021-05-17 3:35 7% [PATCH 0/9] doc: lei manpages, round 5 Kyle Meyer
2021-05-17 3:35 4% ` [PATCH 7/9] doc lei: add manpage for convert Kyle Meyer
Code repositories for project(s) associated with this public inbox
https://80x24.org/public-inbox.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).