Documentation/public-inbox-xcpdb.pod

   1 =head1 NAME
   2
   3 public-inbox-xcpdb - copy Xapian DBs (for format upgrades)
   4
   5 =head1 SYNOPSIS
   6
   7         public-inbox-xcpdb INBOX_DIR
   8
   9 =head1 DESCRIPTION
  10
  11 public-inbox-xcpdb is similar to L<copydatabase(1)> for
  12 upgrading to the latest database format supported by Xapian
  13 (e.g. "glass" or "honey"), but is designed to tolerate and
  14 recover from Xapian database modifications from
  15 L<public-inbox-watch(1)> or L<public-inbox-mda(1)>.
  16
  17 This is intended for upgrading the database format used by
  18 Xapian.  It DOES NOT upgrade the schema used by the
  19 public-inbox search interface (see L<public-inbox-index(1)>).
  20
  21 =head1 ENVIRONMENT
  22
  23 =over 8
  24
  25 =item PI_CONFIG
  26
  27 The default config file, normally "~/.public-inbox/config".
  28 See L<public-inbox-config(5)>
  29
  30 =item XAPIAN_FLUSH_THRESHOLD
  31
  32 The number of documents to update before committing changes to
  33 disk.  This environment is handled directly by Xapian, refer to
  34 Xapian API documentation for more details.
  35
  36 Default: 10000
  37
  38 =back
  39
  40 =head1 UPGRADING
  41
  42 =head1 CONTACT
  43
  44 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  45
  46 The mail archives are hosted at L<https://public-inbox.org/meta/>
  47 and L<http://hjrcffqmbrq6wope.onion/meta/>
  48
  49 =head1 COPYRIGHT
  50
  51 Copyright 2019 all contributors L<mailto:meta@public-inbox.org>
  52
  53 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  54
  55 =head1 SEE ALSO
  56
  57 L<copydatabase(1)>, L<public-inbox-index(1)>