diff options
author | Eric Wong <e@yhbt.net> | 2020-02-02 06:52:21 +0000 |
---|---|---|
committer | Eric Wong <e@yhbt.net> | 2020-02-02 17:29:58 +0000 |
commit | a715ce5da88e2263888a92335d794fab0aad91c0 (patch) | |
tree | eebfa7b911db8cbe53f6eea659b95991ab560dbd | |
parent | 4bb77753fbbc30ab396a1b01d70cf65b629b6276 (diff) | |
download | public-inbox-a715ce5da88e2263888a92335d794fab0aad91c0.tar.gz |
These switches have always been there, but were not documented until now.
-rw-r--r-- | Documentation/public-inbox-convert.pod | 41 |
1 files changed, 39 insertions, 2 deletions
diff --git a/Documentation/public-inbox-convert.pod b/Documentation/public-inbox-convert.pod index 4c790dee..417e5e4e 100644 --- a/Documentation/public-inbox-convert.pod +++ b/Documentation/public-inbox-convert.pod @@ -4,7 +4,7 @@ public-inbox-convert - convert v1 inboxes to v2 =head1 SYNOPSIS - public-inbox-convert OLD_DIR NEW_DIR + public-inbox-convert [OPTIONS] OLD_DIR NEW_DIR =head1 DESCRIPTION @@ -14,6 +14,27 @@ and users are expected to update the "inboxdir" path in L<public-inbox-config(5)> to point to the path of NEW_DIR once they are satisfied with the conversion. +=head1 OPTIONS + +=over + +=item --no-index + +Disables Xapian and overview DB indexing on the new repository. +By default, public-inbox-convert creates a new index in the v2 +repository and indexes all existing messages, a lengthy +operation for large inboxes. + +=item -j JOBS, --jobs=JOBS + +Control the number of indexing jobs and Xapian shards of the v2 +inbox. By default, this is the detected CPU count but capped +at 4 due to various bottlenecks. The number of Xapian shards +will be 1 less than the JOBS value, since there is a single +process which distributes work to the Xapian shards. + +=back + =head1 ENVIRONMENT =over 8 @@ -27,6 +48,21 @@ See L<public-inbox-config(5)> =head1 UPGRADING +Editing "~/.public-inbox/config" (or whatever C<PI_CONFIG> is +set to) will be required to start using the new directory. + +=head1 BUGS + +Writes from L<public-inbox-mda(1)> or L<git-fetch(1)> to the v1 +inbox which occur after the start of the conversion will not +be picked up in the v2 inbox. + +Users of L<public-inbox-watch(1)> do not have to worry about +this. They only need to update the config file to point to the +v2 inbox, send C<SIGHUP> public-inbox-watch process to reload +the config file, and then C<SIGUSR1> to rescan existing +Maildirs. + =head1 CONTACT Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org> @@ -42,4 +78,5 @@ License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt> =head1 SEE ALSO -L<public-inbox-init(1)>, L<public-inbox-index(1)> +L<public-inbox-init(1)>, L<public-inbox-index(1)>, L<public-inbox-config(5)>, +L<public-inbox-v1-format(5)>, L<public-inbox-v2-format(5)> |