-
Notifications
You must be signed in to change notification settings - Fork 329
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 man page; use POD documentation #195
Comments
I like this. PR welcome :) |
I think this is a great idea. We'd definitely welcome either PRs, or feedback on exactly what should be covered in the manpage. I've never used POD or created a manpage. |
You could use Pandoc to convert the README into a manpage, or at least write a manpage in markdown rather than |
I don't have expertise in this area, so I'm willing to accept PRs for this. |
I do all the docs for |
@petdance fantastic. If you're up to writing some POD documentation we'll gladly review it and get it in to the repo. |
I don’t know enough about the tool to write docs. I can help with the POD to manual and HTML conversion.
… On Apr 10, 2019, at 4:19 PM, Scott Baker ***@***.***> wrote:
@petdance fantastic. If you're up to writing some POD documentation we'll gladly review it and get it in to the repo.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or mute the thread.
|
@petdance I've never written POD before. Where is a good starting point? |
POD is like Markdown, just older. You do things like Paragraph-level directives start with |
Is the whole point of POD just to output man pages? |
No, it's also for internal documentation, but I think in this case you're just looking for man pages. Another benefit of using POD, since you're using Perl anyway, is that there is such a rich set of tools in place to process POD. So you can create help on the fly with Pod::Usage, or you can create man pages with |
Please introduce man page and POD documentation.
Man page can be conveniently generated from POD markup using Pod::Usage core module.
Thanks.
The text was updated successfully, but these errors were encountered: