From 028c85c52590daa7461496e4833479bf08c9454a Mon Sep 17 00:00:00 2001
From: Erwin Hoffmann <feh@fehcom.de>
Date: Thu, 21 Sep 2023 17:41:34 +0200
Subject: added man pages

---
 man/bincimap-updatecache.7 | 57 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100644 man/bincimap-updatecache.7

(limited to 'man/bincimap-updatecache.7')

diff --git a/man/bincimap-updatecache.7 b/man/bincimap-updatecache.7
new file mode 100644
index 0000000..66f71b2
--- /dev/null
+++ b/man/bincimap-updatecache.7
@@ -0,0 +1,57 @@
+.TH bincimap-udatecache 7
+.SH "NAME"
+bincimap-updatecache 
+.SH "SYNOPSIS"
+.B bincimap-updatecache <maildir>
+.SH "DESCRIPTION"
+.B bincimap-updatecache
+reads the messages available at
+.I <maildir> 
+and re-generates the
+.I binc-cache
+file in this directory.
+.SH "INVOCATION"
+.B bincimap-updatecache 
+is called by the owner of the
+.IR <maildepot> .
+Given the Maildir++ format, a
+.I <maildir> 
+is either
+.I Maildir
+or one of the sub-directories indicated via a dot:
+.IR .submaildir .
+Instead of nested subdirectories, 
+.I .submaildir 
+ist just the first level <maildir>. Nesting is
+realized by concatination of <maildir> names with a dot.
+
+.B bincimap-updatecache
+generates the file
+.I bincimap-cache
+for only this sub-directory given by its path name:
+
+.EX
+  \fBbincimap-updatecache\fR Maildir/.maildirname
+.EE
+
+.B bincimap-updatecache
+considers by default the
+.I Maildir++
+format, including the
+.IR new , 
+.IR cur , 
+and
+.I tmp
+sub-directories.
+In case the 
+.I <maildepot>
+is given as
+.I IMAPdir 
+.BR bincimap-updatecache ,
+requires the setting of
+.I DEPOT=IMAPdir 
+as exported environment variable.
+.SH "COPYRIGHT"
+Copyright (C) 2023 Erwin Hoffmann
+.SH "SEE ALSO"
+bincimap(1), bincimap-up(1), bincimapd(1)
-- 
cgit v1.2.3