public-inbox.git  about / heads / tags
an "archives first" approach to mailing lists
blob 4a519ce999e4c30d6251e6edd2b7bf4b8ead3dd8 1129 bytes (raw)
$ git show ci-WIP:Documentation/public-inbox-compact.pod	# shows this blob on the CLI

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
=head1 NAME

public-inbox-compact - compact Xapian DBs

=head1 SYNOPSIS

	public-inbox-compact INBOX_DIR

=head1 DESCRIPTION

public-inbox-compact is a wrapper for L<xapian-compact(1)>
designed for "v2" inboxes.  It combines multiple Xapian
partitions into one to reduce space overhead after an initial
mass import (using multiple partitions) is done.

It locks the inbox and prevents other processes such as
L<public-inbox-watch(1)> from writing while it operates.

It also supports "v1" (ssoma) inboxes with limited
usefulness over L<xapian-compact(1)>

=head1 ENVIRONMENT

=over 8

=item PI_CONFIG

The default config file, normally "~/.public-inbox/config".
See L<public-inbox-config(5)>

=back

=head1 UPGRADING

=head1 CONTACT

Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>

The mail archives are hosted at L<https://public-inbox.org/meta/>
and L<http://hjrcffqmbrq6wope.onion/meta/>

=head1 COPYRIGHT

Copyright 2018 all contributors L<mailto:meta@public-inbox.org>

License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>

=head1 SEE ALSO

L<xapian-compact(1)>, L<public-inbox-index(1)>

git clone https://public-inbox.org/public-inbox.git
git clone http://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/public-inbox.git