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 a wrapper for L<copydatabase(1)> for
  12 upgrading to the latest database format supported by Xapian
  13 (e.g. "glass" or "honey").
  14
  15 It locks the inbox and prevents other processes such as
  16 L<public-inbox-watch(1)> and L<public-inbox-mda(1)> from
  17 writing while it operates.
  18
  19 This is intended for upgrading the database format used by
  20 Xapian.  It DOES NOT upgrade the schema used by the
  21 public-inbox search interface (see L<public-inbox-index(1)>).
  22
  23 =head1 ENVIRONMENT
  24
  25 =over 8
  26
  27 =item PI_CONFIG
  28
  29 The default config file, normally "~/.public-inbox/config".
  30 See L<public-inbox-config(5)>
  31
  32 =back
  33
  34 =head1 UPGRADING
  35
  36 =head1 CONTACT
  37
  38 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  39
  40 The mail archives are hosted at L<https://public-inbox.org/meta/>
  41 and L<http://hjrcffqmbrq6wope.onion/meta/>
  42
  43 =head1 COPYRIGHT
  44
  45 Copyright 2019 all contributors L<mailto:meta@public-inbox.org>
  46
  47 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  48
  49 =head1 SEE ALSO
  50
  51 L<copydatabase(1)>, L<public-inbox-index(1)>