From: Eric Wong <e@80x24.org> 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 [thread overview] Message-ID: <20210924125109.23456-5-e@80x24.org> (raw) In-Reply-To: <20210924125109.23456-1-e@80x24.org> 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=[<remote|local>] + +lei export-kw MFOLDER [MFOLDER...] + +=head1 DESCRIPTION + +C<lei export-kw> propagates keywords (e.g. C<seen>, C<answered>, +C<flagged>, 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<mailto:meta@public-inbox.org> + +The mail archives are hosted at L<https://public-inbox.org/meta/> and +L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/> + +=head1 COPYRIGHT + +Copyright 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-refresh-mail-sync(1)>, L<lei-tag(1)> 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[=<remote|local>] + +lei refresh-mail-sync MFOLDER [MFOLDER...] + +=head1 DESCRIPTION + +C<lei refresh-mail-sync> is intended to to keep old messages +indexed with L<lei-index(1)> 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<lei-export-kw(1)> 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<mailto:meta@public-inbox.org> + +The mail archives are hosted at L<https://public-inbox.org/meta/> and +L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/> + +=head1 COPYRIGHT + +Copyright 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-index(1)>, L<lei-export-kw(1)> 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
prev parent reply other threads:[~2021-09-24 12:51 UTC|newest] Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top 2021-09-24 12:51 [PATCH 0/4] doc: lei: some manpage updaets Eric Wong 2021-09-24 12:51 ` [PATCH 1/4] doc: lei blob+rediff+p2q: add notes about git directory Eric Wong 2021-09-24 12:51 ` [PATCH 2/4] doc: lei-overview: implicit stdin, correct Inline::C notes Eric Wong 2021-09-24 12:51 ` [PATCH 3/4] doc: lei-index: remove --stdin, reword -F Eric Wong 2021-09-24 12:51 ` Eric Wong [this message]
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style List information: https://public-inbox.org/README * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20210924125109.23456-5-e@80x24.org \ --to=e@80x24.org \ --cc=meta@public-inbox.org \ --subject='Re: [PATCH 4/4] doc: lei: manpages for export-kw and refresh-mail-sync' \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
Code repositories for project(s) associated with this 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).