]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/public-inbox-extindex.pod
doc: ignore onion URLs for 80-column check
[public-inbox.git] / Documentation / public-inbox-extindex.pod
1 =head1 NAME
2
3 public-inbox-extindex - create and update external search indices
4
5 =head1 SYNOPSIS
6
7 public-inbox-extindex [OPTIONS] EXTINDEX_DIR INBOX_DIR...
8
9 public-inbox-extindex [OPTIONS] [EXTINDEX_DIR] --all
10
11 =head1 DESCRIPTION
12
13 FIXME: behavior not finalized  It should probably write to the
14 config file the first time --all is used.
15
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.
21
22 =head1 OPTIONS
23
24 =over
25
26 =item --jobs=JOBS, -j
27
28 ... TODO, see L<public-inbox-index(5)>
29
30 =back
31
32 =head1 FILES
33
34 L<public-inbox-extindex-format(5)>
35
36 =head1 CONFIGURATION
37
38 ... TODO, see L<public-inbox-index(5)>
39
40 =head1 ENVIRONMENT
41
42 =over 8
43
44 =item PI_CONFIG
45
46 Used to override the default "~/.public-inbox/config" value.
47
48 =item XAPIAN_FLUSH_THRESHOLD
49
50 The number of documents to update before committing changes to
51 disk.  This environment is handled directly by Xapian, refer to
52 Xapian API documentation for more details.
53
54 Setting C<XAPIAN_FLUSH_THRESHOLD> or
55 C<publicinbox.indexBatchSize> for a large C<--reindex> may cause
56 L<public-inbox-mda(1)>, L<public-inbox-learn(1)> and
57 L<public-inbox-watch(1)> tasks to wait long and unpredictable
58 periods of time during C<--reindex>.
59
60 Default: none, uses C<publicinbox.indexBatchSize>
61
62 =back
63
64 =head1 UPGRADING
65
66 Occasionally, public-inbox will update it's schema version and
67 require a full index by running this command.
68
69 =head1 CONTACT
70
71 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
72
73 The mail archives are hosted at L<https://public-inbox.org/meta/> and
74 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
75
76 =head1 COPYRIGHT
77
78 Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
79
80 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
81
82 =head1 SEE ALSO
83
84 L<Search::Xapian>, L<DBD::SQLite>