3 public-inbox-extindex - create and update external search indices
7 public-inbox-extindex [OPTIONS] EXTINDEX_DIR INBOX_DIR...
9 public-inbox-extindex [OPTIONS] [EXTINDEX_DIR] --all
13 FIXME: behavior not finalized It should probably write to the
14 config file the first time --all is used.
16 public-inbox-extindex creates and updates an external search and
17 overview database used by the read-only public-inbox PSGI (HTTP),
18 NNTP, and IMAP interfaces. This requires either the
19 L<Search::Xapian> XS bindings OR the L<Xapian> SWIG bindings,
20 along with L<DBD::SQLite> and L<DBI> Perl modules.
30 ... TODO, see L<public-inbox-index(5)>
36 L<public-inbox-extindex-format(5)>
40 ... TODO, see L<public-inbox-index(5)>
48 Used to override the default "~/.public-inbox/config" value.
50 =item XAPIAN_FLUSH_THRESHOLD
52 The number of documents to update before committing changes to
53 disk. This environment is handled directly by Xapian, refer to
54 Xapian API documentation for more details.
56 Setting C<XAPIAN_FLUSH_THRESHOLD> or
57 C<publicinbox.indexBatchSize> for a large C<--reindex> may cause
58 L<public-inbox-mda(1)>, L<public-inbox-learn(1)> and
59 L<public-inbox-watch(1)> tasks to wait long and unpredictable
60 periods of time during C<--reindex>.
62 Default: none, uses C<publicinbox.indexBatchSize>
68 Occasionally, public-inbox will update it's schema version and
69 require a full index by running this command.
73 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
75 The mail archives are hosted at L<https://public-inbox.org/meta/> and
76 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
80 Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
82 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
86 L<Search::Xapian>, L<DBD::SQLite>