public-inbox-compact(1)

1PUBLIC-INBOX-COMPACT(1)    public-inbox user manual    PUBLIC-INBOX-COMPACT(1)
2
3
4

NAME

6       public-inbox-compact - compact Xapian DBs in an inbox
7

SYNOPSIS

9       public-inbox-compact INBOX_DIR
10
11       public-inbox-compact --all
12

DESCRIPTION

14       public-inbox-compact is a wrapper for xapian-compact(1) which locks the
15       inbox and prevents other processes such as public-inbox-watch(1) or
16       public-inbox-mda(1) from writing while it operates.
17
18       It enforces the use of the "--no-renumber" option of xapian-compact(1)
19       which is required to work with the rest of the public-inbox search
20       code.
21
22       This command is rarely needed for active inboxes.
23
24       Using the "--compact" option of public-inbox-index(1) is recommended,
25       instead, and only when doing a "--reindex".
26

OPTIONS

28       --all
29           Compact all inboxes configured in ~/.public-inbox/config.  This is
30           an alternative to specifying individual inboxes directories on the
31           command-line.
32
33       --blocksize
34       --no-full
35       --fuller
36           These options are passed directly to xapian-compact(1).
37

ENVIRONMENT

39       PI_CONFIG
40               The default config file, normally "~/.public-inbox/config".
41               See public-inbox-config(5)
42
43       XAPIAN_FLUSH_THRESHOLD
44               The number of documents to update before committing changes to
45               disk.  This environment is handled directly by Xapian, refer to
46               Xapian API documentation for more details.
47
48               Default: 10000
49

CONTACT

51       Feedback welcome via plain-text mail to <mailto:meta@public-inbox.org>
52
53       The mail archives are hosted at <https://public-inbox.org/meta/> and
54       <http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
55

COPYRIGHT

57       Copyright 2018-2021 all contributors <mailto:meta@public-inbox.org>
58
59       License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
60