原文

LFS101x.2 Introduction to Linux (Linux Foundation)

Chapter 06: Finding Linux Documentation

- Section 1: Documentation Sources

- Section 2: The man page

- Section 3: GNU info

- Section 4: Help Command

- Section 5: Other Documentation Sources

1.文檔來源 - (Documentation Sources)

無論你是新手還是老手，你不可能記得所有Linux程序和工具的使用方法，或者該在命令行輸入什麼。你需要定期查看幫助文檔。基於Linux的系統由大量的代碼造就而成，並且存在很多文檔以及獲取幫助的途徑。發行者會合並這些材料，並以一種綜合易用的方式提供給用戶使用。

重要的Linux文檔來源包括：

man pages(手冊頁面(manual pages)的縮寫)
GNU info
help命令以及--help選項
其他文檔來源，例如https://www.gentoo.org/doc/en/

2.man頁面 - (The man page)

1.)man頁面 - (The man page)

man pages是最常使用的Linux文檔。它提供了許多文檔，深入敘述了許多程序以及工具，同時也包括配置文件，系統調用，庫函數以及內核的介紹。輸入man和一個話題名作爲參數，可以在該話題下的man pages中檢索信息。有些Linux發行版需要每一個安裝的程序都有一個對應的man page，可見它的覆蓋之深(Note:man實際上是manual的縮寫)。在19世紀70年代，在早期的UNIX版本中，最先引入man pages結構。

man pages通常轉換成：

網頁
出版的書籍
圖形化幫助
其他格式

2.)man命令 - (man)

man程序搜尋、格式化並且顯示man pages中包含的信息。因爲許多主題有很多信息，輸出會通過terminal pager程序進行管道操作，例如less可以使得一次顯示一頁；同時，信息會被格式化成爲一個良好的視覺顯示。

當沒有給定選項時，默認情況下只能見到一個關於此話題的專門頁面。你可以使用 -f 選項，來顯示所有包含話題字符串的man pages。你可以使用 -k 選項，來顯示所有包含特定主題(儘管這個特定的主題不一定出現在話題字符中)的man pages。

man -f 與whatis 效果一樣；

man -k 與apropos 效果一樣。

3.)手冊章節 - (Manual Chapter)

man pages被分成九個章節(1到9)。有時，一個字母會附加到章節數字後面，用以識別一個特定的話題。例如，部分描述X Window API的頁面對應於章節3X。

章節數可以用來指定man來顯示特定話題的頁面；同一個名字具有多個頁面多個章節是很正常的事情，特別是庫函數或者系統調用的名字。

使用 -a 選項，man可以顯示給定名稱的所有頁面和所有章節，一個接着一個。

$ man 3 printf

$ man -a printf

3.GNU info - (GNU info)

1.)GNU info系統 - (GNU Info System)

下一個Linux文檔來源是GNU Info System。這個是GNU項目的標準文檔格式(info)，可以選擇它來代替man。info系統擁有更加自由的格式，並且支持鏈接的子部分。從功能上說，GNU Info System和man有很多相似之處。然而，話題通過鏈接連接在一起(這個設計早於萬維網)。信息可以通過命令行接口查看，或者通過圖形化幫助工具、打印版本或者在線瀏覽。

2.)命令行info瀏覽器 - (Command Line Info Browser)

在命令行中輸入info可以查看所有可用話題的索引。你可以使用常規的移動按鍵：arrows，Page Up或者Page Down在這些話題中瀏覽。你可以通過輸入 info <topic name> 查看特定話題的幫助信息。然後系統會在所有可用的info文件中搜索這個話題。

有些有用的按鍵：q代表退出，h代表幫助，Enter表示選擇一個菜單單元。

3.)info頁面結構 - (info Page Structure)

你所要看的info頁面上的話題成爲一個節點(node)。節點與書寫文檔的章節和子章節相似。你可以在節點之間移動，並且按順序查看每個節點。每個節點可能包含菜單(menus)和鏈接的子話題，或者名目(items)。

名目(items)可以比較成互聯網的超鏈接。它們通過名目前面的星號(*)得以區分。被命名的名目(在菜單以外的)通過雙冒號(::)得以區分。名目可以指向文件內的其他節點或者其他文件。下表列出了用於在節點之間移動的擊鍵。

4.幫助命令 - (Help Command)

1.)幫助選項簡介 - (Introduction to the help Option)

第三個Linux文檔的來源是使用help選項。大多數命令都有一個短小的表達，在命令或者應用中，使用 --help 或者 -h 選項。例如，想要了解更多的man命令，你可以運行以下命令：

$ man -- help

--help 選項可以作爲一個快速引用的工具，並且它比起man或者info頁面，能夠更快地顯示信息。

2.)關於help命令 - (About the help Command)

當在bash命令shell中運行時，一些常用的命令(例如echo)會運行它們自己內建版本的系統程序和工具，因爲這樣做更有效率（我們將在下一章詳細討論命令shell）。爲了查看這些內建命令的概要，你可以簡單的輸入help。對於這些內置的命令，help命令可以完成和 -h 或者 --help 參數同樣的基礎功能。