search

noraj / haiti

:key: Hash type identifier (CLI & lib)
https://noraj.github.io/haiti/
MIT License
761 stars 55 forks source link

man page #127

Closed noraj closed 11 months ago

noraj commented 1 year ago

generate a man page and ship it under man/haiti.1

idea for man page in markdown then conversion to troff with pandoc

A better alternative would be to use Ronn ronn-ng

Also I can try cli2man to convert the help message into a manpage but I don't have to much hope. (dead for 9 years, still use python2) An newer alternative is https://github.com/Freed-Wu/help2man.

A nicer alternative would be to use https://github.com/postmodern/kramdown-man

AsciiDoc to manpage

virajsazzala commented 11 months ago

Hello, can you assign this to me?

noraj commented 11 months ago

Hi @virajsazzala, yes, just tell me which method you plan to implement.

virajsazzala commented 11 months ago

Yes, @noraj I've looked into it. I thought of using ronn to make the haiti.1 man page. It's simple and good!

I was wondering, if i should just create the man page or create and write a script to auto install it? something like a install.rb file and add the script to haiti.gemspec

noraj commented 11 months ago

@virajsazzala You can provide the man page in the ronn markdown format and if you want to provide a rake task in https://github.com/noraj/haiti/blob/master/Rakefile to use ronn-ng to convert it to an actual man page and deploy it under man/haiti.1.

virajsazzala commented 11 months ago

@noraj Alright, then I'll make an actual man page -> haiti.1, and deploy it under man/haiti.1. I'll also write a rake task for this.

noraj commented 10 months ago

ronn is old, unmaintained and unreliable

I'm moving to asciidoc to generate man pages which is more powerful, robust, reliable and maintained.