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.
18 files changed:
Create C<LOCATION> by mirroring the public-inbox at C<URL>.
Create C<LOCATION> by mirroring the public-inbox at C<URL>.
+=item -v
+
+=item --verbose
Provide more feedback on stderr.
Provide more feedback on stderr.
+=item -q
+
+=item --quiet
Suppress feedback messages.
Suppress feedback messages.
-=item --torsocks=auto|no|yes, --no-torsocks
+=item --torsocks=auto|no|yes
+
+=item --no-torsocks
Whether to wrap L<git(1)> and L<curl(1)> commands with torsocks.
Whether to wrap L<git(1)> and L<curl(1)> commands with torsocks.
Do not look in mail storage for C<OID>. This is implied by
C<--oid-a>, C<--path-a>, and C<--path-b>.
Do not look in mail storage for C<OID>. This is implied by
C<--oid-a>, C<--path-a>, and C<--path-b>.
-=item -A OID-A, --oid-a=OID-A
+=item -A OID-A
+
+=item --oid-a=OID-A
Provide pre-image object ID as a hint for reconstructing C<OID>.
Provide pre-image object ID as a hint for reconstructing C<OID>.
-=item -a PATH-A, --path-a=PATH-A
+=item -a PATH-A
+
+=item --path-a=PATH-A
Provide pre-image pathname as a hint for reconstructing C<OID>.
Provide pre-image pathname as a hint for reconstructing C<OID>.
-=item -b PATH-B, --path-b=PATH-B
+=item -b PATH-B
+
+=item --path-b=PATH-B
Provide post-image pathname as a hint for reconstructing C<OID>.
Provide post-image pathname as a hint for reconstructing C<OID>.
Don't include results from externals.
Don't include results from externals.
-=item -I LOCATION, --include=LOCATION
+=item -I LOCATION
+
+=item --include=LOCATION
Include specified external in search. This option may be given
multiple times.
Include specified external in search. This option may be given
multiple times.
Disable the default behavior of memoizing remote messages into the
local store.
Disable the default behavior of memoizing remote messages into the
local store.
+=item -v
+
+=item --verbose
Provide more feedback on stderr.
Provide more feedback on stderr.
-=item --torsocks=auto|no|yes, --no-torsocks
+=item --torsocks=auto|no|yes
+
+=item --no-torsocks
Whether to wrap L<git(1)> and L<curl(1)> commands with torsocks.
Whether to wrap L<git(1)> and L<curl(1)> commands with torsocks.
+=item -q
+
+=item --quiet
Suppress feedback messages.
Suppress feedback messages.
-=item -F MAIL_FORMAT, --in-format=MAIL_FORMAT
+=item -F MAIL_FORMAT
+
+=item --in-format=MAIL_FORMAT
Message input format. Unless messages are given on stdin, using a
format prefix with C<LOCATION> is preferred.
Message input format. Unless messages are given on stdin, using a
format prefix with C<LOCATION> is preferred.
+=item -q
+
+=item --quiet
Suppress feedback messages.
Suppress feedback messages.
+=item -g
+
+=item --globoff
Do not match C<FILTER> using C<*?> wildcards and C<[]> ranges.
Do not match C<FILTER> using C<*?> wildcards and C<[]> ranges.
Limit operations to those requiring network access.
Limit operations to those requiring network access.
Use C<\0> (NUL) instead of newline (CR) to delimit lines.
Use C<\0> (NUL) instead of newline (CR) to delimit lines.
Use C<\0> (NUL) instead of newline (CR) to delimit lines.
Use C<\0> (NUL) instead of newline (CR) to delimit lines.
+=item -q
+
+=item --quiet
Suppress feedback messages.
Suppress feedback messages.
-=item -w PREFIX[,PREFIX], --want=PREFIX[,PREFIX]
+=item -w PREFIX[,PREFIX]
+
+=item --want=PREFIX[,PREFIX]
Search prefixes to use. C<dfpost> (post-image git blob ID) and C<dfn>
(file names from the diff) are the most useful. Other available
Search prefixes to use. C<dfpost> (post-image git blob ID) and C<dfn>
(file names from the diff) are the most useful. Other available
This information can be useful for seeing how a patch is processed,
but the format should not be considered stable.
This information can be useful for seeing how a patch is processed,
but the format should not be considered stable.
+=item -q
+
+=item --quiet
Suppress feedback messages.
Suppress feedback messages.
-=item -F MAIL_FORMAT, --in-format=MAIL_FORMAT
+=item -F MAIL_FORMAT
+
+=item --in-format=MAIL_FORMAT
Message input format: C<eml>, C<mboxrd>, C<mboxcl2>, C<mboxcl>, or
C<mboxo>.
Default: C<eml>
Message input format: C<eml>, C<mboxrd>, C<mboxcl2>, C<mboxcl>, or
C<mboxo>.
Default: C<eml>
+=item -q
+
+=item --quiet
Suppress feedback messages.
Suppress feedback messages.
This is an alternative to specifying individual inboxes directories
on the command-line.
This is an alternative to specifying individual inboxes directories
on the command-line.
-=item --blocksize / --no-full / --fuller
+=item --blocksize
+
+=item --no-full
+
+=item --fuller
These options are passed directly to L<xapian-compact(1)>.
These options are passed directly to L<xapian-compact(1)>.
v2 inbox and indexes all existing messages, a lengthy
operation for large inboxes.
v2 inbox and indexes all existing messages, a lengthy
operation for large inboxes.
-=item -j JOBS, --jobs=JOBS
+=item -j JOBS
+
+=item --jobs=JOBS
Control the number of indexing jobs and Xapian shards of the v2
inbox. By default, this is the detected CPU count but capped
Control the number of indexing jobs and Xapian shards of the v2
inbox. By default, this is the detected CPU count but capped
-=item -l, --listen ADDRESS
+=item -l ADDRESS
+
+=item --listen ADDRESS
This takes an absolute path to a Unix socket or HOST:PORT
to listen on. For example, to listen to TCP connections on
This takes an absolute path to a Unix socket or HOST:PORT
to listen on. For example, to listen to TCP connections on
Default: server-dependent unless socket activation is used with
L<systemd(1)> or similar (see L<systemd.socket(5)>).
Default: server-dependent unless socket activation is used with
L<systemd(1)> or similar (see L<systemd.socket(5)>).
+=item -1
+
+=item --stdout PATH
Specify an appendable path to redirect stdout descriptor (1) to.
Using this is preferable to setting up the redirect externally
Specify an appendable path to redirect stdout descriptor (1) to.
Using this is preferable to setting up the redirect externally
+=item -2 PATH
+
+=item --stderr PATH
Like C<--stdout>, but for the stderr descriptor (2).
Like C<--stdout>, but for the stderr descriptor (2).
-=item -W, --worker-processes
+=item -W
+
+=item --worker-processes
Set the number of worker processes.
Set the number of worker processes.
+=item -j JOBS
+
+=item --jobs=JOBS
... TODO, see L<public-inbox-index(5)>
... TODO, see L<public-inbox-index(5)>
-=item -l, --listen PROTO://ADDRESS/?cert=/path/to/cert,key=/path/to/key
+=item -l PROTO://ADDRESS/?cert=/path/to/cert,key=/path/to/key
+
+=item --listen PROTO://ADDRESS/?cert=/path/to/cert,key=/path/to/key
In addition to the normal C<-l>/C<--listen> switch described in
L<public-inbox-daemon(8)>, the C<PROTO> prefix (e.g. C<imap://> or
In addition to the normal C<-l>/C<--listen> switch described in
L<public-inbox-daemon(8)>, the C<PROTO> prefix (e.g. C<imap://> or
+=item -j JOBS
+
+=item --jobs=JOBS
Influences the number of Xapian indexing shards in a
(L<public-inbox-v2-format(5)>) inbox.
Influences the number of Xapian indexing shards in a
(L<public-inbox-v2-format(5)>) inbox.
Default: the number of existing Xapian shards
Default: the number of existing Xapian shards
+=item -c
+
+=item --compact
Compacts the Xapian DBs after indexing. This is recommended
when using C<--reindex> to avoid running out of disk space
Compacts the Xapian DBs after indexing. This is recommended
when using C<--reindex> to avoid running out of disk space
Available in public-inbox 1.6.0+.
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
Update the given external index (L<public-inbox-extindex-format(5)>.
Either the configured section name (e.g. C<all>) or a directory name
-=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.
Specify C<2> here to use the scalable L<public-inbox-v2-format(5)>
if you have L<DBD::SQLite> installed.
-=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)>
Controls the indexing level for L<public-inbox-index(1)>
-=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<.>.
The NNTP group name for use with L<public-inbox-nntpd(8)>. This
may be any newsgroup name with hierarchies delimited by C<.>.
Default: unset, no NNTP article numbers are skipped
Default: unset, no NNTP article numbers are skipped
+=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
For C<-V2> (L<public-inbox-v2-format(5)>) inboxes only, this option
allows archivists to publish incomplete archives with newer
Default: unset, no epochs are skipped
Default: unset, no epochs are skipped
+=item -j JOBS
+
+=item --jobs=JOBS
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.
-=item -l, --listen PROTO://ADDRESS/?cert=/path/to/cert,key=/path/to/key
+=item -l PROTO://ADDRESS/?cert=/path/to/cert,key=/path/to/key
+
+=item --listen PROTO://ADDRESS/?cert=/path/to/cert,key=/path/to/key
In addition to the normal C<-l>/C<--listen> switch described in
L<public-inbox-daemon(8)>, the protocol prefix (e.g. C<nntp://> or
In addition to the normal C<-l>/C<--listen> switch described in
L<public-inbox-daemon(8)>, the protocol prefix (e.g. C<nntp://> or
This is an alternative to specifying individual inboxes directories
on the command-line.
This is an alternative to specifying individual inboxes directories
on the command-line.
+=item -c
+
+=item --compact
In addition to performing the copy operation, run L<xapian-compact(1)>
on each Xapian shard after copying but before finalizing it.
In addition to performing the copy operation, run L<xapian-compact(1)>
on each Xapian shard after copying but before finalizing it.
currently required for L<public-inbox-compact(1)> can cause
the compaction to take hours at-a-time.
currently required for L<public-inbox-compact(1)> can cause
the compaction to take hours at-a-time.
-=item --reshard=N / -R N
+=item -R N
+
+=item --reshard=N
Reshard the Xapian database on a L<v2|public-inbox-v2-format(5)>
inbox to C<N> shards . Since L<xapian-compact(1)> is not suitable
Reshard the Xapian database on a L<v2|public-inbox-v2-format(5)>
inbox to C<N> shards . Since L<xapian-compact(1)> is not suitable
This is useful in case the Xapian DB was created with too few or
too many shards given the capabilities of the current hardware.
This is useful in case the Xapian DB was created with too few or
too many shards given the capabilities of the current hardware.
-=item --blocksize / --no-full / --fuller
+=item --blocksize
+
+=item --no-full
+
+=item --fuller
These options are passed directly to L<xapian-compact(1)> when
used with C<--compact>.
These options are passed directly to L<xapian-compact(1)> when
used with C<--compact>.