Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Please provide a man page for ipmitool.py #79

Open
bdrung opened this issue Aug 28, 2020 · 3 comments
Open

Please provide a man page for ipmitool.py #79

bdrung opened this issue Aug 28, 2020 · 3 comments

Comments

@bdrung
Copy link
Contributor

bdrung commented Aug 28, 2020

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
Copy link
Contributor

hthiery commented Aug 28, 2020

Do you have an example how it should look like?

@bdrung
Copy link
Contributor Author

bdrung commented Aug 28, 2020

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
Copy link
Contributor

hthiery commented Aug 28, 2020

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants