SQUATTER(8)SQUATTER(8)NAMEsquatter - create SQUAT indexes for mailboxes
SYNOPSISsquatter [ -C config-file ] [ -r ] [ -s ] [ -v ] mail-
box...
DESCRIPTION
Squatter 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.
Squatter 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 squatter is run, will NOT be
included in the index. To include new messages in the
index, squatter must be run again. For large and active
mailboxes, it is recommended to run squatter periodically
as an EVENT in cyrus.conf(5)
NOTE: Messages and mailboxes that have not been indexed
CAN still be SEARCHed, just not as quickly as those with a
SQUAT index.
Squatter reads its configuration options out of the
imapd.conf(5) file unless specified otherwise by -C.
OPTIONS-C config-file
Read configuration options from config-file.
-r Recursively create indexes for all sub-mailboxes of
the mailboxes or mailbox prefixes given as argu-
ments.
-s Skip mailboxes whose index file is older than their
current squat file (within a small time delta).
-v Increase the verbosity of progress/status messages.
FILES
/etc/imapd.conf /etc/cyrus.conf
SQUATTER(8)
