3 public-inbox-convert - convert v1 inboxes to v2
7 public-inbox-convert [OPTIONS] OLD_DIR NEW_DIR
11 public-inbox-convert copies the contents of an old "v1" inbox
12 into a new "v2" inbox. It makes no changes to the old inbox
13 and users are expected to update the "inboxdir" path in
14 L<public-inbox-config(5)> to point to the path of NEW_DIR
15 once they are satisfied with the conversion.
23 Disables Xapian and overview DB indexing on the new inbox.
24 By default, public-inbox-convert creates a new index in the
25 v2 inbox and indexes all existing messages, a lengthy
26 operation for large inboxes.
28 =item -j JOBS, --jobs=JOBS
30 Control the number of indexing jobs and Xapian shards of the v2
31 inbox. By default, this is the detected CPU count but capped
32 at 4 due to various bottlenecks. The number of Xapian shards
33 will be 1 less than the JOBS value, since there is a single
34 process which distributes work to the Xapian shards.
44 The default config file, normally "~/.public-inbox/config".
45 See L<public-inbox-config(5)>
51 Editing "~/.public-inbox/config" (or whatever C<PI_CONFIG> is
52 set to) will be required to start using the new directory.
56 Writes from L<public-inbox-mda(1)> or L<git-fetch(1)> to the v1
57 inbox which occur after the start of the conversion will not
58 be picked up in the v2 inbox.
60 Users of L<public-inbox-watch(1)> do not have to worry about
61 this. They only need to update the config file to point to the
62 v2 inbox, send C<SIGHUP> public-inbox-watch process to reload
63 the config file, and then C<SIGUSR1> to rescan existing
68 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
70 The mail archives are hosted at L<https://public-inbox.org/meta/>
71 and L<http://hjrcffqmbrq6wope.onion/meta/>
75 Copyright 2013-2020 all contributors L<mailto:meta@public-inbox.org>
77 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
81 L<public-inbox-init(1)>, L<public-inbox-index(1)>, L<public-inbox-config(5)>,
82 L<public-inbox-v1-format(5)>, L<public-inbox-v2-format(5)>