手冊頁的概要部分有規範嗎？

Question

我嘗試寫一些規格小團隊和越來越挑剔，我把一些命令列表格式之間進行共享。是否有手冊頁的概要部分使用的語法的任何正式定義是什麼？

從維基共享資源，這裏有概要部分我說的是，在該命令列出必需和可選的參數它理解手冊頁的例子。

Answer 1

有一個手冊頁沒有正式的定義，任何地方，甚至沒有在POSIX標準。該man(1)手冊頁在你的例子是非常典型：你寫出來的各種方法，可以使用的程序（通常只有一個）與[]表示可選的，大膽的（或打字機字體與mdoc宏）表示文字的命令行輸入和斜體表示變量。

的聯機幫助頁man(7)和mdoc(7)將解釋最重要的公約。 man(7)適用於舊式的Unix手冊，在Linux上仍然很流行（請參閱man-pages(7)）; mdoc(7)來自4.4BSD並且在其衍生產品中很受歡迎。後者保持內容和表示的更加嚴格的分離，並且可以生成（IMHO）更漂亮的PDF/HTML輸出

Answer 2

實用程序的實用程序約定記錄在Chapter 12. Utility conventions of the IEEE Std 1003.1, 2004 Edition中。

本文檔的較新版本存在here

Answer 3

人7人：

簡要介紹了命令或函數的接口。對於命令， 顯示命令及其參數的語法（包括 選項）; 粗體用於原文，斜體用於 表示可替換的參數。括號（[]）圍繞可選 參數，豎線（|）分開選擇，省略號（...）可以 重複。對於函數，它示出任何需要的數據聲明 或#include指令，後跟函數聲明。