Issues in zstd man pages

[hmartink]

Dear zstd maintainer,
the manpage-l10n project maintains a large number of translations of
man pages both from a large variety of sources (including zstd) as
well for a large variety of target languages.

During their work translators notice different possible issues in the
original (english) man pages. Sometimes this is a straightforward
typo, sometimes a hard to read sentence, sometimes this is a
convention not held up and sometimes we simply do not understand the
original.

We use several distributions as sources and update regularly (at
least every 2 month). This means we are fairly recent (some
distributions like archlinux also update frequently) but might miss
the latest upstream version once in a while, so the error might be
already fixed. We apologize and ask you to close the issue immediately
if this should be the case, but given the huge volume of projects and
the very limited number of volunteers we are not able to double check
each and every issue.

Secondly we translators see the manpages in the neutral po format,
i.e. converted and harmonized, but not the original source (be it man,
groff, xml or other). So we cannot provide a true patch (where
possible), but only an approximation which you need to convert into
your source format.

Finally the issues I'm reporting have accumulated over time and are
not always discovered by me, so sometimes my description of the
problem my be a bit limited - do not hesitate to ask so we can clarify
them.

I'm now reporting the errors for your project. If future reports
should use another channel, please let me know.

Man page: zstdgrep.1
Issue:    B<zstdgrep> → zstdgrep

"B<zstdgrep> - print lines matching a pattern in zstandard-compressed files"
--
Man page: zstdgrep.1
Issue 1:  B<grep (1)> → B<grep>(1)
Issue 2:  B<zstdcat (1)> → B<zstdcat>(1)

"B<zstdgrep> runs B<grep (1)> on files, or B<stdin> if no files argument is "
"given, after decompressing them with B<zstdcat (1)>."
--
Man page: zstdgrep.1
Issue 1:  grep-flags and pattern → I<grep-flags> and I<pattern>
Issue 2:  B<grep (1)> → B<grep>(1)
Issue 3:  B<grep-flags> → I<grep-flags>
Issue 4:  pattern → I<pattern>

"The grep-flags and pattern arguments are passed on to B<grep (1)>. If an B<-"
"e> flag is found in the B<grep-flags>, B<zstdgrep> will not look for a "
"pattern argument."
--
Man page: zstdgrep.1
Issue:    B<rg> → B<rg>(1)

"Note that modern B<grep> alternatives such as B<ripgrep> (B<rg>) support "
"B<zstd>-compressed files out of the box, and can prove better alternatives "
"than B<zstdgrep> notably for unsupported complex pattern searches. Note "
"though that such alternatives may also feature some minor command line "
"differences."
--
Man page: zstdgrep.1
Issue:    B<zstd (1)> → B<zstd>(1)

"B<zstd (1)>"
--
Man page: zstdless.1
Issue 1:  B<less (1)> → B<less>(1)
Issue 2:  B<zstdcat (1)> → B<zstdcat>(1)

"B<zstdless> runs B<less (1)> on files or stdin, if no files argument is "
"given, after decompressing them with B<zstdcat (1)>."
--
Man page: zstdless.1
Issue:    B<zstd (1)> → B<zstd>(1)

"B<zstd (1)>"

[felixhandte]

@hmartink, thanks for the report! We'll address this in the next release.

[felixhandte]

I believe I've addressed all of these in the linked PR.