public-inbox-extindex(1)

PUBLIC-INBOX-EXTINDEX(1)

public-inbox user manual

PUBLIC-INBOX-EXTINDEX(1)

NAME

public-inbox-extindex - create and update external search indices

SYNOPSIS

public-inbox-extindex [OPTIONS] EXTINDEX_DIR INBOX_DIR...

public-inbox-extindex [OPTIONS] [EXTINDEX_DIR] --all

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 Search::Xapian XS bindings OR the Xapian SWIG bindings, along with DBD::SQLite and DBI Perl modules.

OPTIONS

-j JOBS
--jobs=JOBS: ... TODO, see public-inbox-index(5)

FILES

public-inbox-extindex-format(5)

CONFIGURATION

... TODO, see public-inbox-index(5)

ENVIRONMENT

PI_CONFIG

Used to override the default "~/.public-inbox/config" value.

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 "XAPIAN_FLUSH_THRESHOLD" or "publicinbox.indexBatchSize" for a large "--reindex" may cause public-inbox-mda(1), public-inbox-learn(1) and public-inbox-watch(1) tasks to wait long and unpredictable periods of time during "--reindex".

Default: none, uses "publicinbox.indexBatchSize"

UPGRADING

Occasionally, public-inbox will update it's schema version and require a full index by running this command.

CONTACT

Feedback welcome via plain-text mail to <mailto:meta@public-inbox.org>

The mail archives are hosted at <https://public-inbox.org/meta/> and <http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>

COPYRIGHT

License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>