]> Sergey Matveev's repositories - public-inbox.git/commitdiff
doc: document --jobs for `lei q' and `lei up'
authorEric Wong <e@80x24.org>
Fri, 9 Sep 2022 17:58:25 +0000 (17:58 +0000)
committerEric Wong <e@80x24.org>
Fri, 9 Sep 2022 17:58:25 +0000 (17:58 +0000)
These may be helpful for users on slow disks or have
IMAP server limitations.

Documentation/lei-q.pod
Documentation/lei-up.pod

index 2f0c3bc6cdf518e6638628414fa1097bb3446f23..8134223e8bc333d5224e300fb1b04f4f9baf2b71 100644 (file)
@@ -124,6 +124,23 @@ of the same thread.
 TODO: Warning: this flag may become persistent and saved in
 lei/store unless an MUA unflags it!  (Behavior undecided)
 
+=item --jobs=QUERY_WORKERS[,WRITE_WORKERS]
+=item --jobs=,WRITE_WORKERS
+
+=item -j QUERY_WORKERS[,WRITE_WORKERS]
+=item -j ,WRITE_WORKERS
+
+Set the number of query and write worker processes for parallelism.
+
+C<QUERY_WORKERS> defaults to the number of CPUs available, but 4 per
+remote (HTTP/HTTPS) host.
+
+C<WRITE_WORKERS> defaults to the number of CPUs available for Maildir,
+IMAP/IMAPS, and mbox* destinations.
+
+Omitting C<QUERY_WORKERS> but leaving the comma (C<,>) allows
+one to only set C<WRITE_WORKERS>
+
 =item --dedupe=STRATEGY
 
 =item -d STRATEGY
index ac644a9693fc9883ce5df359b5e613de33cdf091..3b7c6f46fed64eb2170e16e25a4b3827025451fe 100644 (file)
@@ -64,7 +64,9 @@ specified via C<lei q --only>.
 
 =item --mua=CMD
 
-C<--lock>, C<--alert>, and C<--mua> are all supported and
+=item --jobs QUERY_WORKERS[,WRITE_WORKERS]
+
+C<--lock>, C<--alert>, C<--mua>, and C<--jobs> are all supported and
 documented in L<lei-q(1)>.
 
 C<--mua> is incompatible with C<--all>.