Freebsd

mdoc 聯機幫助頁中的部分指的是什麼?

  • January 31, 2021

所以我一直在研究為一個項目編寫手冊頁,最終來到了mdoc 手冊頁。在其中,它描述了聯機幫助頁的常見佈局,包括:

  .\" .Sh CONTEXT
  .\" For section 9 functions only.
  .\" .Sh IMPLEMENTATION NOTES
  .\" Not used in OpenBSD.
  .\" .Sh RETURN VALUES
  .\" For sections 2, 3, and 9 function return values only.
  .\" .Sh ENVIRONMENT
  .\" For sections 1, 6, 7, and 8 only.

但是,我無法弄清楚這些第 1、6、7 和 8 節僅指的是什麼?我最好的猜測是手冊的頁面(例如係統呼叫的第 2 頁),但這沒有多大意義,為什麼返回值不在第 1 頁上?

注意引用的手冊頁實際上是mdoc(7)。這意味著它來自手冊頁集合的第 7 節,即*“Miscellaneous”*。如果所有手冊頁都是整本書,那麼將這些部分視為章節。

這意味著RETURN VALUES如果你想寫一個你想放在第 2、3 或 9 部分的手冊頁,你應該記錄下來。

典型的命令可以在第 1 節中找到,例如ls(1)du(1)(兩者都隨作業系統提供)。但是外部項目通常使用相同的映射,例如postgres(1)mysql(1)。後者是一個不太好的手冊頁範例,因為它沒有引用相關頁面。然後,您最終在網上查找頁面。不要成為那個人!

13.2。用於列舉類別的部分。

完整的(和簡短的)第 13 章。手冊頁可能會提供更高級的介紹,而不是手冊頁。

人們經常錯過的另一個高級頁面是intro(7)。我認為那是man “book”的第一頁。每個部分都有一個介紹每個部分的介紹頁面:

編號 類別

  1. 一般命令
  2. 系統呼叫
  3. 庫函式
  4. 核心介面
  5. 文件格式
  6. 遊戲
  7. 各種各樣的
  8. 系統管理員
  9. 核心開發人員

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