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

NAME

6       squatter - create SQUAT indexes for mailboxes
7

SYNOPSIS

9       squatter [ -C config-file ] [ -r ] [ -s ] [ -a ] [ -v ] mailbox...
10

DESCRIPTION

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

OPTIONS

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

FILES

56       /etc/imapd.conf /etc/cyrus.conf
57
58
59
60CMU                              Project Cyrus                     SQUATTER(8)
Impressum