]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/public-inbox-compact.pod
wwwtext: support $INBOX_URL/_/text/config/raw
[public-inbox.git] / Documentation / public-inbox-compact.pod
1 =head1 NAME
2
3 public-inbox-compact - compact Xapian DBs
4
5 =head1 SYNOPSIS
6
7         public-inbox-compact INBOX_DIR
8
9 =head1 DESCRIPTION
10
11 public-inbox-compact is a wrapper for L<xapian-compact(1)>
12 which locks the inbox and prevents other processes such as
13 L<public-inbox-watch(1)> or L<public-inbox-mda(1)> from
14 writing while it operates.
15
16 It enforces the use of the C<--no-renumber> option of
17 L<xapian-compact(1)>
18
19 =head1 OPTIONS
20
21 =over
22
23 =item --blocksize / --no-full / --fuller
24
25 These options are passed directly to L<xapian-compact(1)>.
26
27 =back
28
29 =head1 ENVIRONMENT
30
31 =over 8
32
33 =item PI_CONFIG
34
35 The default config file, normally "~/.public-inbox/config".
36 See L<public-inbox-config(5)>
37
38 =item XAPIAN_FLUSH_THRESHOLD
39
40 The number of documents to update before committing changes to
41 disk.  This environment is handled directly by Xapian, refer to
42 Xapian API documentation for more details.
43
44 Default: 10000
45
46 =back
47
48 =head1 CONTACT
49
50 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
51
52 The mail archives are hosted at L<https://public-inbox.org/meta/>
53 and L<http://hjrcffqmbrq6wope.onion/meta/>
54
55 =head1 COPYRIGHT
56
57 Copyright 2018-2019 all contributors L<mailto:meta@public-inbox.org>
58
59 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
60
61 =head1 SEE ALSO
62
63 L<xapian-compact(1)|https://public-inbox.org/.xapian-compact.1.html>,
64 L<public-inbox-index(1)|https://public-inbox.org/public-inbox-index.html>