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

Question

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

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

Answer 1

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

• 您可以手写。
• 您可以使用help2man从脚本的帮助输出生成它。
• 您可以用标记语言编写它，并使用专用工具将其转换为 man：
  • a2x（来自阿斯西多克包）用于ASCII文档
  • grutatxt为了格鲁塔文本
  • pod2man（来自珀尔包）用于荚
  • rst2man（来自文档包）用于重构文本
  • txt2tags为了txt2标签
  • 曼塔斯蒂克（Heroku 网络服务）降价

Answer 2

是的你可以。手册页写为诺夫文件。
/usr/local/man 目录通常用于任何本地安装的包/文件的位置。
您可以通过查看现有的联机帮助页来查看示例（可能需要首先解压缩），还可以阅读男人。
目前，许多用户更喜欢 groff 而不是 nroff，man groff以开始使用