about summary refs log tree commit homepage
path: root/Documentation/public-inbox-compact.pod
blob: 956069fd3d8e896b31de455e204cddbe7746c81a (plain)
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
=head1 NAME

public-inbox-compact - compact Xapian DBs in an inbox

=head1 SYNOPSIS

	public-inbox-compact INBOX_DIR

=head1 DESCRIPTION

public-inbox-compact is a wrapper for L<xapian-compact(1)>
which locks the inbox and prevents other processes such as
L<public-inbox-watch(1)> or L<public-inbox-mda(1)> from
writing while it operates.

It enforces the use of the C<--no-renumber> option of
L<xapian-compact(1)> which is required to work with the
rest of the public-inbox search code.

=head1 OPTIONS

=over

=item --blocksize / --no-full / --fuller

These options are passed directly to L<xapian-compact(1)>.

=back

=head1 ENVIRONMENT

=over 8

=item PI_CONFIG

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

=item XAPIAN_FLUSH_THRESHOLD

The number of documents to update before committing changes to
disk.  This environment is handled directly by Xapian, refer to
Xapian API documentation for more details.

Default: 10000

=back

=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-2019 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)>