Man pages for each binary/script

Asked by Jeffrey Ness on 2011-03-07

Hello everyone,

I want to see if you would consider adding Man pages for each binary/script in this module.

I am working to building an RPM for your software and getting it submitted to EPEL (http://fedoraproject.org/wiki/EPEL), however one of the packaging guidelines ask for a Man pages for each binary/script:

http://fedoraproject.org/wiki/PackagingGuidelines#Man_pages
---

As you can see there are a number of perl scripts you have installed in /usr/bin without man pages:

mysql-sandbox.noarch: W: no-manual-page-for-binary sbtool
mysql-sandbox.noarch: W: no-manual-page-for-binary make_sandbox_from_installed
mysql-sandbox.noarch: W: no-manual-page-for-binary make_sandbox
mysql-sandbox.noarch: W: no-manual-page-for-binary test_sandbox
mysql-sandbox.noarch: W: no-manual-page-for-binary make_multiple_custom_sandbox
mysql-sandbox.noarch: W: no-manual-page-for-binary msandbox
mysql-sandbox.noarch: W: no-manual-page-for-binary low_level_make_sandbox
mysql-sandbox.noarch: W: no-manual-page-for-binary sb
mysql-sandbox.noarch: W: no-manual-page-for-binary make_sandbox_from_source
mysql-sandbox.noarch: W: no-manual-page-for-binary make_multiple_sandbox
mysql-sandbox.noarch: W: no-manual-page-for-binary make_replication_sandbox
--

Thanks for your time
Jeffrey-

Question information

Language:
English Edit question
Status:
Answered
For:
MySQL Sandbox Edit question
Assignee:
No assignee Edit question
Last query:
2011-03-07
Last reply:
2011-03-07

Hi Jeffrey,
Thanks for setting up the task of making RPMs.

I realize that there should be man pages for each tool. The man pages currently available are automatically created for each module using the POD documentation.
I believe that the easiest way of implementing man pages would be to include the appropriate POD in each tool and let the installed generate the man pages.
Is that correct? Or are there better options?

Cheers

Giuseppe

Jeffrey Ness (jeffrey-ness) said : #2

Giuseppe,

You are very welcome. We have a few DBAs here asking for the software packaged and we thought getting it to the wider community via EPEL was the best choice.

Unfortunately I know close to nothing when it comes to Perl, I doubt I will have a good answer for you when it comes to creating additional man pages via the Perl POD module.

Thanks
Jeffrey-

Jeffrey,
I will look into it.
In the meantime, a quick way of installing MySQL Sandbox without a .RPM is

# (logged in as root)
# cpan MySQL::Sandbox

Cheers

Giuseppe

Jeffrey Ness (jeffrey-ness) said : #4

Thanks

Can you help with this problem?

Provide an answer of your own, or ask Jeffrey Ness for more information if necessary.

To post a message you must log in.