perl5 icon indicating copy to clipboard operation
perl5 copied to clipboard

[doc] Issue in ptar.1perl

Open hmartink opened this issue 3 weeks ago • 0 comments

Dear Perl maintainer, the manpage-l10n project[1] maintains a large number of translations of man pages both from a large variety of sources (including Perl) 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 your 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 issues for your project. If future reports should use another channel, please let me know.

[1] https://manpages-l10n-team.pages.debian.net/manpages-l10n/

Btw. I noticed that you said that missing perl-internal links are a limitation of your toolchain, because in HTML it does not look right. Is this still the case? Then I will not report this in the future, but I think in HTML it is quite sensible, as this can then be turned into proper hyperlinks within the Perl documentation, giving a nice reading experience.

PS. I left of the triple backticks as requested, hopefully this remains readible. Man page: ptar.1perl Issue 1: ptar → B Issue 2: tar → B(1) Issue 3: perl → B(1) Issue 4: Archive::Tar → BArchive::Tar(3perl)

"ptar is a small, tar look-alike program that uses the perl module " "Archive::Tar to extract, create and list tar archives."

Man page: ptar.1perl Issue: Markup missing B<> for programm name, options and I<> for variables

"\& ptar -c [-v] [-z] [-C] [-f ARCHIVE_FILE | -] FILE FILE ...\n" "\& ptar -c [-v] [-z] [-C] [-T index | -] [-f ARCHIVE_FILE | -]\n" "\& ptar -x [-v] [-z] [-f ARCHIVE_FILE | -]\n" "\& ptar -t [-z] [-f ARCHIVE_FILE | -]\n" "\& ptar -h\n"

Man page: ptar.1perl Issue 1: ARCHIVE_FILE → I<ARCHIVE_FILE>A Issue 2: STDOUT → I<STDOUT> Issue 3: FILE → I<FILE> Issue 4: STDIN → I<STDIN> Issue 5: \(Aq./default.tar\(Aq → I<./default.tar> Issue 6: zlib → B(3) Issue 7: Prints this help message → Prints a help message

"\& c Create ARCHIVE_FILE or STDOUT (-) from FILE\n" "\& x Extract from ARCHIVE_FILE or STDIN (-)\n" "\& t List the contents of ARCHIVE_FILE or STDIN (-)\n" "\& f Name of the ARCHIVE_FILE to use. Default is \(Aq./default.tar\(Aq\n" "\& z Read/Write zlib compressed ARCHIVE_FILE (not always available)\n" "\& v Print filenames as they are added or extracted from ARCHIVE_FILE\n" "\& h Prints this help message\n" "\& C CPAN mode - drop 022 from permissions\n" "\& T get names to create from file\n"

hmartink avatar Nov 16 '25 11:11 hmartink