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

NAME

6       chk_cyrus - Cyrus IMAP documentation
7
8       Perform a consistency check of the Cyrus IMAP mail spool.
9

SYNOPSIS

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

DESCRIPTION

14       chk_cyrus  is  used  to perform a consistency check on the cyrus datas‐
15       tore, and output a list of files/directories that are expected  to  ex‐
16       ist,  but  do  not.   Status messages are output to stderr, the list of
17       files/directories is output to stdout.  This list can be  passed  to  a
18       backup program to aid a partial restoration, for instance.
19
20       chk_cyrus reads its configuration options out of the imapd.conf(5) file
21       unless specified otherwise by -C.
22

OPTIONS

24       -C config-file
25              Use the specified configuration file config-file rather than the
26              default imapd.conf(5).
27
28       -P partition
29              Limit to partition partition.  May not be specified with -M.
30
31       -M mailbox
32              Only check mailbox mailbox.  May not be specified with -P.
33
34              IMPORTANT:
35                 The  mailbox  must  be  specified  in the internal format, so
36                 rather than specifying user/john/Trash@example.org, you  will
37                 want to specify example.org!user.john.Trash.
38

EXAMPLES

40       chk_cyrus -P default
41          Perform consistency checks on default partition.
42
43       chk_cyrus -C /usr/local/etc/imapd-slot1.conf -P default
44          Perform consistency checks on default partition using specified con‐
45          figuration file.
46
47       chk_cyrus -M user.marysmith
48          Perform consistency checks on mailbox user.marysmith.
49

SEE ALSO

51       imapd.conf(5), master(8)
52

AUTHOR

54       The Cyrus Team, Nic Bernstein (Onlight), Jeroen van Meeuwen (Kolab Sys‐
55       tems)
56

58       1993–2022, The Cyrus Team
59
60
61
62
633.6.0                          December 12, 2022                  CHK_CYRUS(8)
Impressum