public-inbox-compact - Man Page

compact Xapian DBs in an inbox

Synopsis

public-inbox-compact INBOX_DIR

public-inbox-compact --all

Description

public-inbox-compact is a wrapper for xapian-compact(1) which locks the inbox and prevents other processes such as public-inbox-watch(1) or public-inbox-mda(1) from writing while it operates.

It enforces the use of the --no-renumber option of xapian-compact(1) which is required to work with the rest of the public-inbox search code.

This command is rarely needed for active inboxes.

Using the --compact option of public-inbox-index(1) is recommended, instead, and only when doing a --reindex.

Options

--all: Compact all inboxes configured in ~/.public-inbox/config. This is an alternative to specifying individual inboxes directories on the command-line.
--blocksize
--no-full
--fuller: These options are passed directly to xapian-compact(1).

Environment

PI_CONFIG

The default config file, normally "~/.public-inbox/config". See public-inbox-config(5)

XAPIAN_FLUSH_THRESHOLD

The number of documents to update before committing changes to disk. This environment is handled directly by Xapian, refer to Xapian API documentation for more details.

Default: 10000