inboxidle: avoid needless syscalls on refresh

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

diff --git a/Documentation/public-inbox-compact.pod b/Documentation/public-inbox-compact.pod
index d7a7dba08a2adf940607b700df3920a8c892f181..4e9b6d9fa689ee248275ba43ad8909fb87afb250 100644 (file)
--- a/Documentation/public-inbox-compact.pod
+++ b/Documentation/public-inbox-compact.pod
@@ -4,7 +4,9 @@ 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
 
@@ -17,10 +19,21 @@ 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.
 
+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)>.