1CTL_CYRUSDB(8)                    Cyrus IMAP                    CTL_CYRUSDB(8)
2
3
4

NAME

6       ctl_cyrusdb - Cyrus IMAP documentation
7
8       Perform administrative operations directly on Cyrus IMAP databases.
9

SYNOPSIS

11          ctl_cyrusdb [ -C config-file ] -c
12          ctl_cyrusdb [ -C config-file ] -r [ -x ]
13

DESCRIPTION

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

OPTIONS

24       -C config-file
25              Use the specified configuration file config-file rather than the
26              default imapd.conf(5).
27
28       -r, --recover
29              Recover the database after an  application  or  system  failure.
30              Also  performs  database cleanups like removing mailbox reserva‐
31              tions (and the associated mailbox files).
32
33              All mailbox files are also checked to make sure the file  format
34              matches the configured database type in imapd.conf.  If not, the
35              file  is  automatically  converted  using  the  same  logic   as
36              cvt_cyrusdb.
37
38              If  the  reverseacls option in imapd.conf(5) is enabled, and the
39              RACL entries in the database are an old version or do not exist,
40              they will be generated.  Conversely, if RACL entries do exist in
41              the database, but the reverseacls option is disabled,  then  the
42              entries will be cleaned up.
43
44       -x, --no-cleanup
45              Used  with  -r  to  only  recover  the database, and prevent any
46              cleanup.
47
48       -c, --checkpoint
49              Checkpoint and archive (a copy of) the database.
50
51              Changes to the database which are part of the committed transac‐
52              tions are written to disk.
53
54              The  archive is created via a hot backup, and inactive log files
55              are removed.
56

EXAMPLES

58          ctl_cyrusdb -r
59          Recover databases, performing cleanup.  This is commonly used in the
60          START section of cyrus.conf(5).
61
62          ctl_cyrusdb -x -r
63          Recover database only.
64
65          ctl_cyrusdb -c
66          Checkpoint  databases.   Commonly  used  in  the  EVENTS  section of
67          cyrus.conf(5).
68

FILES

70       /etc/imapd.conf /etc/cyrus.conf
71

SEE ALSO

73       cyrus.conf(5), imapd.conf(5), master(8)
74

AUTHOR

76       The Cyrus Team, Nic Bernstein (Onlight), Jeroen van Meeuwen (Kolab Sys‐
77       tems)
78

80       1993–2023, The Cyrus Team
81
82
83
84
853.8.1                            Sep 11, 2023                   CTL_CYRUSDB(8)
Impressum