---
name: "cyrus-chk_cyrus"
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-chk_cyrus"
---

# cyrus-chk\_cyrus(8)

Cyrus IMAP documentation Perform a consistency check of the Cyrus IMAP mail spool.

## NAME

chk\_cyrus - Cyrus IMAP documentation

Perform a consistency check of the Cyrus IMAP mail spool.

## SYNOPSIS

```
chk_cyrus [ -C config-file ] [ -P partition | -M mailbox ]
```

## DESCRIPTION

**chk\_cyrus** *is used to perform a consistency check on the cyrus* *datastore, and output a list of files/directories that are expected to* *exist, but do not.  Status messages are output to stderr, the list of* *files/directories is output to stdout.  This list can be passed to a* *backup program to aid a partial restoration, for instance.*

**chk\_cyrus** *reads its configuration options out of the [imapd.conf(5)](/imapd.conf/5.md) file unless specified otherwise by* **-C***.*

## OPTIONS

- **-C config-file**

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

- **-P partition, --partition=partition**

  *Limit to partition partition.  May not be specified with* **-M***.*

- **-M mailbox, --mailbox=mailbox**

  *Only check mailbox mailbox.  May not be specified with* **-P***.*

  **IMPORTANT:**

  *The mailbox must be specified in the internal format, so rather* *than specifying* **user/john/Trash@example.org***, you will want* *to specify* **example.org!user.john.Trash***.*

## EXAMPLES

```
chk_cyrus -P default
```

*Perform consistency checks on default partition.*

```
chk_cyrus -C /usr/local/etc/imapd-slot1.conf -P default
```

*Perform consistency checks on default partition using specified* *configuration file.*

```
chk_cyrus -M user.marysmith
```

*Perform consistency checks on mailbox user.marysmith.*

## SEE ALSO

*[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*