| 1 |
.. cyrusman:: chk_cyrus(8) |
| 2 |
|
| 3 |
.. author: Nic Bernstein (Onlight) |
| 4 |
.. author: Jeroen van Meeuwen (Kolab Systems) |
| 5 |
|
| 6 |
.. _imap-reference-manpages-systemcommands-chk_cyrus: |
| 7 |
|
| 8 |
============= |
| 9 |
**chk_cyrus** |
| 10 |
============= |
| 11 |
|
| 12 |
Perform a consistency check of the Cyrus IMAP mail spool. |
| 13 |
|
| 14 |
Synopsis |
| 15 |
======== |
| 16 |
|
| 17 |
.. parsed-literal:: |
| 18 |
|
| 19 |
**chk_cyrus** [ **-C** *config-file* ] [ **-P** *partition* | **-M** *mailbox* ] |
| 20 |
|
| 21 |
Description |
| 22 |
=========== |
| 23 |
|
| 24 |
**chk_cyrus** is used to perform a consistency check on the cyrus |
| 25 |
datastore, and output a list of files/directories that are expected to |
| 26 |
exist, but do not. Status messages are output to stderr, the list of |
| 27 |
files/directories is output to stdout. This list can be passed to a |
| 28 |
backup program to aid a partial restoration, for instance. |
| 29 |
|
| 30 |
**chk_cyrus** |default-conf-text| |
| 31 |
|
| 32 |
Options |
| 33 |
======= |
| 34 |
|
| 35 |
.. program:: chk_cyrus |
| 36 |
|
| 37 |
.. option:: -C config-file |
| 38 |
|
| 39 |
|cli-dash-c-text| |
| 40 |
|
| 41 |
.. option:: -P partition, --partition=partition |
| 42 |
|
| 43 |
Limit to partition *partition*. May not be specified with **-M**. |
| 44 |
|
| 45 |
.. option:: -M mailbox, --mailbox=mailbox |
| 46 |
|
| 47 |
Only check mailbox *mailbox*. May not be specified with **-P**. |
| 48 |
|
| 49 |
.. IMPORTANT:: |
| 50 |
|
| 51 |
The mailbox must be specified in the internal format, so rather |
| 52 |
than specifying ``user/john/[email protected]``, you will want |
| 53 |
to specify ``example.org!user.john.Trash``. |
| 54 |
|
| 55 |
Examples |
| 56 |
======== |
| 57 |
|
| 58 |
.. parsed-literal:: |
| 59 |
|
| 60 |
**chk_cyrus -P** *default* |
| 61 |
|
| 62 |
.. |
| 63 |
|
| 64 |
Perform consistency checks on *default* partition. |
| 65 |
|
| 66 |
.. parsed-literal:: |
| 67 |
|
| 68 |
**chk_cyrus -C** */usr/local/etc/imapd-slot1.conf* **-P** *default* |
| 69 |
|
| 70 |
.. |
| 71 |
|
| 72 |
Perform consistency checks on *default* partition using specified |
| 73 |
configuration file. |
| 74 |
|
| 75 |
.. parsed-literal:: |
| 76 |
|
| 77 |
**chk_cyrus -M** *user.marysmith* |
| 78 |
|
| 79 |
.. |
| 80 |
|
| 81 |
Perform consistency checks on mailbox *user.marysmith*. |
| 82 |
|
| 83 |
See Also |
| 84 |
======== |
| 85 |
:cyrusman:`imapd.conf(5)`, :cyrusman:`master(8)` |