Documentation/public-inbox-compact.pod

   1 =head1 NAME
   2
   3 public-inbox-compact - compact Xapian DBs in an inbox
   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)> which is required to work with the
  18 rest of the public-inbox search code.
  19
  20 =head1 OPTIONS
  21
  22 =over
  23
  24 =item --blocksize / --no-full / --fuller
  25
  26 These options are passed directly to L<xapian-compact(1)>.
  27
  28 =back
  29
  30 =head1 ENVIRONMENT
  31
  32 =over 8
  33
  34 =item PI_CONFIG
  35
  36 The default config file, normally "~/.public-inbox/config".
  37 See L<public-inbox-config(5)>
  38
  39 =item XAPIAN_FLUSH_THRESHOLD
  40
  41 The number of documents to update before committing changes to
  42 disk.  This environment is handled directly by Xapian, refer to
  43 Xapian API documentation for more details.
  44
  45 Default: 10000
  46
  47 =back
  48
  49 =head1 CONTACT
  50
  51 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  52
  53 The mail archives are hosted at L<https://public-inbox.org/meta/>
  54 and L<http://hjrcffqmbrq6wope.onion/meta/>
  55
  56 =head1 COPYRIGHT
  57
  58 Copyright 2018-2020 all contributors L<mailto:meta@public-inbox.org>
  59
  60 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  61
  62 =head1 SEE ALSO
  63
  64 L<xapian-compact(1)>, L<public-inbox-index(1)>