X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-xcpdb.pod;h=e7c07ed38d4085c9c5b6bbdc7954f50aa8b2a68a;hb=HEAD;hp=62a28c0a18a9f17b7e1e1f843ef75a335a6bc003;hpb=75b5402ed1e989cd63f4f3ce4237cdad908e3984;p=public-inbox.git diff --git a/Documentation/public-inbox-xcpdb.pod b/Documentation/public-inbox-xcpdb.pod index 62a28c0a..e7c07ed3 100644 --- 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,22 @@ accept parallel Xapian database modifications from L, L, L, and L. +This command is rarely used, as Xapian DB formats rarely +change. + =head1 OPTIONS =over -=item -c, --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 + +=item --compact In addition to performing the copy operation, run L on each Xapian shard after copying but before finalizing it. @@ -31,7 +44,9 @@ preferable for gigantic inboxes where the coarse-grained lock currently required for L can cause the compaction to take hours at-a-time. -=item --reshard=N / -R N +=item -R N + +=item --reshard=N Reshard the Xapian database on a L inbox to C shards . Since L is not suitable @@ -41,7 +56,11 @@ existing Xapian database(s) to any positive value of C. This is useful in case the Xapian DB was created with too few or too many shards given the capabilities of the current hardware. -=item --blocksize / --no-full / --fuller +=item --blocksize + +=item --no-full + +=item --fuller These options are passed directly to L when used with C<--compact>. @@ -49,8 +68,9 @@ used with C<--compact>. =item --no-fsync Disable L and L. +See L for caveats. -Available in public-inbox 1.6.0 (PENDING). +Available in public-inbox 1.6.0+. =item --sequential-shard @@ -112,12 +132,12 @@ computing resources. Feedback welcome via plain-text mail to L -The mail archives are hosted at L -and L +The mail archives are hosted at L and +L =head1 COPYRIGHT -Copyright 2019-2020 all contributors L +Copyright 2019-2021 all contributors L License: AGPL-3.0+ L