X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-index.pod;h=011ade3c5090e2d3c4619c13607bb2ea5de83245;hb=9b0c238f887475d920a8589b492ec15c63770152;hp=936516f808eaa52b15b4248a2ea91317cfbfae8d;hpb=f8687564d064ad513972835a7c386f482b56a715;p=public-inbox.git diff --git a/Documentation/public-inbox-index.pod b/Documentation/public-inbox-index.pod index 936516f8..011ade3c 100644 --- a/Documentation/public-inbox-index.pod +++ b/Documentation/public-inbox-index.pod @@ -34,7 +34,9 @@ normal search functionality. =over -=item --jobs=JOBS, -j +=item -j JOBS + +=item --jobs=JOBS Influences the number of Xapian indexing shards in a (L) inbox. @@ -42,7 +44,7 @@ Influences the number of Xapian indexing shards in a See L for a full description of sharding. -C<--jobs=0> is accepted as of public-inbox 1.6.0 (PENDING) +C<--jobs=0> is accepted as of public-inbox 1.6.0 to disable parallel indexing regardless of the number of pre-existing shards. @@ -52,7 +54,9 @@ the overview and article number mapping). Default: the number of existing Xapian shards -=item --compact / -c +=item -c + +=item --compact Compacts the Xapian DBs after indexing. This is recommended when using C<--reindex> to avoid running out of disk space @@ -102,7 +106,7 @@ This fixes some bugs in older versions of public-inbox. While it is possible to use this without C<--reindex>, it makes little sense to do so. -Available in public-inbox 1.6.0 (PENDING). +Available in public-inbox 1.6.0+. =item --prune @@ -133,7 +137,7 @@ significantly speed up and reduce fragmentation during the initial index and full C<--reindex> invocations (but not incremental updates). -Available in public-inbox 1.6.0 (PENDING). +Available in public-inbox 1.6.0+. =item --no-fsync @@ -144,7 +148,14 @@ primarily intended for systems with low RAM and the small may even find disabling L causes too much dirty data to accumulate, resulting on latency spikes from writeback. -Available in public-inbox 1.6.0 (PENDING). +Available in public-inbox 1.6.0+. + +=item --dangerous + +Speed up initial index by using in-place updates and denying support for +concurrent readers. This is only effective with Xapian 1.4+. + +Available in public-inbox 1.8.0+ =item --sequential-shard @@ -152,7 +163,7 @@ Sets or overrides L on a per-invocation basis. See L below. -Available in public-inbox 1.6.0 (PENDING). +Available in public-inbox 1.6.0+. =item --skip-docdata @@ -160,7 +171,36 @@ Stop storing document data in Xapian on an existing inbox. See L for description and caveats. -Available in public-inbox 1.6.0 (PENDING). +Available in public-inbox 1.6.0+. + +=item -E EXTINDEX + +=item --update-extindex=EXTINDEX + +Update the given external index (L. +Either the configured section name (e.g. C) or a directory name +may be specified. + +Defaults to C if C<[extindex "all"]> is configured, +otherwise no external indices are updated. + +May be specified multiple times in rare cases where multiple +external indices are configured. + +=item --no-update-extindex + +Do not update the C external index by default. This negates +all uses of C<-E> / C<--update-extindex=> on the command-line. + +=item --since=DATESTRING + +=item --after=DATESTRING + +=item --until=DATESTRING + +=item --before=DATESTRING + +Passed directly to L to limit changes for C<--reindex> =back @@ -237,7 +277,7 @@ to SQLite databases. WWW and IMAP users may notice incomplete search results, but it is otherwise non-fatal. Using C<--reindex> will bring everything back up-to-date. -Available in public-inbox 1.6.0 (PENDING). +Available in public-inbox 1.6.0+. This is ignored on L inboxes. @@ -286,15 +326,15 @@ require a full index by running this command. Feedback welcome via plain-text mail to L -The mail archives are hosted at L -and L +The mail archives are hosted at L and +L =head1 COPYRIGHT -Copyright 2016-2020 all contributors L +Copyright all contributors L License: AGPL-3.0+ L =head1 SEE ALSO -L, L +L, L, L