X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-compact.pod;h=d2b74c863ed3ae1a4554ebb7c455887d3335baad;hb=9537b9c7201a7c656c3efcb9918df930a7447981;hp=d7a7dba08a2adf940607b700df3920a8c892f181;hpb=95bdac7f09c69036efed537a4d03d5bdd2ae4eb6;p=public-inbox.git diff --git a/Documentation/public-inbox-compact.pod b/Documentation/public-inbox-compact.pod index d7a7dba0..d2b74c86 100644 --- a/Documentation/public-inbox-compact.pod +++ b/Documentation/public-inbox-compact.pod @@ -4,7 +4,9 @@ public-inbox-compact - compact Xapian DBs in an inbox =head1 SYNOPSIS - public-inbox-compact INBOX_DIR +public-inbox-compact INBOX_DIR + +public-inbox-compact --all =head1 DESCRIPTION @@ -17,11 +19,26 @@ It enforces the use of the C<--no-renumber> option of L which is required to work with the rest of the public-inbox search code. +This command is rarely needed for active inboxes. + +Using the C<--compact> option of L +is recommended, instead, and only when doing a C<--reindex>. + =head1 OPTIONS =over -=item --blocksize / --no-full / --fuller +=item --all + +Compact all inboxes configured in ~/.public-inbox/config. +This is an alternative to specifying individual inboxes directories +on the command-line. + +=item --blocksize + +=item --no-full + +=item --fuller These options are passed directly to L. @@ -50,12 +67,12 @@ Default: 10000 Feedback welcome via plain-text mail to L -The mail archives are hosted at L -and L +The mail archives are hosted at L and +L =head1 COPYRIGHT -Copyright 2018-2020 all contributors L +Copyright 2018-2021 all contributors L License: AGPL-3.0+ L