---
name: "cyrus-ctl_cyrusdb"
section: "8"
platform: "linux"
package: "cyrus-common"
version: "3.10.2-1+deb13u2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/cyrus-ctl_cyrusdb"
---

# cyrus-ctl\_cyrusdb(8)

Cyrus IMAP documentation Perform administrative operations directly on Cyrus IMAP databases.

## NAME

ctl\_cyrusdb - Cyrus IMAP documentation

Perform administrative operations directly on Cyrus IMAP databases.

## SYNOPSIS

```
ctl_cyrusdb [ -C config-file ] -c
ctl_cyrusdb [ -C config-file ] -r [ -x ]
```

## DESCRIPTION

**ctl\_cyrusdb is used to perform various administrative operations on** **the Cyrus IMAP databases.**

**ctl\_cyrusdb reads its configuration options out of the** *[imapd.conf(5)](/imapd.conf/5.md)* **file unless specified otherwise by -C.** **The** *configdirectory* **option in** *[imapd.conf(5)](/imapd.conf/5.md)* **is used to determine the default location of the Cyrus databases.**

## OPTIONS

- **-C config-file**

  **Use the specified configuration file** *config-file* **rather than the default** *[imapd.conf(5)](/imapd.conf/5.md)***.**

- **-r, --recover**

  **Recover the database after an application or system failure. Also** **performs database cleanups like removing mailbox reservations (and** **the associated mailbox files).**

  **All mailbox files are also checked to make sure the file format** **matches the configured database type in imapd.conf.  If not, the** **file is automatically converted using the same logic as cvt\_cyrusdb.**

  **If the reverseacls option in** *[imapd.conf(5)](/imapd.conf/5.md)* **is enabled,** **and the RACL entries in the database are an old version or do not** **exist, they will be generated.  Conversely, if RACL entries do exist** **in the database, but the reverseacls option is disabled, then the** **entries will be cleaned up.**

- **-x, --no-cleanup**

  **Used with -r to only recover the database, and prevent any** **cleanup.**

- **-c, --checkpoint**

  **Checkpoint and archive (a copy of) the database.**

  **Changes to the database which are part of the committed transactions** **are written to disk.**

  **The archive is created via a** *hot* **backup, and inactive log files** **are removed.**

## EXAMPLES

```
ctl_cyrusdb -r
```

**Recover databases, performing cleanup.  This is commonly used in** **the START section of** *[cyrus.conf(5)](/cyrus.conf/5.md)***.**

```
ctl_cyrusdb -x -r
```

**Recover database only.**

```
ctl_cyrusdb -c
```

**Checkpoint databases.  Commonly used in the EVENTS section of** *[cyrus.conf(5)](/cyrus.conf/5.md)***.**

## FILES

**/etc/imapd.conf** **/etc/cyrus.conf**

## SEE ALSO

*[cyrus.conf(5)](/cyrus.conf/5.md)***,** *[imapd.conf(5)](/imapd.conf/5.md)***,** *[master(8)](/master/8.md)*

## AUTHOR

**The Cyrus Team, Nic Bernstein (Onlight), Jeroen van Meeuwen (Kolab Systems)**

## COPYRIGHT

**1993–2025, The Cyrus Team**