3 public-inbox-compact - compact Xapian DBs in an inbox
7 public-inbox-compact INBOX_DIR
9 public-inbox-compact --all
13 public-inbox-compact is a wrapper for L<xapian-compact(1)>
14 which locks the inbox and prevents other processes such as
15 L<public-inbox-watch(1)> or L<public-inbox-mda(1)> from
16 writing while it operates.
18 It enforces the use of the C<--no-renumber> option of
19 L<xapian-compact(1)> which is required to work with the
20 rest of the public-inbox search code.
22 This command is rarely needed for active inboxes.
24 Using the C<--compact> option of L<public-inbox-index(1)>
25 is recommended, instead, and only when doing a C<--reindex>.
33 Compact all inboxes configured in ~/.public-inbox/config.
34 This is an alternative to specifying individual inboxes directories
37 =item --blocksize / --no-full / --fuller
39 These options are passed directly to L<xapian-compact(1)>.
49 The default config file, normally "~/.public-inbox/config".
50 See L<public-inbox-config(5)>
52 =item XAPIAN_FLUSH_THRESHOLD
54 The number of documents to update before committing changes to
55 disk. This environment is handled directly by Xapian, refer to
56 Xapian API documentation for more details.
64 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
66 The mail archives are hosted at L<https://public-inbox.org/meta/>
67 and L<http://hjrcffqmbrq6wope.onion/meta/>
71 Copyright 2018-2021 all contributors L<mailto:meta@public-inbox.org>
73 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
77 L<xapian-compact(1)>, L<public-inbox-index(1)>