about summary refs log tree commit homepage
path: root/Documentation
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2021-08-31 22:23:00 +0000
committerEric Wong <e@80x24.org>2021-09-01 00:18:57 +0000
commit4666eceed62cc37d02cd7d35d8ab327ef3833636 (patch)
tree987a23418ff0f42a5ef06f56979d75cf80ccdbf6 /Documentation
parent66ac16e2afe11100f1e359d04da399589af05d31 (diff)
downloadpublic-inbox-4666eceed62cc37d02cd7d35d8ab327ef3833636.tar.gz
Cache is expensive, so help users save on storage by documenting
this behavior.
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/public-inbox-extindex.pod11
1 files changed, 11 insertions, 0 deletions
diff --git a/Documentation/public-inbox-extindex.pod b/Documentation/public-inbox-extindex.pod
index fed5017b..2e2e6383 100644
--- a/Documentation/public-inbox-extindex.pod
+++ b/Documentation/public-inbox-extindex.pod
@@ -29,6 +29,17 @@ along with L<DBD::SQLite> and L<DBI> Perl modules.
 
 ... TODO, see L<public-inbox-index(5)>
 
+=item --all
+
+Index all C<publicinbox> entries in C<PI_CONFIG>.
+
+C<publicinbox> entries indexed by C<public-inbox-extindex> can
+have full Xapian searching abilities with the per-C<publicinbox>
+C<indexlevel> set to C<basic> and their respective Xapian
+(C<xap15> or C<xapian15>) directories removed.  For multiple
+public-inboxes where cross-posting is common, this allows
+significant space savings on Xapian indices.
+
 =back
 
 =head1 FILES