about summary refs log tree commit homepage
path: root/Documentation
diff options
context:
space:
mode:
authorEric Wong <e@yhbt.net>2020-08-13 08:04:37 +0000
committerEric Wong <e@yhbt.net>2020-08-14 09:56:15 +0000
commited04e9e16999b4624f884d0ab0b66ba16ae57691 (patch)
tree9028f05e2c8df4cc4f84b39cec10393187e04e7a /Documentation
parentc81d2d38b3fb8adcee890dbae59c0e03e129217f (diff)
downloadpublic-inbox-ed04e9e16999b4624f884d0ab0b66ba16ae57691.tar.gz
For -index, this is a convenient way to quickly index all
inboxes after a grok-pull.  Might as well support it for
rarely used commands like -compact and -xcpdb, too.
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/public-inbox-compact.pod10
-rw-r--r--Documentation/public-inbox-index.pod8
-rw-r--r--Documentation/public-inbox-xcpdb.pod10
3 files changed, 26 insertions, 2 deletions
diff --git a/Documentation/public-inbox-compact.pod b/Documentation/public-inbox-compact.pod
index d7a7dba0..8e463ab1 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
 
@@ -21,6 +23,12 @@ rest of the public-inbox search code.
 
 =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<xapian-compact(1)>.
diff --git a/Documentation/public-inbox-index.pod b/Documentation/public-inbox-index.pod
index b28db773..1ed9f5e7 100644
--- a/Documentation/public-inbox-index.pod
+++ b/Documentation/public-inbox-index.pod
@@ -6,6 +6,8 @@ public-inbox-index - create and update search indices
 
 public-inbox-index [OPTIONS] INBOX_DIR...
 
+public-inbox-index [OPTIONS] --all
+
 =head1 DESCRIPTION
 
 public-inbox-index creates and updates the search, overview and
@@ -81,6 +83,12 @@ This does not touch the NNTP article number database.
 It does not affect threading unless C<--rethread> is
 used.
 
+=item --all
+
+Index all inboxes configured in ~/.public-inbox/config.
+This is an alternative to specifying individual inboxes directories
+on the command-line.
+
 =item --rethread
 
 Regenerate internal THREADID and message thread associations
diff --git a/Documentation/public-inbox-xcpdb.pod b/Documentation/public-inbox-xcpdb.pod
index 62a28c0a..2b38f1da 100644
--- a/Documentation/public-inbox-xcpdb.pod
+++ b/Documentation/public-inbox-xcpdb.pod
@@ -4,7 +4,9 @@ public-inbox-xcpdb - upgrade Xapian DB formats
 
 =head1 SYNOPSIS
 
-        public-inbox-xcpdb [OPTIONS] INBOX_DIR
+public-inbox-xcpdb [OPTIONS] INBOX_DIR
+
+public-inbox-xcpdb [OPTIONS] --all
 
 =head1 DESCRIPTION
 
@@ -19,6 +21,12 @@ L<public-inbox-learn(1)>, and L<public-inbox-index(1)>.
 
 =over
 
+=item --all
+
+Copy all inboxes configured in ~/.public-inbox/config.
+This is an alternative to specifying individual inboxes directories
+on the command-line.
+
 =item -c, --compact
 
 In addition to performing the copy operation, run L<xapian-compact(1)>