Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to create man page for ruby gem executable? [closed]

I'm developing a ruby gem, and part of it is a CLI which is installed on the user's system. Is there a way to create a man page for this executable and package it with the gem to be installed?

like image 717
turnerba Avatar asked Oct 20 '25 05:10

turnerba


1 Answers

You would write a manpage for a Ruby executable the same way that you would write a manpage for any other program: write it in some markup language and translate to ROFF or just write it directly in ROFF. There is no way to install manpages from RubyGems (what would it do with that on Windows, for example?) but if you want to ship a manpage, you are presumably on some Unix system anyway, pretty much all of which have package management systems that can take care of that for you. So, for Debian or Debian-derived systems, you would distribute it as a .deb, for RedHat, SuSE or derivatives thereof, you would use an .rpm and so on.

like image 163
Jörg W Mittag Avatar answered Oct 21 '25 22:10

Jörg W Mittag



Donate For Us

If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!