about summary refs log tree commit homepage
path: root/Documentation
diff options
authorEric Wong <e@yhbt.net>2020-03-28 00:56:04 +0000
committerEric Wong <e@yhbt.net>2020-03-29 23:28:30 +0000
commitb5ddcb3352ef31aeb03b4c4cbb04af3de34a4c4f (patch)
tree6e1a63adf6d5a28add5edf0bd74ca8bcaff2c00f /Documentation
parent8e1ec8836dabc58dfc0115b36ed440b4371b70d7 (diff)
It's more convenient to specify `-c' / `--compact' on the
command-line when reindexing than it is to invoke
public-inbox-compact(1) separately.

This is especially convenient in low-space situations when
public-inbox-index is operating on multiple inboxes
sequentially, as compaction can happen immediately after
indexing each inbox, instead of waiting until all inboxes are
Diffstat (limited to 'Documentation')
1 files changed, 20 insertions, 4 deletions
diff --git a/Documentation/public-inbox-index.pod b/Documentation/public-inbox-index.pod
index 14113ec8..dede5d2e 100644
--- a/Documentation/public-inbox-index.pod
+++ b/Documentation/public-inbox-index.pod
@@ -4,7 +4,7 @@ public-inbox-index - create and update search indices
 =head1 SYNOPSIS
-public-inbox-index [OPTIONS] INBOX_DIR
+public-inbox-index [OPTIONS] INBOX_DIR...
@@ -32,16 +32,32 @@ normal search functionality.
+=item --compact / -c
+Compacts the Xapian DBs after indexing.  This is recommended
+when using C<--reindex> to avoid running out of disk space
+while indexing multiple inboxes.
+While option takes a negligible amount of time compared to
+C<--reindex>, it requires temporarily duplicating the entire
+contents of the Xapian DB.
+This switch may be specified twice, in which case compaction
+happens both before and after indexing to minimize the temporal
+footprint of the (re)indexing operation.
 =item --reindex
 Forces a re-index of all messages in the inbox.
 This can be used for in-place upgrades and bugfixes while
 NNTP/HTTP server processes are utilizing the index.  Keep in
 mind this roughly doubles the size of the already-large
-Xapian database.  Running L<public-inbox-compact(1)>
-afterwards is recommended to release free space.
+Xapian database.  Using this with C<--compact> or running
+L<public-inbox-compact(1)> afterwards is recommended to
+release free space.
-This does not touch the NNTP article number database.
+This does not touch the NNTP article number database or
+affect threading.
 =item --prune