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

如何为ruby gem可执行文件创建手册页?,ruby,gem,rubygems,command-line-interface,manpage,Ruby,Gem,Rubygems,Command Line Interface,Manpage,我正在开发一个RubyGem,其中一部分是安装在用户系统上的CLI。有没有一种方法可以为这个可执行文件创建一个手册页,并将其与要安装的gem打包?您可以为一个Ruby可执行文件编写一个手册页,就像为任何其他程序编写手册页一样:用某种标记语言编写手册页并翻译成ROFF,或者直接用ROFF编写手册页。没有办法从RubyGems安装手册页(例如,在Windows上它会做什么?),但是如果你想发布一个手册页,你可能是在某种Unix系统上,几乎所有的系统都有包管理系统可以为你解决这个问题。因此,对于Deb

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

您可以为一个Ruby可执行文件编写一个手册页,就像为任何其他程序编写手册页一样:用某种标记语言编写手册页并翻译成ROFF,或者直接用ROFF编写手册页。没有办法从RubyGems安装手册页(例如,在Windows上它会做什么?),但是如果你想发布一个手册页,你可能是在某种Unix系统上,几乎所有的系统都有包管理系统可以为你解决这个问题。因此,对于Debian或Debian派生的系统,您可以将其作为
.deb
分发,对于RedHat、SuSE或其衍生物,您可以使用
.rpm
等等。

您特别希望在man中使用它吗?还有其他更流行的格式。我想是的。我习惯于键入“man”并获取几乎所有命令的文档。好奇的是,我为什么要使用另一种格式@sawaThanks!我有点不确定它是如何工作的,这是有道理的。我使用的是OSX,但我可以通过一些软件包管理器来分发它。