1CTL_CYRUSDB(8) Cyrus IMAP CTL_CYRUSDB(8)
2
3
4
6 ctl_cyrusdb - Cyrus IMAP documentation
7
8 Perform administrative operations directly on Cyrus IMAP databases.
9
11 ctl_cyrusdb [ -C config-file ] -c
12 ctl_cyrusdb [ -C config-file ] -r [ -x ]
13
15 ctl_cyrusdb is used to perform various administrative operations on the
16 Cyrus IMAP databases.
17
18 ctl_cyrusdb reads its configuration options out of the imapd.conf(5)
19 file unless specified otherwise by -C. The configdirectory option in
20 imapd.conf(5) is used to determine the default location of the Cyrus
21 databases.
22
24 -C config-file
25 Use the specified configuration file config-file rather than the
26 default imapd.conf(5).
27
28 -r Recover the database after an application or system failure.
29 Also performs database cleanups like removing mailbox reserva‐
30 tions (and the associated mailbox files).
31
32 All mailbox files are also checked to make sure the file format
33 matches the configured database type in imapd.conf. If not, the
34 file is automatically converted using the same logic as
35 cvt_cyrusdb.
36
37 If the reverseacls option in imapd.conf(5) is enabled, and the
38 RACL entries in the database are an old version or do not exist,
39 they will be generated. Conversely, if RACL entries do exist in
40 the database, but the reverseacls option is disabled, then the
41 entries will be cleaned up.
42
43 -x Used with -r to only recover the database, and prevent any
44 cleanup.
45
46 -c Checkpoint and archive (a copy of) the database.
47
48 Changes to the database which are part of the committed transac‐
49 tions are written to disk.
50
51 The archive is created via a hot backup, and inactive log files
52 are removed.
53
55 ctl_cyrusdb -r
56 Recover databases, performing cleanup. This is commonly used in the
57 START section of cyrus.conf(5).
58
59 ctl_cyrusdb -x -r
60 Recover database only.
61
62 ctl_cyrusdb -c
63 Checkpoint databases. Commonly used in the EVENTS section of
64 cyrus.conf(5).
65
67 /etc/imapd.conf /etc/cyrus.conf
68
70 cyrus.conf(5), imapd.conf(5), master(8)
71
73 The Cyrus Team, Nic Bernstein (Onlight), Jeroen van Meeuwen (Kolab Sys‐
74 tems)
75
77 1993–2022, The Cyrus Team
78
79
80
81
823.6.0 December 12, 2022 CTL_CYRUSDB(8)