public-inbox-convert(1)

1PUBLIC-INBOX-CONVERT(1)    public-inbox user manual    PUBLIC-INBOX-CONVERT(1)
2
3
4

NAME

6       public-inbox-convert - convert v1 inboxes to v2
7

SYNOPSIS

9               public-inbox-convert [OPTIONS] OLD_DIR NEW_DIR
10

DESCRIPTION

12       public-inbox-convert copies the contents of an old "v1" inbox into a
13       new "v2" inbox.  It makes no changes to the old inbox and users are
14       expected to update the "inboxdir" path in public-inbox-config(5) to
15       point to the path of NEW_DIR once they are satisfied with the
16       conversion.
17

OPTIONS

19       --no-index
20           Disables Xapian and overview DB indexing on the new inbox.  By
21           default, public-inbox-convert creates a new index in the v2 inbox
22           and indexes all existing messages, a lengthy operation for large
23           inboxes.
24
25       -j JOBS
26       --jobs=JOBS
27           Control the number of indexing jobs and Xapian shards of the v2
28           inbox.  By default, this is the detected CPU count but capped at 4
29           due to various bottlenecks.  The number of Xapian shards will be 1
30           less than the JOBS value, since there is a single process which
31           distributes work to the Xapian shards.
32
33       -L LEVEL, --index-level=LEVEL
34       -c, --compact
35       -v, --verbose
36       --no-fsync
37       --sequential-shard
38       --batch-size=BYTES
39       --max-size=BYTES
40           These options affect indexing.  They have no effect if "--no-index"
41           is specified
42
43           See public-inbox-index(1) for a description of these options.
44

ENVIRONMENT

46       PI_CONFIG
47               The default config file, normally "~/.public-inbox/config".
48               See public-inbox-config(5)
49

UPGRADING

51       Editing "~/.public-inbox/config" (or whatever "PI_CONFIG" is set to)
52       will be required to start using the new directory.
53

BUGS

55       Writes from public-inbox-mda(1) or git-fetch(1) to the v1 inbox which
56       occur after the start of the conversion will not be picked up in the v2
57       inbox.
58
59       Users of public-inbox-watch(1) do not have to worry about this.  They
60       only need to update the config file to point to the v2 inbox, send
61       "SIGHUP" public-inbox-watch process to reload the config file, and then
62       "SIGUSR1" to rescan existing Maildirs.
63

CONTACT

65       Feedback welcome via plain-text mail to <mailto:meta@public-inbox.org>
66
67       The mail archives are hosted at <https://public-inbox.org/meta/> and
68       <http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
69

COPYRIGHT

71       Copyright 2013-2021 all contributors <mailto:meta@public-inbox.org>
72
73       License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
74