#486 help2man
Closed: Fixed None Opened 4 years ago by raphgro.

help2man should be mentioned as an additional hint in the manpage section of the guidelines, to help upstream generating any manpage or create the patch. The text says already to work with upstream.


Proposal for the additional text:

You can use the tool help2man (link to package in PkgDB) to generate a new manpage from the help output of the packaged program.

For instance if the program name is foo:
help2man -o foo.man --version-string='2.3' ./foo

The version has not to be mentioned explicitly by parameter if the program provides its own. For more information, look into the manpage of help2man.

I suppose I would support adding a few words mentioning help2man (only because we mention another source for manpages) but certainly not three paragraphs.

Counterproposal: change the following sentence:

It is also occasionally possible to find pages created by other distributions; those are often useful as a starting point.

to:

It is also occasionally possible to find pages created by other distributions, or to use the output of the help2man program; those are often useful as a starting point.

We discussed this at this weeks meeting (http://meetbot.fedoraproject.org/fedora-meeting-1/2015-01-08/fpc.2015-01-08-17.01.txt), summary is:

Written up. This is so minor a tweak that I don't think there's any value at all in announcing it.

Another useful tool may be ronn [1]. Ronn is not yet packaged in Fedora.

[1] http://rtomayko.github.io/ronn/

Metadata Update from @james:
- Issue assigned to tibbs

2 years ago

Login to comment on this ticket.

Metadata