diff options
| -rw-r--r-- | Documentation/public-inbox-extindex.pod | 84 | ||||
| -rw-r--r-- | MANIFEST | 1 |
2 files changed, 85 insertions, 0 deletions
diff --git a/Documentation/public-inbox-extindex.pod b/Documentation/public-inbox-extindex.pod new file mode 100644 index 00000000..a92181e4 --- /dev/null +++ b/Documentation/public-inbox-extindex.pod @@ -0,0 +1,84 @@ +=head1 NAME + +public-inbox-extindex - create and update external search indices + +=head1 SYNOPSIS + +public-inbox-extindex [OPTIONS] EXTINDEX_DIR INBOX_DIR... + +public-inbox-extindex [OPTIONS] [EXTINDEX_DIR] --all + +=head1 DESCRIPTION + +FIXME: behavior not finalized It should probably write to the +config file the first time --all is used. + +public-inbox-extindex creates and updates an external search and +overview database used by the read-only public-inbox PSGI (HTTP), +NNTP, and IMAP interfaces. This requires either the +L<Search::Xapian> XS bindings OR the L<Xapian> SWIG bindings, +along with L<DBD::SQLite> and L<DBI> Perl modules. + +=head1 OPTIONS + +=over + +=item --jobs=JOBS, -j + +... TODO, see L<public-inbox-index(5)> + +=back + +=head1 FILES + +L<public-inbox-extindex-format(5)> + +=head1 CONFIGURATION + +... TODO, see L<public-inbox-index(5)> + +=head1 ENVIRONMENT + +=over 8 + +=item PI_CONFIG + +Used to override the default "~/.public-inbox/config" value. + +=item XAPIAN_FLUSH_THRESHOLD + +The number of documents to update before committing changes to +disk. This environment is handled directly by Xapian, refer to +Xapian API documentation for more details. + +Setting C<XAPIAN_FLUSH_THRESHOLD> or +C<publicinbox.indexBatchSize> for a large C<--reindex> may cause +L<public-inbox-mda(1)>, L<public-inbox-learn(1)> and +L<public-inbox-watch(1)> tasks to wait long and unpredictable +periods of time during C<--reindex>. + +Default: none, uses C<publicinbox.indexBatchSize> + +=back + +=head1 UPGRADING + +Occasionally, public-inbox will update it's schema version and +require a full index by running this command. + +=head1 CONTACT + +Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org> + +The mail archives are hosted at L<https://public-inbox.org/meta/> +and L<http://hjrcffqmbrq6wope.onion/meta/> + +=head1 COPYRIGHT + +Copyright 2021 all contributors L<mailto:meta@public-inbox.org> + +License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt> + +=head1 SEE ALSO + +L<Search::Xapian>, L<DBD::SQLite> @@ -29,6 +29,7 @@ Documentation/public-inbox-convert.pod Documentation/public-inbox-daemon.pod Documentation/public-inbox-edit.pod Documentation/public-inbox-extindex-format.pod +Documentation/public-inbox-extindex.pod Documentation/public-inbox-httpd.pod Documentation/public-inbox-imapd.pod Documentation/public-inbox-index.pod |