cyrus-chk_cyrus(8)

cyrus-chk_cyrus8

Cyrus imap documentation perform a consistency check of the cyrus imap mail spool.

Usage

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

Overview

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) file unless specified otherwise by -C.

Options

-C config-file

Use the specified configuration file config-file rather than the default imapd.conf(5).

-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/[email protected], 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.

Releases

7 releases since Debian 7 (Wheezy); the text changed 5 times.

  1. 7–8
  2. 9
  3. 10
  4. 11
  5. 12
  6. 13

--mailbox since Debian 13 (Trixie); --partition since Debian 13 (Trixie); -C since Debian 10 (Buster); -M since Debian 10 (Buster); -P since Debian 10 (Buster).

Author

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

From cyrus-common 3.10.2-1+deb13u2 in Debian 13 (Trixie). Parsed by carta from the page's man source.