diff options
author | Kyle Meyer <kyle@kyleam.com> | 2021-05-16 23:35:21 -0400 |
---|---|---|
committer | Eric Wong <e@80x24.org> | 2021-05-17 07:44:17 +0000 |
commit | 6b0bd44cb51112997d77721b052e4a223c62520e (patch) | |
tree | 733d0e5804a5ba9ed9543405d7763ef277b4aefd /Documentation/public-inbox-xcpdb.pod | |
parent | 05a67984dc624250ab815cfe6512abe3a60e9078 (diff) | |
download | public-inbox-6b0bd44cb51112997d77721b052e4a223c62520e.tar.gz |
e226f18934eb7291 modified the lei-q manpage so that each variant of an option gets a dedicated =item to make L</--xyz> look nicer and to follow the Perl core documentation. Do the same for the other manpages. Note that this still leaves the variants of an option grouped in one scenario: when a list of options without descriptions is presented as a pointer to another location. Splitting the variants in that case would make it harder for the reader to tell what the distinct options are.
Diffstat (limited to 'Documentation/public-inbox-xcpdb.pod')
-rw-r--r-- | Documentation/public-inbox-xcpdb.pod | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/Documentation/public-inbox-xcpdb.pod b/Documentation/public-inbox-xcpdb.pod index eb675965..e7c07ed3 100644 --- a/Documentation/public-inbox-xcpdb.pod +++ b/Documentation/public-inbox-xcpdb.pod @@ -30,7 +30,9 @@ Copy all inboxes configured in ~/.public-inbox/config. This is an alternative to specifying individual inboxes directories on the command-line. -=item -c, --compact +=item -c + +=item --compact In addition to performing the copy operation, run L<xapian-compact(1)> on each Xapian shard after copying but before finalizing it. @@ -42,7 +44,9 @@ preferable for gigantic inboxes where the coarse-grained lock currently required for L<public-inbox-compact(1)> 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<v2|public-inbox-v2-format(5)> inbox to C<N> shards . Since L<xapian-compact(1)> is not suitable @@ -52,7 +56,11 @@ existing Xapian database(s) to any positive value of C<N>. 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<xapian-compact(1)> when used with C<--compact>. |