Documentation/public-inbox-compact.pod

   1 =head1 NAME
   2
   3 public-inbox-compact - compact Xapian DBs
   4
   5 =head1 SYNOPSIS
   6
   7         public-inbox-compact INBOX_DIR
   8
   9 =head1 DESCRIPTION
  10
  11 public-inbox-compact is a wrapper for L<xapian-compact(1)>
  12 designed for "v2" inboxes.  It combines multiple Xapian
  13 partitions into one to reduce space overhead after an initial
  14 mass import (using multiple partitions) is done.
  15
  16 It locks the inbox and prevents other processes such as
  17 L<public-inbox-watch(1)> from writing while it operates.
  18
  19 It also supports "v1" (ssoma) inboxes with limited
  20 usefulness over L<xapian-compact(1)>
  21
  22 =head1 ENVIRONMENT
  23
  24 =over 8
  25
  26 =item PI_CONFIG
  27
  28 The default config file, normally "~/.public-inbox/config".
  29 See L<public-inbox-config(5)>
  30
  31 =back
  32
  33 =head1 UPGRADING
  34
  35 =head1 CONTACT
  36
  37 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  38
  39 The mail archives are hosted at L<https://public-inbox.org/meta/>
  40 and L<http://hjrcffqmbrq6wope.onion/meta/>
  41
  42 =head1 COPYRIGHT
  43
  44 Copyright 2018 all contributors L<mailto:meta@public-inbox.org>
  45
  46 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  47
  48 =head1 SEE ALSO
  49
  50 L<xapian-compact(1)>, L<public-inbox-index(1)>