NAME

man - 格式化手冊頁的宏

總覽 SYNOPSIS

groff -Tascii -man file ...

groff -Tps -man file ...

man [section] title

描述 DESCRIPTION

此手冊頁解釋了 groff tmac.man 宏包 (通常叫做 man 宏包) 以及相關的建立手冊頁的慣例。 開發者可以使用這個宏包來為 linux 書寫或移植手冊文件。 它與其他版本的這個宏包一般是相容的，因此移植不是一個大問題 (但是 NET-2 BSD 釋出中使用了一個完全不同的宏包叫做 mdoc，參見 mdoc(7)).

注意 NET-2 BSD mdoc 手冊頁也可以使用 groff 處理，只要指定 -mdoc 選項而不是 -man 選項。推薦使用 -mandoc 選項，因為這樣會自動判斷應當使用哪一個。

導言 PREAMBLE

一篇手冊頁的第一個命令 (註釋行之後) 應當是

注意 BSD mdoc 格式的手冊頁以 Dd 命令開始，而不是 TH 命令

手冊章節傳統上如下定義：

段 SECTIONS

段以 .SH 開始，後跟標題名。如果標題包含空格並且和 .SH 在同一行，則需在標題上加雙引號。 傳統的或建議的標題包括： NAME, 總覽 SYNOPSIS, 描述 DESCRIPTION, 返回值 RETURN VALUE, 退出狀態 EXIT STATUS, 錯誤處理 ERROR HANDLING, 錯誤 ERRORS, 選項 OPTIONS, 用法 USAGE, 示例 EXAMPLES, 檔案 FILES, 環境 ENVIRONMENT, 診斷 DIAGNOSTICS, 安全 SECURITY, 遵循 CONFORMING TO, 注意 NOTES, BUGS, 作者 AUTHOR, 和 參見 SEE ALSO. 在適合使用約定標題的地方，請使用它； 這樣做可以使文章更易讀、易懂。 不過，只要您的標題能夠增加易懂性，請放心使用。 唯一必須的標題是 NAME, 他應是手冊頁的第一段，後面應緊跟對該命令的簡單描述。比如：

其他約定段的內容應為：

總覽 SYNOPSIS

簡要描述命令或函式介面。 對命令，顯示他的命令和引數（包括各種選項）；黑體表示各種引數， 下劃線（或斜體字）表示可以替換的選項； 方括號[]中的是可選項，豎線 | 用於把幾個選項間隔開， 小括號()中的部分可以自動重複。 對函式，顯示需要的資料宣告或需 #include 包含的專案，後跟函式宣告。

描述 DESCRIPTION

解釋命令、函式或格式的用途。 說明其如何與檔案及標準輸入互動，他們的標準輸出及標準錯誤。 必須要指明的細節。描述一般情況。 選項和引數資訊放在 OPTIONS（選項）段。 如果有語法說明和一些複雜的設定， 建議把它們放到 USAGE（用法）段（本段中最好只寫一個概要）。

返回值 RETURN VALUE

列出程式或函式會返回的值，指出引發返回值的條件或原因。

退出狀態 EXIT STATUS

列出可能的退出狀態的值，指出引起返回的程式或原因。

選項 OPTIONS

指出程式可用的選項，及其作用。

用法 USAGE

描述程式的較高階的使用方法。

示例 EXAMPLES

provides one or more examples describing how this function, file or command is used.

檔案 FILES

列出程式或函式使用到的檔案， 比如配置檔案、啟動檔案和程式直接操作的檔案。 給出檔案的絕對路徑， 使用安裝程式調整這些路徑以使其與使用者的實際情況相符。 對大多數程式來說，預設的安裝路徑是 /usr/local， 所以你的檔案要與此一致。

環境 ENVIRONMENT

列出影響你的程式的所有環境變數，並說明影響的原因。

診斷 DIAGNOSTICS

寫出常會出現的錯誤概述，並說明解決的辦法。 你無需解釋系統錯誤資訊或訊號， 除非它們會影響到您的程式。

安全 SECURITY

討論安全問題和相關話題。對應予避免的配置和環境， 可能有安全隱患的命令等等給出警告， 特別是當它們不是很明顯時。 單獨用一段來討論安全並不必要；如果比較好理解的話，把它放在其他段中 （比如 描述 或 用法 段）。但是，最好加上它。

遵循 CONFORMING TO

描述它實現的任何標準或約定

注意 NOTES

提供雜項注意事項

BUGS

列出侷限、已知的缺點或不便之處，還有其他可能存在的問題。

作者 AUTHOR

列出程式或檔案作者，聯絡辦法等。

參見 SEE ALSO

以字母順序列出相關的手冊頁（man pages)。通常來講，這是一個手冊頁的最後一段。

字型 FONTS

雖然在 UNIX 世界中有各種對手冊頁（man pages)的不同約定， 但在 linux 系統下存在一個字型的標準：

對函式，其引數通常用下劃線（或斜體）， 在總覽（SYNOPSIS)中也是這樣 ，其他部分用黑體。 例如

檔名用下劃線（或斜體），例如，.IR "/usr/include/stdio.h" ), 但在總覽（SYNOPSIS)中，包含的檔案用黑體，例如 #include <stdio.h>).

專用宏，一般大寫表示，用黑體（如： MAXINT).

列舉錯誤代號時，代號用黑體（這種列舉通常使用 .TP 宏命令）。

對其他手冊頁的引用（或本頁中某主體的引用）用黑體。 手冊章節號用普通體（如： man(7)). 設定字型的宏命令如下：

.B

黑體

.BI

黑體和下劃線（或斜體）交替（描述函式時非常有用）

.BR

黑體和普通體交替（描述引用時非常有用）

.I

下劃線（或斜體）

.IB

下劃線（或斜體）和黑體交替

.IR

普通體和下劃線（或斜體）交替

.RB

普通體和下劃線（或斜體）交替

.RI

小號字和黑體交替

.SB

小號字和黑體交替

.SM

小號字（用於縮寫）

按照慣例，每個命令最多可以有六個小節的引數， 但是 GNU 去除了這個限制。小節之間以空格隔開。 如果某小節含有空格，則需要給其加上雙引號。 各小節在顯示時無間隔，所以 .BR 命令可以指定一個黑體的詞， 後跟一個普通體的標點。如果命令後無引數，則命令作用於下一行。

其他宏命令和字串 OTHER MACROS AND STRINGS

下面是其他一些相關的宏和預定義的字串。 除非指明，否則所有的宏在本行文字結束時終止。 多數宏使用“流行縮排”（prevailing indent)方式。 “流行縮排”的值由緊跟著宏命令的 i 值指定，如果不指定，那就會使用當前的“流行縮排”值。 這樣，連續的縮排段就可使用相同的縮排值而不需要重新指定。 普通段（不縮排）將“流行縮排”值重值為預設值（0.5 英寸）。 預設時，縮排是有規則的 en(s)：用 en(s) 或者 em(s) 作為縮排的單位， 因為它們會自動地調整字型的大小。 (注：度量距離有不同的單位，當請求需要用到不同的距離時，可以使用預設 型別來修飾數字，度量單位是英寸，釐米，pica,en,em,點，unit和垂直行距。 1pica等於1/6英寸，1em等於字母m的寬度，預設寬度取決於troff中使用 的字型。En是em的一半。) 其他宏命令定義如下：

安全子集 SAFE SUBSET

理論上 man 是一個 troff 宏命令包，實際上很多工具程式沒有支援所有的 man 宏命令。 因此，為了這些程式可以正常工作最好忽略 troff 的一些比較另類的宏。 避免使用各種不同的 troff 預處理程式 （如果必須的話，用 tbl(1) 吧， 但是在建立雙列表時請使用 IP 和 TP 命令）。避免使用計算；大多數其他程式不能處理他。 使用簡單的命令比較容易轉換為其他格式。 下面的宏命令一般認為是安全的（雖然多數時候他們都被忽略了）： \", ., ad, bp, br, ce, de, ds, el, ie, if, fi, ft, hy, ig, in, na, ne, nf, nh, ps, so, sp, ti, tr.

你還可能使用 troff 跳脫字元（這些轉移符號以 \ 開始）。 但你要在文字中顯示反斜線時，用\e。 其他跳脫字元包括： \', \`, \-, \., \", \%, \*x, \*(xx, \(xx, \$N, \nx, \n(xx, \fx, 和 \f(xx. 其中 x、xx 是任意字元，N 是任意數字不要使用跳脫字元來畫圖。

不要隨意使用 bp （break page(中斷頁））。 sp （vertical space(垂直距離）只應使用正值。 不要用 (de) （define（定義）定義與現有的宏同名的宏（無論 man 或 mdoc)； 這種重新定義可能會被忽略。 每個正縮排 (in) 應對應一個負縮排（即使在使用 RS 和 RE 是也不例外）。 The condition test (if,ie) should only have 't' or 'n' as the condition. 可以使用的只有可忽略的轉換 (tr). 改變字型命令 (ft 和 \f 轉義序列) 只能帶如下引數： 1, 2, 3, 4, R, I, B, P, or CW (ft 命令也可以不帶引數)。

如果你是用更多的功能，用各種程式仔細察看一下結果。 如果你肯定某功能是安全的，請告訴我們，以便把他增加到這個列表中。

注意 NOTES

儘量在文字中包含完整的 URL（或URIs）； 一些工具軟體（如： man2html(1) ）能夠自動把它們轉換為超級連結。 您也可用 UR 命令指定連結到相關資訊。 輸入完整的 URL(如：http://www.kernel-notes.org )。

Tools processing these files should open the file and examine the first non-whitespace character. 以(.)或（')開始一行，表明是基於 troff 的檔案（如： man 或 mdoc)。 如果是（<）表明基於 SGML/XML (如：HTML 或 Docbook)． 其他可能是純文字。(例如 "catman" 的結果)

有些 man 以'\"和空格再加字元列開始，表示他的預處理方法。 為了 troff 翻譯器程式處理起來簡單一些， 您僅應使用 tbl(1), 而不是其他什麼東東，Linux 可以檢測到這一點。 不過，你或許想要包含這些資訊以使其可以在其他系統得到處理。 下面是預處理呼叫的定義：

e

eqn(1)

g

grap(1)

p

pic(1)

r

refer(1)

t

tbl(1)

v

vgrind(1)

檔案 FILES

/usr/share/groff/[*/]tmac/tmac.an
/usr/man/whatis

BUGS

大多數宏命令描述的是格式（比如：字型和空格）而不是內容描述（比如： 這段文字指向另外一頁）， 與 mdoc 和 DocBook 正好相反（HTML 也有比較多的內容描述）。 這使得 man 難以轉換為其他形式，不容易與其他檔案組合或自動插入交叉引用。 遵照以上的安全說明，就比較容易在將來把他轉換為其他格式。

The Sun macro TX 下不能用。

作者 AUTHOR S

—

James Clark (jjc@jclark.com) wrote the implementation of the macro package.

—

Rickard E. Faith (faith@cs.unc.edu) wrote the initial version of this manual page.

—

Jens Schweikhardt (schweikh@noc.fdn.de) wrote the Linux Man-Page Mini-HOWTO (which influenced this manual page).

—

David A. Wheeler (dwheeler@ida.org) heavily modified this manual page, such as adding detailed information on sections and macros.

參見 SEE ALSO

apropos(1), groff(1), man(1), man2html(1), mdoc(7), mdoc.samples(7), whatis(1)

[中文版維護人]

RedCandle <redcandle51@chinaren.com>

[中文版最新更新]

2003.11.25

《中國linux論壇man手冊翻譯計劃》:

http://cmpp.linuxforum.net

跋

本頁面中文版由中文 man 手冊頁計劃提供。
中文 man 手冊頁計劃：https://github.com/man-pages-zh/manpages-zh