diff options
author | Kyle Meyer <kyle@kyleam.com> | 2021-05-16 23:35:21 -0400 |
---|---|---|
committer | Eric Wong <e@80x24.org> | 2021-05-17 07:44:17 +0000 |
commit | 6b0bd44cb51112997d77721b052e4a223c62520e (patch) | |
tree | 733d0e5804a5ba9ed9543405d7763ef277b4aefd /Documentation/public-inbox-init.pod | |
parent | 05a67984dc624250ab815cfe6512abe3a60e9078 (diff) | |
download | public-inbox-6b0bd44cb51112997d77721b052e4a223c62520e.tar.gz |
e226f18934eb7291 modified the lei-q manpage so that each variant of an option gets a dedicated =item to make L</--xyz> look nicer and to follow the Perl core documentation. Do the same for the other manpages. Note that this still leaves the variants of an option grouped in one scenario: when a list of options without descriptions is presented as a pointer to another location. Splitting the variants in that case would make it harder for the reader to tell what the distinct options are.
Diffstat (limited to 'Documentation/public-inbox-init.pod')
-rw-r--r-- | Documentation/public-inbox-init.pod | 20 |
1 files changed, 15 insertions, 5 deletions
diff --git a/Documentation/public-inbox-init.pod b/Documentation/public-inbox-init.pod index 5a875f9d..62624f14 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<.>. @@ -70,7 +76,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 +89,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. |