如何为ruby gem可执行文件创建手册页?

时间:2014-08-23 04:36:46

标签: ruby gem rubygems command-line-interface man

我正在开发一个ruby gem,其中一部分是安装在用户系统上的CLI。有没有办法为这个可执行文件创建一个手册页并将其与要安装的gem打包?

1 个答案:

答案 0 :(得分:3)

您可以像编写任何其他程序的联机帮助页一样编写Ruby可执行文件的联机帮助页:使用某种标记语言编写它并转换为ROFF或直接在ROFF中编写它。没有办法从RubyGems安装联机帮助页(例如,它会在Windows上用它做什么?)但是如果你想发布一个联机帮助页,你可能在某些Unix系统上运行,几乎所有这些都有包管理系统可以照顾你的。因此,对于Debian或Debian派生的系统,您将其分发为.deb,对于RedHat,SuSE或其派生词,您将使用.rpm等等。