我需要為 C 庫編寫手冊頁嗎？

我為 Linux 和 FreeBSD 編寫了一個小型 C 庫，我將為它編寫文件。我試圖了解有關創建手冊頁的更多資訊，但沒有找到為庫製作手冊頁的最佳實踐的說明或描述。特別是我對放置函式手冊頁的哪個部分感興趣？3? 也許有很好的例子或手冊？為庫中的每個函式創建手冊頁是個壞主意嗎？

圖書館的手冊頁將在第 3 節中。

對於很好的手冊頁範例，請記住有些是使用 groff 的特定細節編寫的和/或使用不是真正可移植的特定宏。

手冊頁的可移植性總是存在一些缺陷，因為某些系統可能（或可能不）使用特殊功能。例如，在編寫文件dialog時，我必須記住（並解決）用於顯示範例的各種系統的差異（這是不合理的）。

首先閱讀man man它提到標準宏的相關部分，然後比較FreeBSD 和 Linux 的這些描述。

您是選擇為庫編寫一個手冊頁，還是為函式（或函式組）編寫單獨的手冊頁，取決於函式描述的複雜程度：

• ncurses在幾十個手冊頁中有幾百個函式。
• 對話框在一個手冊頁中有幾十個功能。其他人肯定會展示更多範例。

進一步閱讀：

• man – 顯示線上手冊文件頁面(FreeBSD)
• man-pages - 編寫 Linux 手冊頁的約定
• groff_mdoc – groff 的 mdoc 實現參考
• HowTo：從頭開始創建聯機幫助頁。(FreeBSD)
• 什麼是“自行車棚”？

引用自：https://unix.stackexchange.com/questions/266179