about summary refs log tree commit homepage
path: root/Documentation/public-inbox-index.pod
diff options
context:
space:
mode:
authorKyle Meyer <kyle@kyleam.com>2021-05-16 23:35:21 -0400
committerEric Wong <e@80x24.org>2021-05-17 07:44:17 +0000
commit6b0bd44cb51112997d77721b052e4a223c62520e (patch)
tree733d0e5804a5ba9ed9543405d7763ef277b4aefd /Documentation/public-inbox-index.pod
parent05a67984dc624250ab815cfe6512abe3a60e9078 (diff)
downloadpublic-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-index.pod')
-rw-r--r--Documentation/public-inbox-index.pod12
1 files changed, 9 insertions, 3 deletions
diff --git a/Documentation/public-inbox-index.pod b/Documentation/public-inbox-index.pod
index 3bdd5efc..57fedb69 100644
--- a/Documentation/public-inbox-index.pod
+++ b/Documentation/public-inbox-index.pod
@@ -34,7 +34,9 @@ normal search functionality.
 
 =over
 
-=item --jobs=JOBS, -j
+=item -j JOBS
+
+=item --jobs=JOBS
 
 Influences the number of Xapian indexing shards in a
 (L<public-inbox-v2-format(5)>) inbox.
@@ -52,7 +54,9 @@ the overview and article number mapping).
 
 Default: the number of existing Xapian shards
 
-=item --compact / -c
+=item -c
+
+=item --compact
 
 Compacts the Xapian DBs after indexing.  This is recommended
 when using C<--reindex> to avoid running out of disk space
@@ -162,7 +166,9 @@ See L<public-inbox-init(1)/--skip-docdata> for description and caveats.
 
 Available in public-inbox 1.6.0+.
 
-=item --update-extindex=EXTINDEX, -E
+=item -E EXTINDEX
+
+=item --update-extindex=EXTINDEX
 
 Update the given external index (L<public-inbox-extindex-format(5)>.
 Either the configured section name (e.g. C<all>) or a directory name