跳至內容

線上手冊

出自Taiwan Tongues 台語維基
這是此頁批准,以及是最近的修訂。

手冊頁(英語:Manual pages,縮寫man page)是佇咧 Unix 抑是類 Unix 作業系統線上軟體文件的一種普遍的形式。 內容包括電腦的程式(包括庫和系統呼叫), 正式的標準佮慣例,甚至是抽象的概念。使用者會當通過執行 ` man ` 命令呼叫手冊頁。

用法

為查閱某一个 Unix 命令的手冊頁,使用者會當佇命令列介面執行如下命令:

比如講,「 man ftp」。 為著方便使用者查閱輸出的資訊,man 命令一般會提供一个 Less 終端分頁器。

照慣例,man 頁面會當按照「程式名 ( 區段 )」的標記來查閱:比如講 ` ftp `。仝款的頁標記可能出現佇咧加個無仝的區段(section)中,譬如講仝款的名佇咧系統呼叫、使用者命令抑是真軟體套件重複出現的時。比如講 ` man ` 佮 ` man `,以及 ` exit ` 佮 ` exit `。

存取非預設手冊頁區段的語法佇無仝的軟體實現中是無仝款的。比如講,佇咧 Solaris 中,閱讀 ` printf ` 的語法為:

佇咧 Linux 佮類 BSD 系統當中,仝款的命令語法為:

這命令佇咧手冊頁的第三區段中搜揣「printf」的資訊。

歷史

《 UNIX 程式設計師手冊》一九七一年十一月初三第一擺出版。一九七一年,佇主管道格拉斯 ・ 麥克羅伊的堅持之下,丹尼斯 ・ 里奇佮肯 ・ 湯普遴編寫了第一份實際意義上的手冊頁。除了手冊頁,《 UNIX 程式設計師手冊》閣組譯一寡簡短的論文,其中一部份攏是教程(比如講 Unix 的一般用法、C 語言,以及 Yacc 等工具), 另外一部份是對作業系統功能的更加詳細的說明。手冊的印刷版上頭仔裝佇一个活頁內底,猶毋過 PWB / UNIX 和 Research Unix 第七版的手冊予人分做兩卷,印刷版的手冊頁成為著第一卷。

手冊頁是用 troff 排版軟體套件排版的,是一組 `-man ` 宏。彼當陣,手冊頁系統帶來的連線文件可用性予人認為這是一項偉大的進步。時到今仔日,差不多所有的 Unix 命令列應用程式攏佮手冊頁的,足濟的 Unix 使用者將欠缺手冊頁看做是低品質應用程式的一个標誌。事實上,有一寡案(如 Debian)無辭勞苦的為欠缺手冊頁的應用編寫手冊頁;四四 BSD 的現代繼任者嘛共手冊頁做系統文件的主要形式之一(將舊的 `-man ` 宏用新的 `-mdoc ` 宏取代)。

強欲無啥物代替品會當像 ` man ` 彼款流行,只有 GNU 計畫的 ` info ` 系統可能是一个例外。 此外,一寡仔 Unix 圖形化使用者介面應用程式(尤其是遐的使用 GNOME 和 KDE 開發環境構建的)這馬提供的 HTML 版本的尾仔使用者手冊,並且包含內嵌的 HTML 閱讀器,如 ` Yelp `,以供閱讀應用程式內底的說明文件。

手冊頁通常是用英文寫的,佇某一寡系統頂懸有可能有翻譯做其他的語言的版本。

手冊頁的預設格式是 troff,使用 man 宏軟體套件(對重展現)抑是 mdoc 宏軟體套件(對重語意)。 會當共手冊頁排版做 PostScript、PDF 佮其他各種格式進行檢視抑是列印。

大多數啦 Unix 系統有一个 man 二 html 命令的軟體套件,該命令允准使用者使用 HTML 瀏覽器瀏覽手冊頁(比如講,FreeBSD 的 textproc / man 二 html,抑無某一寡 Linux 發行版中的 man)。

二空一空年,OpenBSD 宣布淘汰 troff,改用 mandoc 展示手冊頁。

手冊區段

佇咧 Research Unix、BSD、OS X 和 Linux 中,手冊通常予人分做八个區段,安排如下:

Unix System V 是採用類似的編號方案,但是這个順序無仝:

佇某一寡系統內底閣有下述的區段通用:

一寡區段利用字尾進一步幼分矣。譬如講佇一寡系統中,區段三 C 是 C 函式庫呼叫,三 M 是數學(Math)函式庫,等咧。按呢做的結果是區段八(系統管理命令)有時嘛予振動著區段一 M(做命令區段的子區段)。 一寡子區段的字尾有跨區段的一般含義:

布局

所有的手冊頁遵循一个捷看的布局,其為通過簡單的 ASCII 文字展示抑若最佳化,啊若這款的情況下可能無任何形式的突顯或者是字型控制。一般包括以下部份的內容:

NAME(名稱)

該命令抑是函式的名稱,紲落去是一行簡介。

SYNOPSIS(概欲)

對這个命令,正式的講伊按怎執行,猶閣有需要啥物款的命令列參數。對著函式的,介紹函式所需要的參數,以及佗一个標頭檔包含該函式的定義。

DESCRIPTION(說明)

命令抑是函式功能的文字描述。

EXAMPLES(範例)

定用的一寡範例。

SEE ALSO(參見)

相關命令抑是函式的列表。

嘛有可能存在其他的部份的內容,毋過遮的部份無得著跨手冊頁的標準化。捷看的例包括:OPTIONS(選項), EXIT STATUS(登出狀態), ENVIRONMENT(環境), BUGS(程式漏洞), FILES(檔案), AUTHOR(作者), REPORTING BUGS(已知空隙), HISTORY(歷史)和 COPYRIGHT(著作權)。

使用線上手冊頁

參考:archlinux 社群的使用線上手冊頁

參見

  • Unix 實用程式列表
  • 九號計劃應用程式列表
  • info ( Unix )
  • RTFM
  • ManOpen-NeXT / OS X 圖形化 man 實用程式

參考文獻

外部連結

  • History of UNIX Manpages for a primary-source history of UNIX manpages .