=head1 SYNOPSIS
-public-inbox-index GIT_DIR
+public-inbox-index [OPTIONS] INBOX_DIR...
=head1 DESCRIPTION
-public-inbox-index creates and updates the search and NNTP
-article number database used by the read-only public-inbox HTTP
-and NNTP interfaces. Currently, this requires L<Search::Xapian>
-and L<DBD::SQlite> and L<DBI> Perl modules.
+public-inbox-index creates and updates the search, overview and
+NNTP article number database used by the read-only public-inbox
+HTTP and NNTP interfaces. Currently, this requires
+L<DBD::SQLite> and L<DBI> Perl modules. L<Search::Xapian>
+is optional, only to support the PSGI search interface.
Once the initial indices are created by public-inbox-index,
L<public-inbox-mda(1)> and L<public-inbox-watch(1)> will
automatically maintain them.
Running this manually to update indices is only required if
-relying on L<git-fetch(1)> to mirror an existing public-inbox.
+relying on L<git-fetch(1)> to mirror an existing public-inbox;
+or if upgrading to a new version of public-inbox using
+the C<--reindex> option.
-Having a search and article number database is essential to
+Having the overview and article number database is essential to
running the NNTP interface, and strongly recommended for the
-HTTP interface as it provides thread grouping in addition
-to normal search functionality.
+HTTP interface as it provides thread grouping in addition to
+normal search functionality.
-=head1 FILES
+=head1 OPTIONS
-All public-inbox-specific files are contained within the
-C<$GIT_DIR/public-inbox/> directory. All files are expected to
-grow in size as more messages are archived, so using compaction
-commands (e.g. L<xapian-compact(1)>) is not recommended unless
-the list is no longer active.
+=over
-=item $GIT_DIR/public-inbox/msgmap.sqlite3
+=item --compact / -c
-The stable NNTP article number to Message-ID mapping is
-stored in an SQLite3 database.
+Compacts the Xapian DBs after indexing. This is recommended
+when using C<--reindex> to avoid running out of disk space
+while indexing multiple inboxes.
-This is required for users of L<public-inbox-nntpd(1)>, but
-users of the L<PublicInbox::WWW> interface will find it
-useful for attempting recovery from copy-paste truncations of
-URLs containing long Message-IDs.
+While option takes a negligible amount of time compared to
+C<--reindex>, it requires temporarily duplicating the entire
+contents of the Xapian DB.
-Avoid removing this file and regenerating it; it may cause
-existing NNTP readers to lose sync and miss (or duplicate)
-messages.
+This switch may be specified twice, in which case compaction
+happens both before and after indexing to minimize the temporal
+footprint of the (re)indexing operation.
-This file is relatively small, and typically less than 5%
-of the space of the mail stored in a packed git repository.
+=item --reindex
-=item $GIT_DIR/public-inbox/xapian*
+Forces a re-index of all messages in the inbox.
+This can be used for in-place upgrades and bugfixes while
+NNTP/HTTP server processes are utilizing the index. Keep in
+mind this roughly doubles the size of the already-large
+Xapian database. Using this with C<--compact> or running
+L<public-inbox-compact(1)> afterwards is recommended to
+release free space.
-The database used by L<Search::Xapian>. This directory name is
-followed by a number indicating the index schema version this
-installation of public-inbox uses.
+This does not touch the NNTP article number database or
+affect threading.
-These directories may be safely deleted or removed in full
-while the NNTP and HTTP interfaces are no longer accessing
-them.
+=item --prune
-In addition to providing a search interface for the HTTP
-interface, the Xapian database is used to group and combine
-related messages into threads. For NNTP servers, it also
-provides a cache of metadata and header information often
-requested by NNTP clients.
+Run L<git-gc(1)> to prune and expire reflogs if discontiguous history
+is detected. This is intended to be used in mirrors after running
+L<public-inbox-edit(1)> or L<public-inbox-purge(1)> to ensure data
+is expunged from mirrors.
+
+=back
-This directory is large, often two to three times the size of
-the objects stored in a packed git repository.
+=head1 FILES
+
+For v1 (ssoma) repositories described in L<public-inbox-v1-format>.
+All public-inbox-specific files are contained within the
+C<$GIT_DIR/public-inbox/> directory.
+
+v2 inboxes are described in L<public-inbox-v2-format>.
=head1 ENVIRONMENT
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.
+
+Default: our indexing code flushes every megabyte of mail seen
+to keep memory usage low. Setting this environment variable to
+any positive value will switch to a document count-based
+threshold in Xapian.
+
=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>
=head1 COPYRIGHT
-Copyright 2016 all contributors L<mailto:meta@public-inbox.org>
+Copyright 2016-2020 all contributors L<mailto:meta@public-inbox.org>
License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>