记录bash函数

时间:2011-12-21 10:53:58

标签: bash man

我想为bash函数添加文档,以便用户可以使用man查找函数。我的函数和实际命令之间应该没有明显的区别。

我知道我可以通过使用检查我自己的函数的函数覆盖man来做到这一点。还有另一种方式吗?

2 个答案:

答案 0 :(得分:3)

如果您创建了手册页(这本身就是一项任务),那么您可以做的就是将它们放在系统的某个位置,如/usr/local/man(或者您喜欢的任何地方,真的),然后编辑系统 - 宽$MANPATH变量以包含该位置。然后可以使用手册页。

答案 1 :(得分:1)

真正的shell函数由单个man页面记录,但由help内置命令记录。你必须覆盖它。但即使我不在那里寻找信息。

只需生成普通的手册页并将其放入/usr/local/man/manX/usr/local/share/man/manX - 无论您的发行版已提供什么。检查/etc/manpath.config是否已在此处提及此目录。这样,没有人必须使用MANPATH环境变量来调整其启动文件。

每个联机帮助页还应包含一个清晰可见的部分,说明这是函数而不是命令,区别在于。

之后,社交部分开始了:在每个场合向每个人讲述该文档。通过每个我的意思是每个,而不仅仅是合适的。 : - )