X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-extindex.pod;fp=Documentation%2Fpublic-inbox-extindex.pod;h=9731dfb0d2a77e03fb342b3f65da9a1bad7d80b0;hb=3ae2a4c3a8f22c0fe08c5c4c26919e311195c23e;hp=a0fca83c6255b1bcfa5a89270501dba164004cdb;hpb=1f1b1f0e22f7b4cbe5c8e843c1932222c0461393;p=public-inbox.git diff --git a/Documentation/public-inbox-extindex.pod b/Documentation/public-inbox-extindex.pod index a0fca83c..9731dfb0 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 @@ -70,7 +67,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