search

fmthoma / vgrep

A pager for grep
BSD 3-Clause "New" or "Revised" License
104 stars 8 forks source link

Create a man page #38

Open Airblader opened 7 years ago

Airblader commented 7 years ago

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

fmthoma commented 7 years ago

@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!

Airblader commented 7 years ago

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. :-)

sjakobi commented 7 years ago

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