macos - 为 Unix 命令提供文档？

Question

我创建了一个名为 macmac2unix 的 Unix 命令，它将 Word 文件从 Mac 转换为 Unix。

如何为我的命令提供文档？我想用 man 阅读我的命令

$man macmac2unix

Answer 1

我推荐Perl 的 POD 格式。尽管有这个名字，但您可以在 Perl 脚本之外使用它，并且pod2man命令随 OS X 一起提供。 troff 更明智。让我想起了 Markdown。

这是一个示例 pod 文档和转换脚本。

Answer 2

您显然也可以使用DocBook为 Unix 命令提供文档。