t/imapd.t: skip dependent test on failure

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

diff --git a/Documentation/public-inbox-compact.pod b/Documentation/public-inbox-compact.pod
index 47d950a439d39cf958f6709a055b05c7d7356dd3..4e9b6d9fa689ee248275ba43ad8909fb87afb250 100644 (file)
--- a/Documentation/public-inbox-compact.pod
+++ b/Documentation/public-inbox-compact.pod
@@ -1,10 +1,12 @@
 =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
 
@@ -14,12 +16,24 @@ 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.
+
+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)>.
@@ -54,7 +68,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>