X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-init.pod;h=85c6c9e89172b25b77e35aa248f4f215cab0ca65;hb=7559defa226c950fd9ace161294b3fbcf0200e75;hp=2464504539749f314b4e054b10f1d97e72b8d680;hpb=78b1c973fba89bc6651ffa16807c40abd38e7bad;p=public-inbox.git diff --git a/Documentation/public-inbox-init.pod b/Documentation/public-inbox-init.pod index 24645045..85c6c9e8 100644 --- a/Documentation/public-inbox-init.pod +++ b/Documentation/public-inbox-init.pod @@ -20,7 +20,9 @@ may be specified for inboxes with multiple addresses. =over -=item -V, --version FORMAT_VERSION +=item -V FORMAT_VERSION + +=item --version FORMAT_VERSION Specify C<2> here to use the scalable L if you have L installed. @@ -31,7 +33,9 @@ L. Default: C<1> -=item -L, --indexlevel +=item -L + +=item --indexlevel Controls the indexing level for L @@ -39,7 +43,9 @@ See L for more information. Default: C -=item --ng, --newsgroup NEWSGROUP +=item --ng NEWSGROUP + +=item --newsgroup NEWSGROUP The NNTP group name for use with L. This may be any newsgroup name with hierarchies delimited by C<.>. @@ -50,10 +56,17 @@ This may be set after-the-fact via C in the configuration file. See L for more info. -Available since public-inbox 1.6.0 (PENDING). +Available in public-inbox 1.6.0+. Default: none. +=item -c KEY=VALUE + +Allow setting arbitrary configs as C. +This is idempotent for the same C, but allows setting +multiple values for keys such as C and +C. + =item --skip-artnum This option allows archivists to publish incomplete archives @@ -66,11 +79,13 @@ but may be of use to L users. 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 -=item -S, --skip-epoch +=item -S + +=item --skip-epoch For C<-V2> (L) inboxes only, this option allows archivists to publish incomplete archives with newer @@ -81,7 +96,9 @@ Available since public-inbox 1.2.0. Default: unset, no epochs are skipped -=item -j, --jobs=JOBS +=item -j JOBS + +=item --jobs=JOBS Control the number of Xapian index shards in a C<-V2> (L) inbox. @@ -110,7 +127,7 @@ overhead by around 1.5%. Warning: this option prevents rollbacks to public-inbox 1.5.0 and earlier. -Available since public-inbox 1.6.0 (PENDING). +Available in public-inbox 1.6.0+. =back @@ -137,12 +154,12 @@ to a given inbox. 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 2019-2020 all contributors L +Copyright 2019-2021 all contributors L License: AGPL-3.0+ L