public-inbox 1.6.1 - minor bugfix release

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

diff --git a/Documentation/public-inbox-xcpdb.pod b/Documentation/public-inbox-xcpdb.pod
index 2ed4c5821087b8cc637935391cd4f3c8d8e19c0a..1bc1b1dfcc9be471a11d7ec2e3df4ead5453bc81 100644 (file)
--- a/Documentation/public-inbox-xcpdb.pod
+++ b/Documentation/public-inbox-xcpdb.pod
@@ -4,7 +4,9 @@ public-inbox-xcpdb - upgrade Xapian DB formats
 
 =head1 SYNOPSIS
 
-       public-inbox-xcpdb [OPTIONS] INBOX_DIR
+public-inbox-xcpdb [OPTIONS] INBOX_DIR
+
+public-inbox-xcpdb [OPTIONS] --all
 
 =head1 DESCRIPTION
 
@@ -15,11 +17,20 @@ accept parallel Xapian database modifications from
 L<public-inbox-watch(1)>, L<public-inbox-mda(1)>,
 L<public-inbox-learn(1)>, and L<public-inbox-index(1)>.
 
+This command is rarely used, as Xapian DB formats rarely
+change.
+
 =head1 OPTIONS
 
 =over
 
-=item --compact
+=item --all
+
+Copy all inboxes configured in ~/.public-inbox/config.
+This is an alternative to specifying individual inboxes directories
+on the command-line.
+
+=item -c, --compact
 
 In addition to performing the copy operation, run L<xapian-compact(1)>
 on each Xapian shard after copying but before finalizing it.
@@ -49,8 +60,26 @@ used with C<--compact>.
 =item --no-fsync
 
 Disable L<fsync(2)> and L<fdatasync(2)>.
+See L<public-inbox-index(1)/--no-fsync> for caveats.
+
+Available in public-inbox 1.6.0+.
+
+=item --sequential-shard
+
+Copy each shard sequentially, ignoring C<--jobs>.  This also
+affects indexing done at the end of a run.
+
+=item --batch-size=BYTES
+
+=item --max-size=BYTES
+
+See L<public-inbox-index(1)> for a description of these options.
 
-Available in public-inbox 1.6.0 (PENDING).
+These indexing options indexing at the end of a run.
+C<public-inbox-xcpdb> may run in parallel with with
+L<public-inbox-index(1)>, and C<public-inbox-xcpdb> needs to
+reindex changes made to the old Xapian DBs by
+L<public-inbox-index(1)> while it was running.
 
 =back