Create a man page

Question

Create a man page

Opened this issue 8 years ago · 3 comments

The title is pretty self-explanatory; tools like these definitely should have a man page. :-)

Answer 1 · 2017-01-24T07:35:59.000Z

@Airblader I agree. Since I've never created a man page yet, and since I'm not familiar with the format and the tooling around it, it might take a while for me. Any help would be appreciated!

Answer 2 · 2017-01-24T09:05:21.000Z

The easy answer is to write the raw man file yourself. An example for this is i3lock's man page. But that's a bit bothersome. Another way is this, using asciidoctor and then generating the man page from it. But I'm not familiar with Haskell build system setup.

I assume other Haskell projects have man pages and I'd take inspiration from there. :-)

Answer 3 · 2017-01-24T09:08:37.000Z

pandoc can generate manpages, but I have no experience with that. Here's a short tutorial.