我可以为脚本创建手册页吗？

Question

可能的重复：
如何为我自己的电动工具添加手册页条目？

大多数（如果不是全部）Linux 命令都有描述其使用选项等的手册页。我可以为我自己的 bash 脚本创建类似的手册页吗？

Answer 1

手册页是 roff（请参阅man 7 roff）格式的文档。

• 你可以手写。
• 您可以使用help2man从脚本的帮助输出中生成它。
• 您可以用标记语言编写它并使用专用工具将其转换为 man：
  • a2x（来自asciidoc包）用于AsciiDoc
  • grutatxt对于Grutatxt
  • pod2man（来自perl包）用于POD
  • rst2man（来自docutils包）用于reStructuredText
  • txt2tags对于txt2tags
  • 用于Markdown 的Mantastic（Heroku Web 服务）