为Unix命令提供文档？

Question

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

如何为我的命令提供文档？ 我想读一下我与男人的命令

$man macmac2unix

Answer 1

我建议Perl's POD format。尽管名称如此，但您可以在Perl脚本之外使用它，而pod2man命令随OS X一起提供。特洛伊更加明智。让我想起Markdown。

这是example pod document和conversion script。

Answer 2

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