<!-- Creator : groff version 1.18.1.1 --> <!-- CreationDate: Thu Dec 1 12:02:36 2011 --> <html> <head> <meta name="generator" content="groff -Thtml, see www.gnu.org"> <meta name="Content-Style" content="text/css"> <title>CTL_CYRUSDB</title> </head> <body> <h1 align=center>CTL_CYRUSDB</h1> <a href="#NAME">NAME</a><br> <a href="#SYNOPSIS">SYNOPSIS</a><br> <a href="#DESCRIPTION">DESCRIPTION</a><br> <a href="#OPTIONS">OPTIONS</a><br> <a href="#FILES">FILES</a><br> <a href="#SEE ALSO">SEE ALSO</a><br> <hr> <a name="NAME"></a> <h2>NAME</h2> <!-- INDENTATION --> <table width="100%" border=0 rules="none" frame="void" cols="2" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="10%"></td> <td width="89%"> <p>ctl_cyrusdb − perform operations common to all Cyrus databases</p> </td> </table> <a name="SYNOPSIS"></a> <h2>SYNOPSIS</h2> <!-- INDENTATION --> <table width="100%" border=0 rules="none" frame="void" cols="2" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="10%"></td> <td width="89%"> <p><b>ctl_cyrusdb</b> [ <b>−C</b> <i>config-file</i> ] <b>−r</b> [ <b>−x</b> ]<b><br> ctl_cyrusdb</b> [ <b>−C</b> <i>config-file</i> ] <b>−c</b></p> </td> </table> <a name="DESCRIPTION"></a> <h2>DESCRIPTION</h2> <!-- INDENTATION --> <table width="100%" border=0 rules="none" frame="void" cols="2" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="10%"></td> <td width="89%"> <p><i>Ctl_cyrusdb</i> is used to perform various administrative operations on the Cyrus databases.</p> <!-- INDENTATION --> <p><i>Ctl_cyrusdb</i> reads its configuration options out of the <i>imapd.conf</i>(5) file unless specified otherwise by <b>-C</b>. The <i>configdirectory</i> option is used to determine the default location of the Cyrus databases (quotas.db, tls_sessions.db, deliver.db, statuschache.db, annotations.db, mailboxes.db and ptclient/ptscache.db). If any database is corrupted, cyrus-imapd will abnormally terminate with information in the log.</p> </td> </table> <a name="OPTIONS"></a> <h2>OPTIONS</h2> <!-- INDENTATION --> <table width="100%" border=0 rules="none" frame="void" cols="2" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="10%"></td> <td width="89%"> <p><b>−C</b> <i>config-file</i></p></td> </table> <!-- INDENTATION --> <table width="100%" border=0 rules="none" frame="void" cols="2" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="21%"></td> <td width="77%"> <p>Read configuration options from <i>config-file</i> (location of the Cyrus databases).</p> </td> </table> <!-- TABS --> <table width="100%" border=0 rules="none" frame="void" cols="4" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="11%"></td> <td width="4%"> <p><b>−r</b></p> </td> <td width="5%"></td> <td width="77%"> <p>Recover the databases after an application or system failure. Also performs database cleanup like removing mailbox reservations (and any associated mailbox files). This procedure is executed every time Cyrus starts.</p> </td> <tr valign="top" align="left"> <td width="11%"></td> <td width="4%"> <p><b>−x</b></p> </td> <td width="5%"></td> <td width="77%"> <p>Used with -r to recover the database only. (Prevents database cleanup).</p> </td> <tr valign="top" align="left"> <td width="11%"></td> <td width="4%"> <p><b>−c</b></p> </td> <td width="5%"></td> <td width="77%"> <p>Checkpoint and archive the databases. Changes to the databases (with Berkley DB-Engine) which are part of committed transactions are written to disk. In default configuration Berkley DB-Engine is used for tls_sessions.db, deliver.db, statuschache.db and ptclient/ptscache.db. Also, a <i>hot</i> backup of the mailboxes.db, annotations.db and quotas.db databases is made and inactive log files are removed. Other files are not necessary, because they can be recreated without any data loss. Backup is stored in db.backup1 directory and older backup in db.backup2 (these directories are rotated).</p> </td> </table> <a name="FILES"></a> <h2>FILES</h2> <!-- INDENTATION --> <table width="100%" border=0 rules="none" frame="void" cols="2" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="10%"></td> <td width="89%"> <p><b>/etc/imapd.conf</b></p></td> </table> <a name="SEE ALSO"></a> <h2>SEE ALSO</h2> <!-- INDENTATION --> <table width="100%" border=0 rules="none" frame="void" cols="2" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="10%"></td> <td width="89%"> <p><b>imapd.conf(5)</b>, <b>cyrus-master(8)</b></p> </td> </table> <hr> </body> </html>