X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-extindex.pod;h=a0fca83c6255b1bcfa5a89270501dba164004cdb;hb=9d72cc3f876e3d2bd1ecb2fc0f33c43a9a72b933;hp=bed65272838a03e083c918bf2287d1ede3217607;hpb=0b15dfc58ceaecdcb1c9285c3ad55813006c8338;p=public-inbox.git diff --git a/Documentation/public-inbox-extindex.pod b/Documentation/public-inbox-extindex.pod index bed65272..a0fca83c 100644 --- a/Documentation/public-inbox-extindex.pod +++ b/Documentation/public-inbox-extindex.pod @@ -23,10 +23,45 @@ along with L and L Perl modules. =over -=item --jobs=JOBS, -j +=item -j JOBS + +=item --jobs=JOBS ... TODO, see L +=item --all + +Index all C entries in C. + +C entries indexed by C can +have full Xapian searching abilities with the per-C +C set to C and their respective Xapian +(C or C) directories removed. For multiple +public-inboxes where cross-posting is common, this allows +significant space savings on Xapian indices. + +=item --gc + +Perform garbage collection instead of indexing. Use this if +inboxes are removed from the extindex, or if messages are +purged or removed from some inboxes. + +=item --reindex + +Forces a re-index of all messages in the extindex. This can be +used for in-place upgrades and bugfixes while read-only server +processes are utilizing the index. Keep in mind this roughly +doubles the size of the already-large Xapian database. + +The extindex locks will be released roughly every 10s to +allow L and L +processes to write to the extindex. + +=item --fast + +Used with C<--reindex>, it will only look for new and stale +entries and not touch already-indexed messages. + =back =head1 FILES