Re: Issues in man pages of GNU_inetutils

Helge Kreutzmann <[email protected]> Tue, 1 Oct 2024 17:23:52 +0000
Newsgroups	gmane.comp.gnu.inetutils.bugs
Message-ID	<[email protected]>
Hello Erik,
Am Mon, Sep 30, 2024 at 03:08:12PM +0200 schrieb Erik Auerswald:
> On Sun, Sep 29, 2024 at 10:02:30AM +0000, Helge Kreutzmann wrote:
> > 
> > Dear inetutils maintainer,
> 
> While I am not a maintainer of the GNU Inetutils project, I am involved
> in its maintenance.

Thanks for stepping in.

> > the manpage-l10n project maintains a large number of translations of
> > man pages both from a large variety of sources (including inetutils) 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.
> 
> I think that you are attempting to report only "conventions not held up".

We translators see a lot of man pages, and when we note deviations, we
tend to report it. Also we report content issues, but only when they
arise.

For your reference: 
When I notice things, I refer to man-pages(7). I know that some
projects use different styles, e.g. groff. 

If reported issues do to apply, then we can mark them WONTFIX in our
files, so they will not be reported again.

> > I'm now reporting the errors for your project. If future reports
> > should use another channel, please let me know.
> > 
> > Man page: dnsdomainname.1
> > Issue:    -? → B<-?>
> > 
> > "-?, B<--help>"
> 
> The man pages are created using the "help2man" program
> <https://www.gnu.org/software/help2man/>.  help2man seems not to recognize
> "-?" as an option, thus it does not add the "bold" font attribute.
> 
> I'd assume this to be a help2man issue.  I have reported it, together
> with a possible fix, to [email protected].

Thanks!

> > --
> > Man page: rsh.1
> > Issue:    B<info> → B<info>(1)
> > 
> > "The full documentation for B<rsh> is maintained as a Texinfo manual.  If the "
> > "B<info> and B<rsh> programs are properly installed at your site, the command"
> 
> This text is generated by help2man.  It is similar for every man page of
> GNU Inetutils.  Neither help2man nor the man page of the GNU info program
> use section numbers appended to program names.  Thus GNU Inetutils seems
> to already follow the current convention.

Well, section numbers enable hyper links in sufficiently advanced
viewer programms, so this might not be the best convention. However, I
unserstand that this is out of your hands.

Greetings

            Helge
-- 
      Dr. Helge Kreutzmann                     [email protected]
           Dipl.-Phys.                   http://www.helgefjell.de/debian.php
        64bit GNU powered                     gpg signed mail preferred
           Help keep free software "libre": http://www.ffii.de/
signature.asc (application/pgp-signature, 833 B)