我可以為腳本建立手冊頁嗎？

Question

可能的重複：
如何為我自己的電動工具添加手冊頁條目？

大多數（如果不是全部）Linux 指令都有其手冊頁來描述其使用選項等。

Answer 1

手冊頁是 roff（請參閱 參考資料man 7 roff）格式的文件。

• 您可以手寫。
• 您可以使用help2man從腳本的幫助輸出產生它。
• 您可以用標記語言編寫它，並使用專用工具將其轉換為 man：
  • a2x（來自阿斯西多克包）用於ASCII文檔
  • grutatxt為了格魯塔文本
  • pod2man（來自珀爾包）用於莢
  • rst2man（來自文件包）用於重構文本
  • txt2tags為了txt2標籤
  • 曼塔斯蒂克（Heroku 網路服務）降價

Answer 2

是的你可以。手冊頁寫為諾夫文件。
/usr/local/man 目錄通常用於任何本地安裝的套件/檔案的位置。
您可以透過查看現有的線上說明頁面來查看範例（可能需要先解壓縮），也可以閱讀男人。
目前，許多用戶更喜歡 groff 而不是 nroff，man groff以開始使用