Man page or keyword search:   man All Sections 1 - General Commands 2 - System Calls 3 - Subroutines, Functions 4 - Special Files 5 - File Formats 6 - Games and Screensavers 7 - Macros and Conventions 8 - Maintenence Commands 9 - Kernel Interface New Commands Server 4.4BSD AIX Alpinelinux Archlinux Aros BSDOS BSDi Bifrost CentOS Cygwin Darwin Debian DigitalUNIX DragonFly ElementaryOS Fedora FreeBSD Gentoo GhostBSD HP-UX Haiku Hurd IRIX Inferno JazzOS Kali Knoppix LinuxMint MacOSX Mageia Mandriva Manjaro Minix MirBSD NeXTSTEP NetBSD OPENSTEP OSF1 OpenBSD OpenDarwin OpenIndiana OpenMandriva OpenServer OpenSuSE OpenVMS Oracle PC-BSD Peanut Pidora Plan9 QNX Raspbian RedHat Scientific Slackware SmartOS Solaris SuSE SunOS Syllable Tru64 UNIXv7 Ubuntu Ultrix UnixWare Xenix YellowDog aLinux   17783 pages apropos Keyword Search (all sections) Output format html ascii pdf view pdf save postscript

SQUATTER(8)							   SQUATTER(8)

 *

NAME
       squatter - create SQUAT indexes for mailboxes

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

DESCRIPTION
       Squatter creates a new SQUAT index for one or more IMAP mailboxes.  The
       SQUAT  index  is	 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	incre‐
       mental  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 mail‐
	      boxes or mailbox prefixes given as arguments.

       -s     Skip mailboxes whose index file  is  older  than	their  current
	      squat file (within a small time delta).

       -i     Incremental updates where squat indexes already exist.

       -a     Only  create  indexes  for mailboxes which have the shared /ven‐
	      dor/cmu/cyrus-imapd/squat annotation set to "true".

	      The value of  the	 /vendor/cmu/cyrus-imapd/squat	annotation  is
	      inherited	 by  all  children  of the given mailbox, so an entire
	      mailbox tree can be indexed (or not indexed) by setting a single
	      annotation  on  the root of that tree with a value of "true" (or
	      "false").	 If a  mailbox	does  not  have	 a  /vendor/cmu/cyrus-
	      imapd/squat annotation set on it (or does not inherit one), then
	      the mailbox is not indexed.  In other words, the implicit	 value
	      of /vendor/cmu/cyrus-imapd/squat is "false".

       -v     Increase the verbosity of progress/status messages.

FILES
       /etc/imapd.conf /etc/cyrus.conf

CMU				 Project Cyrus			   SQUATTER(8)

Vote for polarhome