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 public-inbox-compact --all
  10
  11 =head1 DESCRIPTION
  12
  13 public-inbox-compact is a wrapper for L<xapian-compact(1)>
  14 which locks the inbox and prevents other processes such as
  15 L<public-inbox-watch(1)> or L<public-inbox-mda(1)> from
  16 writing while it operates.
  17
  18 It enforces the use of the C<--no-renumber> option of
  19 L<xapian-compact(1)> which is required to work with the
  20 rest of the public-inbox search code.
  21
  22 =head1 OPTIONS
  23
  24 =over
  25
  26 =item --all
  27
  28 Compact all inboxes configured in ~/.public-inbox/config.
  29 This is an alternative to specifying individual inboxes directories
  30 on the command-line.
  31
  32 =item --blocksize / --no-full / --fuller
  33
  34 These options are passed directly to L<xapian-compact(1)>.
  35
  36 =back
  37
  38 =head1 ENVIRONMENT
  39
  40 =over 8
  41
  42 =item PI_CONFIG
  43
  44 The default config file, normally "~/.public-inbox/config".
  45 See L<public-inbox-config(5)>
  46
  47 =item XAPIAN_FLUSH_THRESHOLD
  48
  49 The number of documents to update before committing changes to
  50 disk.  This environment is handled directly by Xapian, refer to
  51 Xapian API documentation for more details.
  52
  53 Default: 10000
  54
  55 =back
  56
  57 =head1 CONTACT
  58
  59 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  60
  61 The mail archives are hosted at L<https://public-inbox.org/meta/>
  62 and L<http://hjrcffqmbrq6wope.onion/meta/>
  63
  64 =head1 COPYRIGHT
  65
  66 Copyright 2018-2020 all contributors L<mailto:meta@public-inbox.org>
  67
  68 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  69
  70 =head1 SEE ALSO
  71
  72 L<xapian-compact(1)>, L<public-inbox-index(1)>