X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-extindex.pod;h=f71a90e588f16c5e4269ee9c2778d53ae6c888e8;hb=e683fa9ea41f44191e32be6af37069210c4593e2;hp=a0fca83c6255b1bcfa5a89270501dba164004cdb;hpb=8ffed15abbec68463ff3f3105d6651c8a4b5d813;p=public-inbox.git diff --git a/Documentation/public-inbox-extindex.pod b/Documentation/public-inbox-extindex.pod index a0fca83c..f71a90e5 100644 --- a/Documentation/public-inbox-extindex.pod +++ b/Documentation/public-inbox-extindex.pod @@ -10,9 +10,6 @@ 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 @@ -27,7 +24,17 @@ along with L and L Perl modules. =item --jobs=JOBS -... TODO, see L +=item --no-fsync + +=item --dangerous + +=item --rethread + +=item --max-size SIZE + +=item --batch-size SIZE + +These switches behave as they do for L =item --all @@ -70,7 +77,19 @@ L =head1 CONFIGURATION -... TODO, see L +public-inbox-extindex does not currently write to the +L file, configuration may be entered +manually. The extindex name of C is a special case which +corresponds to indexing C<--all> inboxes. An example for +C<--all> is as follows: + + [extindex "all"] + topdir = /path/to/extindex_dir + url = all + coderepo = foo + coderepo = bar + +See L for more details. =head1 ENVIRONMENT @@ -110,7 +129,7 @@ L =head1 COPYRIGHT -Copyright 2021 all contributors L +Copyright all contributors L License: AGPL-3.0+ L