doc: recommend -compact after --reindex

[public-inbox.git] / Documentation / public-inbox-compact.pod

diff --git a/Documentation/public-inbox-compact.pod b/Documentation/public-inbox-compact.pod
index 7d37f6fb154506785e5475415cae0c5dd6e17fbf..6b0c7376ff8927fce95f763f8ff42880593bde67 100644 (file)
--- a/Documentation/public-inbox-compact.pod
+++ b/Documentation/public-inbox-compact.pod
@@ -1,6 +1,6 @@
 =head1 NAME
 
-public-inbox-compact - compact Xapian DBs
+public-inbox-compact - compact Xapian DBs in an inbox
 
 =head1 SYNOPSIS
 
@@ -14,7 +14,18 @@ L<public-inbox-watch(1)> or L<public-inbox-mda(1)> from
 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.
+
+=head1 OPTIONS
+
+=over
+
+=item --blocksize / --no-full / --fuller
+
+These options are passed directly to L<xapian-compact(1)>.
+
+=back
 
 =head1 ENVIRONMENT
 
@@ -50,4 +61,5 @@ 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>