为自定义git命令提供帮助文档的正确方法是什么？

Question

如果我编写一个名为git-foo的脚本，并将其放在PATH中的某个位置，那么我可以运行git foo来执行该脚本并运行git foo --option argument以通过命令行选项和我脚本的参数。

然而，在尝试打印帮助文档时，这种语法糖会崩溃。我已git-foo --help工作，但如果我运行git foo --help，则git不会将--help转发到我的脚本，而是尝试打开man页面git-foo 1}}。我不想要这个。有没有办法抑制自定义命令的这种行为？ （理想情况下，作为脚本作者，但我愿意以某种方式解决这个问题作为用户。）

我怀疑我希望生成一个man页面，但这看起来相当繁重：那么脚本需要与额外的文件一起打包，而额外的文件需要是安装在其他地方，然后在卸载时还有更多工作要撤消。

Answer 1

我认为你被卡住了。 Git故意通过--help页面实现man，以确保存在单一信息源（而不是让手册页偏离与嵌入式帮助输出不同）。

如果您编写man页面，则应该能够将其安装在man目录中，该目录与您安装脚本的bin目录处于同一级别。< / p>

安装和删除单个附加文件似乎太糟糕了。或者你可以坚持使用

git-foo --help

并告诉人们使用它。