From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: X-Spam-Status: No, score=-4.0 required=3.0 tests=ALL_TRUSTED,BAYES_00 shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from localhost (dcvr.yhbt.net [127.0.0.1]) by dcvr.yhbt.net (Postfix) with ESMTP id C6AEE1FB06 for ; Fri, 24 Sep 2021 12:51:09 +0000 (UTC) From: Eric Wong To: meta@public-inbox.org Subject: [PATCH 4/4] doc: lei: manpages for export-kw and refresh-mail-sync Date: Fri, 24 Sep 2021 12:51:09 +0000 Message-Id: <20210924125109.23456-5-e@80x24.org> In-Reply-To: <20210924125109.23456-1-e@80x24.org> References: <20210924125109.23456-1-e@80x24.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit List-Id: Something is better than nothing. --- Documentation/lei-export-kw.pod | 52 ++++++++++++++++++++++ Documentation/lei-refresh-mail-sync.pod | 57 +++++++++++++++++++++++++ MANIFEST | 2 + Makefile.PL | 5 ++- 4 files changed, 115 insertions(+), 1 deletion(-) create mode 100644 Documentation/lei-export-kw.pod create mode 100644 Documentation/lei-refresh-mail-sync.pod diff --git a/Documentation/lei-export-kw.pod b/Documentation/lei-export-kw.pod new file mode 100644 index 000000000000..cf482ca0d307 --- /dev/null +++ b/Documentation/lei-export-kw.pod @@ -0,0 +1,52 @@ +=head1 NAME + +lei-export-kw - export keywords (flags) to Maildir and IMAP folders + +=head1 SYNOPSIS + +lei export-kw --all=[] + +lei export-kw MFOLDER [MFOLDER...] + +=head1 DESCRIPTION + +C propagates keywords (e.g. C, C, +C, etc.) from lei/store to IMAP folders and/or Maildirs. + +It does not delete, write, nor modify messages themselves; +it only sets metadata on Maildirs and IMAP folders. + +=head1 OPTIONS + +=over + +=item --all + +Export to all local Maildirs and remote IMAP folders + +=item --all=local + +Export all local Maildirs + +=item --all=remote + +Export all remote IMAP folders + +=back + +=head1 CONTACT + +Feedback welcome via plain-text mail to L + +The mail archives are hosted at L and +L + +=head1 COPYRIGHT + +Copyright all contributors L + +License: AGPL-3.0+ L + +=head1 SEE ALSO + +L, L diff --git a/Documentation/lei-refresh-mail-sync.pod b/Documentation/lei-refresh-mail-sync.pod new file mode 100644 index 000000000000..aefd516fad93 --- /dev/null +++ b/Documentation/lei-refresh-mail-sync.pod @@ -0,0 +1,57 @@ +=head1 NAME + +lei-refresh-mail-sync - refresh sync info with Maildir, IMAP + +=head1 SYNOPSIS + +lei refresh-mail-sync --all[=] + +lei refresh-mail-sync MFOLDER [MFOLDER...] + +=head1 DESCRIPTION + +C is intended to to keep old messages +indexed with L retrievable if Maildir flags change +a filename. It will prune invalid entries for messages which no +longer exist in a Maildir. + +It is also useful for ensuring L can propagate +keyword (flag) changes to Maildirs and IMAP folders. + +It only needs read-only access to Maildirs and IMAP folders +and will not attempt to write to them at all. + +=head1 OPTIONS + +=over + +=item --all + +Refresh all local Maildirs and remote IMAP folders + +=item --all=local + +Refresh all local Maildirs + +=item --all=remote + +Refresh all remote IMAP folders + +=back + +=head1 CONTACT + +Feedback welcome via plain-text mail to L + +The mail archives are hosted at L and +L + +=head1 COPYRIGHT + +Copyright all contributors L + +License: AGPL-3.0+ L + +=head1 SEE ALSO + +L, L diff --git a/MANIFEST b/MANIFEST index 8c2e964b3dce..3595195a6996 100644 --- a/MANIFEST +++ b/MANIFEST @@ -28,6 +28,7 @@ Documentation/lei-convert.pod Documentation/lei-daemon-kill.pod Documentation/lei-daemon-pid.pod Documentation/lei-edit-search.pod +Documentation/lei-export-kw.pod Documentation/lei-forget-external.pod Documentation/lei-forget-search.pod Documentation/lei-import.pod @@ -43,6 +44,7 @@ Documentation/lei-overview.pod Documentation/lei-p2q.pod Documentation/lei-q.pod Documentation/lei-rediff.pod +Documentation/lei-refresh-mail-sync.pod Documentation/lei-rm.pod Documentation/lei-security.pod Documentation/lei-store-format.pod diff --git a/Makefile.PL b/Makefile.PL index f56445ae422d..00a558d12472 100644 --- a/Makefile.PL +++ b/Makefile.PL @@ -46,9 +46,12 @@ $v->{-m1} = [ map { } @EXE_FILES, qw( lei-add-external lei-blob lei-config lei-convert lei-edit-search + lei-export-kw lei-daemon-kill lei-daemon-pid lei-forget-external lei-forget-search lei-import lei-index lei-init lei-lcat lei-ls-external lei-ls-label - lei-ls-mail-sync lei-ls-search lei-p2q lei-q lei-rediff lei-rm lei-tag + lei-ls-mail-sync lei-ls-search lei-p2q lei-q lei-rediff + lei-refresh-mail-sync + lei-rm lei-tag lei-up)]; $v->{-m5} = [ qw(public-inbox-config public-inbox-v1-format public-inbox-v2-format public-inbox-extindex-format