Linux Lexicon — 手冊頁剖析

頁面通常分為一系列部分，詳細說明名稱和描述，以及用法和注意事項。 手冊頁可能難以閱讀，但它們是可以在緊要關頭利用的寶貴資源，甚至不需要互聯網。

姓名
首先是名稱標題，這就是總結。 此部分包括實用程序的名稱以及簡要說明。

概要
從手冊頁到手冊頁有不同程度的可讀性，但有一件事是肯定的，最難的部分通常是破譯一個毛茸茸的概要。 有幾種約定可以指示任何給定命令所需的信息片段。 這些約定由不同的括號和括號以及其他形式的符號組成。 所有這些不同的約定對於初學者來說可能會非常混亂，對於經驗豐富但不精通手冊藝術的人來說仍然令人生畏。 下面我們將把這些亂七八糟的東西分解成易於理解的規則。

這些規則相當簡單，但當它們用於長函數定義時，尤其是嵌套時，它們變得更加困難，甚至令人生畏。 所以，我們將看看下面的一些嵌套，以建立我們已經分解的內容。

焦油{A|c|d|r|t|u|x}[GnSkUWOmpsMBiajJzZhPlRvwo] [ ARG …]

tar命令有很多選項。 我們看到 tar 命令的名稱以粗體顯示，因為它應該按所示輸入。 然後我們看到括號以管道分隔的選項打開，這表明我們僅限於這些選項，並且必須只選擇一個。 接下來是可選標誌，我們可以使用任何數字，但是，它們可能不會一起工作，進一步閱讀手冊頁將闡明任何潛在的選項衝突。 最後，我們有可重複的參數，在 tar 的情況下，您正在操作的文件。

su [選項] [-] [用戶[參數...]]

同樣，我們看到su粗體，因為它是命令的名稱。 其次，我們看到實際上沒有指定任何標誌，只是它們是可選的。 第三，指定了一個標誌，但它也是可選的。 最後，我們看到一個可選參數在可選參數中是可重複的。 現在，過去看起來很神秘的東西變得更有意義了。

whois [{-h|–host } HOST ] [{-p|–port} PORT ] [-abBcdGHKlLmMrRx] [-g SOURCE:FIRST-LAST ] [-i ATTR [, ATTR ]…] [-s SOURCE [, SOURCE ]…] [-T TYPE [, TYPE ]…] [–verbose]對象

這是一個特別密集的。 將其複製到您最喜歡的文本編輯器中，並在其中添加一些額外的空格，如果它有助於您閱讀它。 掃描完後，您應該開始看到幾個模式。 主機和端口部分對選項的短格式和長格式使用相同的格式，後跟該選項的參數，而兩者本身都是可選的。 然後我們看到可選標誌的字符串。 關於從頭到尾的源代碼的下一點是 whois 預期的語法，稍後將在手冊頁中解釋。 現在我們看到了這三組可選標誌，它們要么採用單個參數，要么採用可選的重複參數，這是一種最初很難完全掌握的約定的複合。 最後是詳細選項和對象（主機/域）。

這就是閱讀手冊頁概要的方法。 還有一些其他的約定，但是它們太晦澀了，無法在本文中介紹。

描述
這通常是概述程序或實用程序的預期用途的地方。 在這個標題下，一些手冊會比其他手冊詳細得多。

選項
還記得所有那些可能是可選的或強制的標誌和不同的參數嗎？ 這就是他們都得到解釋的地方。 這里通常有很好的信息，並且您通常會在其中找到 <argument> 約定，表明給定標誌需要相應的參數。 有時您會發現選項位於描述部分，因為沒有硬性規則定義手冊頁，只有約定和遵守標準的意願。

例子
這是最方便的部分之一，遺憾的是未包含在所有手冊中。 您還會發現信息量和示例數量差異很大，並且並非所有示例實際上都有助於使用該命令。

此外，您會定期找到作者、版權信息、錯誤報告等部分，另請參閱 (apropos)。

除此之外，還有正式定義的手冊頁部分，定義如下。

許多命令在多個部分中沒有手冊，但對於那些有手冊的，或者對於一些可能命名不明確的命令，您可以像下面的示例一樣指定該部分。

從可用部分可以看出，命令並不是唯一具有手冊的東西。 系統調用、配置文件和特殊設備也可能有相應的手冊頁。 手冊頁中關於典型 Linux 安裝的信息量是驚人的，這同樣適用於其他開源的類 UNIX 操作系統。

如果您發現手冊頁不夠用並且您仍然不了解命令，請始終在線查看，因為許多人對某些工具提供了更全面的解釋，而且許多發行版都有自己的手冊頁，用於不同的軟件包。 一旦您發現自己對某個軟件感到滿意，但仍然覺得缺少手冊，您可以隨時通過編寫自己的軟件並提交給相應的項目來做出貢獻。 文檔往往是軟件項目中最容易被忽視的部分，因此即使不會編寫代碼，也可以編寫手冊、Wiki 文章和教程來幫助他人。

既然您了解了手冊頁的結構，那麼您就沒有任何藉口了，只能使用 RTFM（這是為 18 歲以下的人閱讀的免費手冊）；）

另請閱讀： Linux 詞典：使用 Watch 命令每 X 秒運行一次命令