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 which locks the inbox and prevents other processes such as
  13 L<public-inbox-watch(1)> or L<public-inbox-mda(1)> from
  14 writing while it operates.
  15
  16 It enforces the use of the C<--no-renumber> option of
  17 L<xapian-compact(1)>
  18
  19 =head1 ENVIRONMENT
  20
  21 =over 8
  22
  23 =item PI_CONFIG
  24
  25 The default config file, normally "~/.public-inbox/config".
  26 See L<public-inbox-config(5)>
  27
  28 =item XAPIAN_FLUSH_THRESHOLD
  29
  30 The number of documents to update before committing changes to
  31 disk.  This environment is handled directly by Xapian, refer to
  32 Xapian API documentation for more details.
  33
  34 Default: 10000
  35
  36 =back
  37
  38 =head1 CONTACT
  39
  40 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  41
  42 The mail archives are hosted at L<https://public-inbox.org/meta/>
  43 and L<http://hjrcffqmbrq6wope.onion/meta/>
  44
  45 =head1 COPYRIGHT
  46
  47 Copyright 2018-2019 all contributors L<mailto:meta@public-inbox.org>
  48
  49 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  50
  51 =head1 SEE ALSO
  52
  53 L<xapian-compact(1)>, L<public-inbox-index(1)>