Man page - cyrus-chk_cyrus(8)

Packages contains this manual

Package:  cyrus-common
apt-get install cyrus-common

Manuals in package:
• cyrus-ptdump(8)
• cyrus-ctl_mboxlist(8)
• cyrus-unexpunge(8)
• cyrus-restore(8)
• cyrus-tls_prune(8)
• cyrus-cyr_buildinfo(8)
• cyrus-makedirs(8)
• cyrus-fud(8)
• cyrus-cyr_expire(8)
• cyrus-lmtpproxyd(8)
• cyrus-cyr_userseen(8)
• cyrus-mbpath(8)
• cyrus-ctl_cyrusdb(8)
• cyrus-proxyd(8)
• cyrus-cyr_dbtool(8)
• cyrus-backupd(8)
• cyrus-quota(8)
• cyrus-deliver(8)
• cyrus-ctl_zoneinfo(8)
• cyrus-sieved(8)
• cyrus-cyr_info(8)
• cyrus-cyr_df(8)
• cyrus-ctl_deliver(8)
• cyrus-cyr_ls(8)
• cyrus-cyr_deny(8)
• cyrus-sievec(8)
• cyrus-cyrdump(8)
• cyrus-arbitronsort(8)
• cyrus-master(8)
• cyrus-timsieved(8)
• cyrus-smmapd(8)
• cyrus-reconstruct(8)
• cyrus-pop3proxyd(8)
• cyrus-cvt_xlist_specialuse(8)
• cyr_backup(8)
• cyrus-lmtpd(8)
• cyrus-chk_cyrus(8)
• cyrus-ptloader(8)
• cyr_virusscan(8)
• cyrus-arbitron(8)
• cyrus-dump(8)
• cyrus-mbexamine(8)
• krb.equiv(5)
• cyrus-ipurge(8)
• imapd.conf(5)
• cyrus-mbtool(8)
• ctl_backups(8)
• ctl_conversationsdb(8)
• cyrus-cvt_cyrusdb(8)
• cyrus-ptexpire(8)
• cyrus.conf(5)
• cyrus-notifyd(8)
• cyrus-relocate_by_id(8)
Documentations in package:
• cyrus-common

Manual

CHK_CYRUS

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
EXAMPLES
SEE ALSO
AUTHOR
COPYRIGHT

---

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) 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/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) , master(8)

AUTHOR

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

COPYRIGHT

1993–2025, The Cyrus Team

---