diff options
author | Eric Wong (Contractor, The Linux Foundation) <e@80x24.org> | 2018-03-29 20:17:19 +0000 |
---|---|---|
committer | Eric Wong (Contractor, The Linux Foundation) <e@80x24.org> | 2018-03-29 20:17:48 +0000 |
commit | e5c2e2588d7ad2243afeabad67b3c951c5b66643 (patch) | |
tree | 76fa5a4687c53a73b0729b3e5268cbc17e6f977d /Documentation/public-inbox-compact.pod | |
parent | 11a7b5403d3d3dda8266efa374336ca344288cfe (diff) | |
download | public-inbox-e5c2e2588d7ad2243afeabad67b3c951c5b66643.tar.gz |
Having multiple Xapian partitions is mostly pointless after the initial import. We can compact all the partitions into one while keeping the skeleton separate.
Diffstat (limited to 'Documentation/public-inbox-compact.pod')
-rw-r--r-- | Documentation/public-inbox-compact.pod | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/Documentation/public-inbox-compact.pod b/Documentation/public-inbox-compact.pod new file mode 100644 index 00000000..4a519ce9 --- /dev/null +++ b/Documentation/public-inbox-compact.pod @@ -0,0 +1,50 @@ +=head1 NAME + +public-inbox-compact - compact Xapian DBs + +=head1 SYNOPSIS + + public-inbox-compact INBOX_DIR + +=head1 DESCRIPTION + +public-inbox-compact is a wrapper for L<xapian-compact(1)> +designed for "v2" inboxes. It combines multiple Xapian +partitions into one to reduce space overhead after an initial +mass import (using multiple partitions) is done. + +It locks the inbox and prevents other processes such as +L<public-inbox-watch(1)> from writing while it operates. + +It also supports "v1" (ssoma) inboxes with limited +usefulness over L<xapian-compact(1)> + +=head1 ENVIRONMENT + +=over 8 + +=item PI_CONFIG + +The default config file, normally "~/.public-inbox/config". +See L<public-inbox-config(5)> + +=back + +=head1 UPGRADING + +=head1 CONTACT + +Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org> + +The mail archives are hosted at L<https://public-inbox.org/meta/> +and L<http://hjrcffqmbrq6wope.onion/meta/> + +=head1 COPYRIGHT + +Copyright 2018 all contributors L<mailto:meta@public-inbox.org> + +License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt> + +=head1 SEE ALSO + +L<xapian-compact(1)>, L<public-inbox-index(1)> |