=head1 NAME
-public-inbox-compact - compact Xapian DBs
+public-inbox-compact - compact Xapian DBs in an inbox
=head1 SYNOPSIS
=head1 DESCRIPTION
public-inbox-compact is a wrapper for L<xapian-compact(1)>
-designed for "v2" inboxes. It combines multiple Xapian
-partitions into one to reduce space overhead after an initial
-mass import (using multiple partitions) is done.
+which locks the inbox and prevents other processes such as
+L<public-inbox-watch(1)> or L<public-inbox-mda(1)> from
+writing while it operates.
-It locks the inbox and prevents other processes such as
-L<public-inbox-watch(1)> from writing while it operates.
+It enforces the use of the C<--no-renumber> option of
+L<xapian-compact(1)> which is required to work with the
+rest of the public-inbox search code.
-It also supports "v1" (ssoma) inboxes with limited
-usefulness over L<xapian-compact(1)>
+=head1 OPTIONS
+
+=over
+
+=item --blocksize / --no-full / --fuller
+
+These options are passed directly to L<xapian-compact(1)>.
+
+=back
=head1 ENVIRONMENT
The default config file, normally "~/.public-inbox/config".
See L<public-inbox-config(5)>
-=back
+=item 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.
-=head1 UPGRADING
+Default: 10000
+
+=back
=head1 CONTACT
=head1 COPYRIGHT
-Copyright 2018 all contributors L<mailto:meta@public-inbox.org>
+Copyright 2018-2019 all contributors L<mailto:meta@public-inbox.org>
License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
=head1 SEE ALSO
-L<xapian-compact(1)>, L<public-inbox-index(1)>
+L<xapian-compact(1)|https://public-inbox.org/.xapian-compact.1.html>,
+L<public-inbox-index(1)|https://public-inbox.org/public-inbox-index.html>