1SQUATTER(8)                 System Manager's Manual                SQUATTER(8)
2
3
4
5 *
6

NAME

8       squatter - create SQUAT indexes for mailboxes
9

SYNOPSIS

11       squatter  [  -C  config-file ] [ -r ] [ -s ] [ -i ] [ -a ] [ -v ] mail‐
12       box...
13

DESCRIPTION

15       Squatter creates a new SQUAT index for one or more IMAP mailboxes.  The
16       SQUAT  index  is  a unified index of all of the header and body text of
17       each message a given mailbox.  This  index  is  used  to  significantly
18       reduce IMAP SEARCH times on a mailbox.
19
20       Squatter  creates  an  index  of  ALL messages in the mailbox, not just
21       those since the last time that it was run (i.e., it does NOT do  incre‐
22       mental  updates).   Any messages appended to the mailbox after squatter
23       is run, will NOT be included in the index.  To include new messages  in
24       the index, squatter must be run again.  For large and active mailboxes,
25       it  is  recommended  to  run  squatter  periodically  as  an  EVENT  in
26       cyrus.conf(5)
27
28       NOTE:  Messages  and  mailboxes that have not been indexed CAN still be
29       SEARCHed, just not as quickly as those with a SQUAT index.
30
31       Squatter reads its configuration options out of the imapd.conf(5)  file
32       unless specified otherwise by -C.
33

OPTIONS

35       -C config-file
36              Read configuration options from config-file.
37
38       -r     Recursively  create  indexes  for all sub-mailboxes of the mail‐
39              boxes or mailbox prefixes given as arguments.
40
41       -s     Skip mailboxes whose index file  is  older  than  their  current
42              squat file (within a small time delta).
43
44       -i     Incremental updates where squat indexes already exist.
45
46       -a     Only  create  indexes  for mailboxes which have the shared /ven‐
47              dor/cmu/cyrus-imapd/squat annotation set to "true".
48
49              The value of  the  /vendor/cmu/cyrus-imapd/squat  annotation  is
50              inherited  by  all  children  of the given mailbox, so an entire
51              mailbox tree can be indexed (or not indexed) by setting a single
52              annotation  on  the root of that tree with a value of "true" (or
53              "false").  If a  mailbox  does  not  have  a  /vendor/cmu/cyrus-
54              imapd/squat annotation set on it (or does not inherit one), then
55              the mailbox is not indexed.  In other words, the implicit  value
56              of /vendor/cmu/cyrus-imapd/squat is "false".
57
58       -v     Increase the verbosity of progress/status messages.
59

FILES

61       /etc/imapd.conf /etc/cyrus.conf
62
63
64
65CMU                              Project Cyrus                     SQUATTER(8)