Scroll to navigation

man(1) General Commands Manual man(1)

NAME

man - 格式化並顯示在線幫助手冊頁
 
manpath - 定義使用者查找man手冊頁的路徑

總覽

man [-acdfFhkKtwW] [-m 系統名] [-p <前處理程式>] [-C <配置檔案>] [-M <路徑>] [-P <瀏覽方式>] [-S <區段清單>] [區段名稱] 幫助主題 ...

描述

man 格式化並顯示在線幫助手冊頁面。此版本支持 MANPATH(MAN)PAGER 環境變量,因此,你可以擁有你自己的一系列 man 手冊頁並決定使用哪個程式來顯示此格式的頁面。如果定義了區段, man 將只查找在指定區段內的文件。你也可以通過命令行或環境變量來指定查找區段 的順序和預定義將要執行的程式。如果主題中有“/”符號,則將其作為檔名的一部分處理 ,也就是說你可以用 man ./foo.5 也可以用 man /cd/foo/bar.1.gz 來查看各man 文件。

選項

-C 配置檔案
定義man.conf供使用;預設使用的是 /etc/man.config 。(參見 man.conf(5))。
-M 路徑
定義一組查找man手冊頁的目錄。如果沒有指定此參數,系統環境變量 MANPATH將被使用。 如果查無到此環境變量,則按預設 /etc/man.config 檔案中指定的查找。一個空的 MANPATH 子字 符串表示使用預設清單。
-P 瀏覽方式
定義瀏覽的方式。此選項將覆蓋 MANPAGER 環境變量(此變量將覆蓋 PAGER 變量)。若不指定 此參數,則使用 MANPAGERPAGER 環境變量中的設置。此選項的預設的顯示方式為 /usr/bin/less-is。
-S 區段清單
該清單是一組用冒號分隔的欲查找的手冊清單。此選項將覆蓋 MANSECT 環境變量。 有些指令或程式可能有一個以上的主題,它們位於不同的區段中。因此,要查看較後的區 段,你可以在此指定 man 查找區段的順序。具體區段劃分如下所示:
區段1:使用者指令
 
區段2:系統調用
 
區段3:程式庫調用
 
區段4:設備
 
區段5:檔案格式
 
區段6:遊戲
 
區段7:雜項
 
區段8:系統指令
 
區段9:核心內部指令
 
區段n:Tcl或Tk指令
-a
預設情況下,man在顯示完每一個所查到的man手冊頁時會自動退出程式。而使用此選項 ,則可使man顯示所有與此主題相匹配的手冊頁內容,而不僅僅是第一項。
-c
即使已存在最近已排版過的幫助檔案(即以前曾查詢過該主題的幫助文件),使用該參 數後仍會再次執行一次排版操作。此參數適用於已排版過的幫助檔案已損壞或螢幕的行列數有 改變時。
-d
不顯示幫助文件的具體內容,只顯示調試排錯信息。
-D
既顯示幫助文件內容,同時又顯示調試排錯信息。
-f
相當於運行whatis 的操作。即:顯示工具指令與工具程式的簡單說明。
-F" 或 --preformat
只進行格式化操作,而不真正的顯示出來。
-h
顯示man的語法和參數說明,執行完成後退出程式。
-k
查當於使用 apropos 命令。
-K
在所有的幫助檔案中查找包含有指定關鍵字的幫助文件。此操作可能很慢,所以在使用 此參數時最好配合-s 的參數來查找指定區段。(這只是一個粗略的概念,在作者本人的機器 上每分鐘可查500個man文件。)
-m
系統名 定義所要查找的man文件所屬的系統名。
-p
字串 定義在排版幫助檔案這前所要執行的預處理程式的次序。不是所有的安裝都有完整預處理 程式組。一般有6個預處理程式,它們是:eqn(e)、grap(g)、pic(p)、tbl(t)、vgrind(v)和 reger(r)。此參數將覆蓋環境變量MANROFFSEQ。
-t
使用 /usr/bin/groff - Tps - mandoc 來排版man手冊頁,並輸出到標準輸出。從 /usr/bin/groff - Tpa - madoc 輸出的內容可能需要某些其它過濾才能真正輸出到標準輸出列印。
-w" 或 --path
不顯示幫助文件的具體內容而只顯示相應幫助主題檔案的位置。如果沒有給定參數,則將 在標準輸出顯示一組由man所查到的相匹配的man 文件所在目錄。如果命令manpath是一個到m an的鏈接,那麼執行“manpath”就相當於執行“man --path”。
-W
相當於-w參數,但所顯示的內容以分行方式顯示。此參數方便其它指定或程式對其輸出 做進一步處理,如: man -aW man | xargs ls -l

CAT頁

Man 會試著對所查的文件進行保存,為的是便於下次使用此幫助頁時可節約格式化時間。傳 統上,被格式化的DIR/manX文件會被存儲在DIR/catX中,但你可以在 /etc/man.config 配置文 件中指定其它的目錄。如果所需的cat目錄不存在時,系統就不對格式化後的man文件進行保存 。
對於使用man命令的人,man命令可能對其進行setuid的操作。因此,如果一個cat目錄屬於 man並且其模式是0755(只有man對其有寫的權限),而且,cat檔案也屬於man和其模式是064 4或0444(只有man對其有寫權限或根本就沒有寫權限),則普通用就不能更改cat文件頁,也 不能在此目錄中存放其它檔案。而如果man沒有執行setuid的操作,那麼,為了能使所有使用者 都能存放cat頁到cat目錄,則必須將這個cat目錄設置成0777模式。
參數 -c 可以強制生成一個新的man頁,既使已經有一個cat頁存在。

環境變量

MANPATH
如果 MANPATH 有定義,那麼它的值將在查找man文件頁時做為搜索路徑來使用。
MANROFFSEQ
如果 MANROFFSEQ 有定義,則此變量的值將用來決定在nroff或troff執行前將要執行的預處 理程式的次序。預設情況下,手冊頁會在nroff處理前選取進行表格處理。
MANSECT
如果 MANSECT 有定義,它的值將決定man有搜索時的查找區段。
MANWIDTH
如果MANWIDTH有定義,它的值將決定顯示man手冊頁時的寬度。否則,將是以全屏的方式來 顯示。
MANPAGER
如果 MANPAGER 有定義,它的值將指定用來顯示man文件的程式。如果沒有在此指定,那麼將 使用由PAGER變量指定的程式。如果還是沒有指定,那麼會預設使用/usr/bin/less -is 。
LANG
如果 LANG 有定義,它的值將指定man在查找文件時首先查找的子目錄。因此,命令“LAN G=dk man 1 foo”會使man在查找man頁時首先查找../dk/man1/foo.1,如果在其中沒有找到相 關文件,則查找../man/foo.1,此目錄是由查找路徑指定的。
NLAPATH,LC_MESSAGES,LANG
環境變量 NLAPATHLC_MESSAGES (或當後一個不存在時使用 LANG )充當了定位文件目錄的 角色。(但英文信息是編譯進命令的,所以針對英文而言,就沒有目錄存在)。注意,像col (1)這樣被man調用的程式也使用像 LC_CTYPE 這樣的變量。
PATH
變量 PATH 是在解釋查找man手冊頁路徑時使用的。
SYSTEM
變量 SYSTEM 是用來得到預設的系統名(用-m參數可以得到同樣的效果)。

另見

apropos(1),whatis(1),less(1),groff(1).
 

BUGS

選項 -t 只能使用在裝有類troff程式的環境中。 如果在你的顯示中出現高亮度的255或<AD>這樣的字符而不是連字符,請在你的配置檔案中 寫入“LESSCHARSET=latin1”這樣的環境變量。

技巧

如果你在你的 .emacs 檔案中加入(global-set-key[(f1)](lambda()(interactive)(manuale ntry(current-word))))這一行,則當你按F1鍵時會自動跳出當前滑鼠指向的相應程式的man手冊頁。
 

[中文版維護人]

徐明 <xuming@users.sourceforge.net>
譯者:
所羅門 <solomen@email.com.cn>

[中文版最新更新]

2003/05/13 第一版

《中國Linux論壇man手冊頁翻譯計劃》

http://cmpp.linuxforum.net
September 2, 1995