search

kontron / python-ipmi

A pure python IPMI library
GNU Lesser General Public License v2.1
187 stars 74 forks source link

Please provide a man page for ipmitool.py #79

Open bdrung opened 4 years ago

bdrung commented 4 years ago

I am packaging python-ipmi for Debian (see https://bugs.debian.org/969146) and it is strongly recommended that all binaries ship a man page. So please provide a man page for ipmitool.py. You could write the man page in reStructuredText and use pandoc to convert it into a man page.

hthiery commented 4 years ago

Do you have an example how it should look like?

bdrung commented 4 years ago

I am not sure about how to exactly format the man page in reStructuredText, but I wrote man pages in Markdown and converted that using pandoc. Last project I did it was https://github.com/bdrung/bdebstrap/blob/master/bdebstrap.1.md and that's how it is rendered then: https://manpages.debian.org/unstable/bdebstrap/bdebstrap.1.en.html

I extended setup.py to call pandoc: https://github.com/bdrung/bdebstrap/blob/master/setup.py

hthiery commented 4 years ago

thank you .. but I dont know if I can provide this on short notice