<html> <head> <meta name="Content-Style" content="text/css"> </head> <body> <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="#/etc/imapd.conf /etc/cyrus.conf">/etc/imapd.conf /etc/cyrus.conf</a><br> <!-- Creator : groff version 1.15 --> <!-- CreationDate: Mon Feb 3 16:31:16 2003 --> <!-- Total number of pages: 1 --> <!-- Page: 1 --> <!-- left margin: 100 --> <!-- right margin: 750 --> <a name="NAME"></a><h2>NAME</h2><p><font size=3>squatter - create SQUAT indexes for mailboxes</p> <a name="SYNOPSIS"></a><h2>SYNOPSIS</h2><p><font size=3><B>squatter</B> <font size=3>[ <font size=3><B>-C</B> <font size=3><I>config-file</I> <font size=3>] [ <font size=3><B>-r</B> <font size=3>] [ <font size=3><B>-s</B> <font size=3>] [ <font size=3><B>-v</B> <font size=3>] <font size=3><I>mailbox</I><font size=3>...</p> <a name="DESCRIPTION"></a><h2>DESCRIPTION</h2><p><font size=3><I>Squatter</I> <font size=3>creates a new SQUAT index for one or more IMAP mailboxes. The SQUAT index a unified index of all of the header and body text of each message a given mailbox. This index is used to significantly reduce IMAP SEARCH times on a mailbox.</p> <p><font size=3><I>Squatter</I> <font size=3>creates an index of ALL messages in the mailbox, not just those since the last time that it was run (i.e., it does NOT do incremental updates). Any messages appended to the mailbox after <font size=3><I>squatter</I> <font size=3>is run, will NOT be included in the index. To include new messages in the index, <font size=3><I>squatter</I> <font size=3>must be run again. For large and active mailboxes, it is recommended to run <font size=3><I>squatter</I> <font size=3>periodically as an EVENT in <font size=3><I>cyrus.conf</I><font size=3>(5)</p> <p><font size=3><B>NOTE:</B> <font size=3>Messages and mailboxes that have not been indexed CAN still be SEARCHed, just not as quickly as those with a SQUAT index.</p> <p><font size=3><I>Squatter</I> <font size=3>reads its configuration options out of the <font size=3><I>imapd.conf</I><font size=3>(5) file unless specified otherwise by <font size=3><B>-C</B><font size=3>.</p> <a name="OPTIONS"></a><h2>OPTIONS</h2> <table width="100%" rules="none" frame="none" cols="3"> <tr valign="top" align="left"> <td valign="top" align="left" width="12.6154%"> <p><font size=3><B>-C</B> <font size=3><I>config-file</p> </I><p><font size=3><B>-r</p> </B></td> <td valign="top" align="left" width="7.3846%"> </td> <td valign="top" align="left" width="80.0000%"> <p><font size=3>Read configuration options from <font size=3><I>config-file</I><font size=3>.</p> <p><font size=3>Recursively create indexes for all sub-mailboxes of the mailboxes or mailbox prefixes given as arguments.</p> </td> </tr> <tr valign="top" align="left"> <td valign="top" align="left" width="12.6154%"> <p><font size=3><B>-s</p> </B></td> <td valign="top" align="left" width="7.3846%"> </td> <td valign="top" align="left" width="80.0000%"> <p><font size=3>Skip mailboxes whose index file is older than their current squat file (within a small time<br> delta).</p> </td> </tr> <tr valign="top" align="left"> <td valign="top" align="left" width="12.6154%"> <p><font size=3><B>-v</p> </B></td> <td valign="top" align="left" width="7.3846%"> </td> <td valign="top" align="left" width="80.0000%"> <p><font size=3>Increase the verbosity of progress/status messages.</p> </td> </tr> </table> <br> <a name="FILES"></a><h2>FILES</h2><a name="/etc/imapd.conf /etc/cyrus.conf"></a><h2>/etc/imapd.conf /etc/cyrus.conf</h2></body> </html>
