我想为 bash 函数添加文档，以便用户可以使用man. 我的功能和实际命令之间应该没有明显的区别。
我知道我可以通过重写man一个检查我自己的函数的函数来做到这一点。还有其他方法吗？
问问题
446 次
2 回答
3
如果您创建了手册页（这本身就是一项任务），那么您可以将它们放在系统上的某个位置/usr/local/man（或者您喜欢的任何位置），然后编辑系统范围的$MANPATH变量以包含该位置。然后手册页将可用。
于 2011-12-21T10:57:06.817 回答
1
真正的 shell 函数不是由单个man页面记录的，而是由help内置命令记录的。您将不得不覆盖它。但即使我也不会在那里寻找信息。
只需生成普通手册页并将它们放入/usr/local/man/manX或/usr/local/share/man/manX- 您的发行版已经提供的任何内容。检查/etc/manpath.config该目录是否已在此处提及。这样一来，任何人都不必在他们的启动文件中摆弄MANPATH环境变量。
每个手册页还应该包含一个清晰可见的部分，说明这是一个函数而不是命令，以及它们之间的区别。
在那之后，社交部分开始了：在每个场合都告诉每个人该文档。每一个我的意思是每一个，不仅适合。:-)
于 2011-12-21T12:41:27.603 回答