=head1 NAME
-public-inbox-compact - compact Xapian DBs
+public-inbox-compact - compact Xapian DBs in an inbox
=head1 SYNOPSIS
- public-inbox-compact INBOX_DIR
+public-inbox-compact INBOX_DIR
+
+public-inbox-compact --all
=head1 DESCRIPTION
writing while it operates.
It enforces the use of the C<--no-renumber> option of
-L<xapian-compact(1)>
+L<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 C<--compact> option of L<public-inbox-index(1)>
+is recommended, instead, and only when doing a C<--reindex>.
=head1 OPTIONS
=over
+=item --all
+
+Compact all inboxes configured in ~/.public-inbox/config.
+This is an alternative to specifying individual inboxes directories
+on the command-line.
+
=item --blocksize / --no-full / --fuller
These options are passed directly to L<xapian-compact(1)>.
=head1 COPYRIGHT
-Copyright 2018-2019 all contributors L<mailto:meta@public-inbox.org>
+Copyright 2018-2021 all contributors L<mailto:meta@public-inbox.org>
License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>