记录bash函数
发布时间：2020-12-15 21:04:11 所属栏目：安全 来源：网络整理
导读：我想为bash函数添加文档,以便用户可以使用man查找函数.我的函数和实际命令之间应该没有明显的区别. 我知道我可以通过用一个检查我自己的功能的函数来覆盖man来做到这一点.还有另外一种方法吗？ 解决方法 单个手册页不记录真正的 shell函数,而是通过help buil
|
我想为bash函数添加文档,以便用户可以使用man查找函数.我的函数和实际命令之间应该没有明显的区别.
我知道我可以通过用一个检查我自己的功能的函数来覆盖man来做到这一点.还有另外一种方法吗？ 解决方法
单个手册页不记录真正的
shell函数,而是通过help builtin命令记录.你必须覆盖它.但即使我不在那里寻找信息.
只需生成正常的手册页并将它们放入/usr/local/man / manX或/usr/local/share / man / manX – 无论您的发行版已经提供什么.检查/etc/manpath.config是否已在此处提及此目录.这样,没有人必须在他们的启动文件中使用MANPATH环境变量. 每个联机帮助页还应包含一个清晰可见的部分,说明这是一个功能而不是命令,区别在于什么. 在那之后,社交部分开始了：在每个场合告诉每个人关于该文档.每一个我的意思是每一个,不仅适合. （编辑：李大同） 【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容! |