summaryrefslogtreecommitdiff
path: root/man/bincimap-updatecache.7
blob: 66f71b2d001b431f98e1c591e2161016c8c9704d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
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)