記錄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變量以包括該位置。然後手冊頁將可用。