如何为Ruby宝石可执行文件创建man手册？

Question

如何为Ruby宝石可执行文件创建man手册？

rubyrubygemscommand-line-interfacemanpage

4

我正在开发一个 Ruby 宝石（gem），其中的一部分是 CLI，可以安装在用户的系统上。是否有办法为此可执行文件创建 man 手册，并将其与宝石一起打包以便安装？

- turnerba

你特别想要man格式吗？还有其他更流行的格式。 - sawa

1

我也这么认为。我习惯于输入“man <command>”并获取几乎任何命令的文档。好奇，为什么我要使用另一种格式？@sawa - turnerba

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Jörg W Mittag · Accepted Answer

您可以像为任何其他程序编写手册页一样为Ruby可执行文件编写手册页：使用某种标记语言编写并将其翻译为ROFF，或直接在ROFF中编写。无法从RubyGems安装手册页（例如，在Windows上会发生什么？），但是如果您想要发布手册页，则可能在某些Unix系统上，几乎所有这些系统都有软件包管理系统可以为您处理这个问题。因此，对于Debian或派生自Debian的系统，您将其分发为.deb，对于RedHat、SuSE或其衍生产品，您将使用.rpm等。