doc: post-1.6 updates, start 1.7

[public-inbox.git] / Documentation / public-inbox-init.pod

diff --git a/Documentation/public-inbox-init.pod b/Documentation/public-inbox-init.pod
index fd9fc6379684e58f076efa05880fa8d41d02842a..f1ec05de0a5e2bbad426153715cf7f64f37dbdb8 100644 (file)
--- a/Documentation/public-inbox-init.pod
+++ b/Documentation/public-inbox-init.pod
@@ -31,7 +31,7 @@ L<DBD::SQLite>.
 
 Default: C<1>
 
 
 Default: C<1>
 

-=item --indexlevel <basic|medium|full>
+=item -L, --indexlevel <basic|medium|full>

 
 Controls the indexing level for L<public-inbox-index(1)>
 
 
 Controls the indexing level for L<public-inbox-index(1)>
 


@@ -39,7 +39,22 @@ See L<public-inbox-config(5)> for more information.
 
 Default: C<full>
 
 
 Default: C<full>
 

-=item -N, --skip-artnum
+=item --ng, --newsgroup NEWSGROUP
+
+The NNTP group name for use with L<public-inbox-nntpd(8)>.  This
+may be any newsgroup name with hierarchies delimited by C<.>.
+For example, the newsgroup for L<mailto:meta@public-inbox.org>
+is: C<inbox.comp.mail.public-inbox.meta>
+
+This may be set after-the-fact via C<publicinbox.$NAME.newsgroup>
+in the configuration file.  See L<public-inbox-config(5)> for more
+info.
+
+Available in public-inbox 1.6.0+.
+
+Default: none.
+
+=item --skip-artnum

 
 This option allows archivists to publish incomplete archives
 with only new mail while allowing NNTP article numbers
 
 This option allows archivists to publish incomplete archives
 with only new mail while allowing NNTP article numbers


@@ -51,7 +66,7 @@ but may be of use to L<public-inbox-v1-format(5)> users.
 There is no automatic way to use reserved NNTP article numbers
 when old mail is found, yet.
 
 There is no automatic way to use reserved NNTP article numbers
 when old mail is found, yet.
 

-Available since public-inbox 1.6.0 (PENDING).
+Available in public-inbox 1.6.0+.

 
 Default: unset, no NNTP article numbers are skipped
 
 
 Default: unset, no NNTP article numbers are skipped
 


@@ -71,14 +86,31 @@ Default: unset, no epochs are skipped
 Control the number of Xapian index shards in a
 C<-V2> (L<public-inbox-v2-format(5)>) inbox.
 
 Control the number of Xapian index shards in a
 C<-V2> (L<public-inbox-v2-format(5)>) inbox.
 

-It is useful to use a single shard (C<-j1>) for inboxes on
+It can be useful to use a single shard (C<-j1>) for inboxes on

 high-latency storage (e.g. rotational HDD) unless the system has
 enough RAM to cache 5-10x the size of the git repository.
 
 high-latency storage (e.g. rotational HDD) unless the system has
 enough RAM to cache 5-10x the size of the git repository.
 

-It is generally not useful to specify higher values than the
-default due to contention in the top-level producer process.
+Another approach for HDDs is to use the
+L<public-inbox-index(1)/publicInbox.indexSequentialShard> option
+and many shards, so each shard may fit into the kernel page
+cache.  Unfortunately, excessive shards slows down read-only
+query performance.
+
+For fast storage, it is generally not useful to specify higher
+values than the default due to the top-level producer process
+being a bottleneck.

 
 

-Default: the number of online CPUs, up to 4
+Default: the number of online CPUs, up to 4 (3 shard workers, 1 producer)
+
+=item --skip-docdata
+
+Do not store document data in Xapian, reducing Xapian storage
+overhead by around 1.5%.
+
+Warning: this option prevents rollbacks to public-inbox 1.5.0
+and earlier.
+
+Available in public-inbox 1.6.0+.

 
 =back
 
 
 =back
 


@@ -94,10 +126,12 @@ Used to override the default C<~/.public-inbox/config> value.
 
 =head1 LIMITATIONS
 
 
 =head1 LIMITATIONS
 

-This tool predates NNTP support in public-inbox and is missing
-C<newsgroup> and many of the options documented in
-L<public-inbox-config(5)>.  See L<public-inbox-config(5)> for all the
-options which may be applied to a given inbox.
+Some of the options documented in L<public-inbox-config(5)>
+require editing the config file.  Old versions lack the
+C<--ng>/C<--newsgroup> parameter
+
+See L<public-inbox-config(5)> for all the options which may be applied
+to a given inbox.

 
 =head1 CONTACT
 
 
 =head1 CONTACT