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 -x Used with -r to only recover the database, and prevent any
38 cleanup.
39
40 -c Checkpoint and archive (a copy of) the database.
41
42 Changes to the database which are part of the committed transac‐
43 tions are written to disk.
44
45 The archive is created via a hot backup, and inactive log files
46 are removed.
47
49 ctl_cyrusdb -r
50 Recover databases, performing cleanup. This is commonly used in the
51 START section of cyrus.conf(5).
52
53 ctl_cyrusdb -x -r
54 Recover database only.
55
56 ctl_cyrusdb -c
57 Checkpoint databases. Commonly used in the EVENTS section of
58 cyrus.conf(5).
59
61 /etc/imapd.conf /etc/cyrus.conf
62
64 cyrus.conf(5), imapd.conf(5), master(8)
65
67 The Cyrus Team, Nic Bernstein (Onlight), Jeroen van Meeuwen (Kolab Sys‐
68 tems)
69
71 1993-2017, The Cyrus Team
72
73
74
75
763.0.12 November 15, 2019 CTL_CYRUSDB(8)