记录bash函数

Question

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

我知道我可以通过覆盖man这个函数来检查我自己的函数。有另一种方法吗？

Answer 1

真正的shell函数是而不是由个人man记录，但由内建命令help记录。你将不得不重写。但即使我不会在那里寻找信息。

只要生成正常的手册页并将它们扔进/usr/local/man/manX或/usr/local/share/man/manX - 无论您的发行版已提供。检查/etc/manpath.config该目录已经在那里提及。这样，没有人必须在其启动文件中使用MANPATH环境变量来摆弄它。

每个联机帮助页也应该包含清晰可见的部分解释，这是一个功能而不是命令什么差别。

之后社交部分开始：告诉所有人每关于该文档的场合。通过每我的意思是每，不仅适合。 :-)

Answer 2

如果您有您的帮助页面创建（这本身就是一个任务），那么你可以做的是把他们的地方在系统上像/usr/local/man（或任何你喜欢的，真的），然后编辑系统范围$MANPATH变量以包括该位置。然后手册页将可用。