X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-compact.pod;h=cf64fe0d5ca42e2cd21cf09b03dd1630bbae2ff3;hb=0b15dfc58ceaecdcb1c9285c3ad55813006c8338;hp=47d950a439d39cf958f6709a055b05c7d7356dd3;hpb=69d84811ba0c4c60a5fb6893817328d76444cdf5;p=public-inbox.git diff --git a/Documentation/public-inbox-compact.pod b/Documentation/public-inbox-compact.pod index 47d950a4..cf64fe0d 100644 --- a/Documentation/public-inbox-compact.pod +++ b/Documentation/public-inbox-compact.pod @@ -1,10 +1,12 @@ =head1 NAME -public-inbox-compact - compact Xapian DBs +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 @@ -14,12 +16,24 @@ L or L from writing while it operates. It enforces the use of the C<--no-renumber> option of -L +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 --all + +Compact all inboxes configured in ~/.public-inbox/config. +This is an alternative to specifying individual inboxes directories +on the command-line. + =item --blocksize / --no-full / --fuller These options are passed directly to L. @@ -49,12 +63,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-2019 all contributors L +Copyright 2018-2021 all contributors L License: AGPL-3.0+ L