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 This command is rarely needed for active inboxes.
  23
  24 Using the C<--compact> option of L<public-inbox-index(1)>
  25 is recommended, instead, and only when doing a C<--reindex>.
  26
  27 =head1 OPTIONS
  28
  29 =over
  30
  31 =item --all
  32
  33 Compact all inboxes configured in ~/.public-inbox/config.
  34 This is an alternative to specifying individual inboxes directories
  35 on the command-line.
  36
  37 =item --blocksize / --no-full / --fuller
  38
  39 These options are passed directly to L<xapian-compact(1)>.
  40
  41 =back
  42
  43 =head1 ENVIRONMENT
  44
  45 =over 8
  46
  47 =item PI_CONFIG
  48
  49 The default config file, normally "~/.public-inbox/config".
  50 See L<public-inbox-config(5)>
  51
  52 =item XAPIAN_FLUSH_THRESHOLD
  53
  54 The number of documents to update before committing changes to
  55 disk.  This environment is handled directly by Xapian, refer to
  56 Xapian API documentation for more details.
  57
  58 Default: 10000
  59
  60 =back
  61
  62 =head1 CONTACT
  63
  64 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  65
  66 The mail archives are hosted at L<https://public-inbox.org/meta/> and
  67 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
  68
  69 =head1 COPYRIGHT
  70
  71 Copyright 2018-2021 all contributors L<mailto:meta@public-inbox.org>
  72
  73 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  74
  75 =head1 SEE ALSO
  76
  77 L<xapian-compact(1)>, L<public-inbox-index(1)>