]> Sergey Matveev's repositories - public-inbox.git/blobdiff - Documentation/public-inbox-compact.pod
tests: remove Email::MIME->create use entirely
[public-inbox.git] / Documentation / public-inbox-compact.pod
index 7d37f6fb154506785e5475415cae0c5dd6e17fbf..d7a7dba08a2adf940607b700df3920a8c892f181 100644 (file)
@@ -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
 
@@ -44,7 +55,7 @@ and L<http://hjrcffqmbrq6wope.onion/meta/>
 
 =head1 COPYRIGHT
 
-Copyright 2018-2019 all contributors L<mailto:meta@public-inbox.org>
+Copyright 2018-2020 all contributors L<mailto:meta@public-inbox.org>
 
 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>