diff options
Diffstat (limited to 'Documentation/public-inbox-init.pod')
-rw-r--r-- | Documentation/public-inbox-init.pod | 33 |
1 files changed, 25 insertions, 8 deletions
diff --git a/Documentation/public-inbox-init.pod b/Documentation/public-inbox-init.pod index f1ec05de..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<public-inbox-v2-format(5)> if you have L<DBD::SQLite> installed. @@ -31,7 +33,9 @@ L<DBD::SQLite>. Default: C<1> -=item -L, --indexlevel <basic|medium|full> +=item -L <basic|medium|full> + +=item --indexlevel <basic|medium|full> Controls the indexing level for L<public-inbox-index(1)> @@ -39,7 +43,9 @@ See L<public-inbox-config(5)> for more information. Default: C<full> -=item --ng, --newsgroup NEWSGROUP +=item --ng NEWSGROUP + +=item --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<.>. @@ -54,6 +60,13 @@ Available in public-inbox 1.6.0+. Default: none. +=item -c KEY=VALUE + +Allow setting arbitrary configs as C<publicinbox.$NAME.$KEY>. +This is idempotent for the same C<VALUE>, but allows setting +multiple values for keys such as C<publicinbox.$NAME.url> and +C<publicinbox.$NAME.watch>. + =item --skip-artnum This option allows archivists to publish incomplete archives @@ -70,7 +83,9 @@ 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<public-inbox-v2-format(5)>) 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<public-inbox-v2-format(5)>) inbox. @@ -137,12 +154,12 @@ to a given inbox. Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org> -The mail archives are hosted at L<https://public-inbox.org/meta/> -and L<http://hjrcffqmbrq6wope.onion/meta/> +The mail archives are hosted at L<https://public-inbox.org/meta/> and +L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/> =head1 COPYRIGHT -Copyright 2019-2020 all contributors L<mailto:meta@public-inbox.org> +Copyright 2019-2021 all contributors L<mailto:meta@public-inbox.org> License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt> |