Man

如何為我自己的電動工具添加手冊頁條目?

  • April 21, 2019

我不知道如何使我自己開發的專業腳本(主要用 Bash 和 Perl 編寫)通過這些man頁面可用。

我必須遵循什麼程序,是否需要編寫特定格式的文件才能執行此操作?

我發現使用Perl 的 POD比直接編寫手冊頁要容易得多,並且您可以使用pod2man實用程序(基本 Perl 包的一部分)從 POD 文件創建手冊頁。由於您的一些執行檔已經用 Perl 編寫,您可以直接將 POD 格式添加到您的腳本中,並且可以直接將它們轉換為 POD 文件。由於 POD 的簡單性,我還看到幾個項目使用 POD 格式,即使它們的程式碼是用其他語言編寫的。

要添加額外的手冊頁目錄,您可以設置$MANPATH環境變數。$MANPATH帶有 a 的前綴:將其添加到已配置的 man 路徑列表中。使用manpath命令查看目前定義的 man 路徑。

引用自:https://unix.stackexchange.com/questions/6891