- unstable 2.13.2-1
| APROPOS(1) | 手動分頁工具 | APROPOS(1) |
名稱¶
apropos - 搜尋手冊頁名稱與描述
語法¶
apropos [-dalv?V] [-e|-w|-r] [-s list] [-m system[,...]] [-M path] [-L locale] [-C file] keyword ...
描述¶
每個手動分頁都有一個簡短的描述可供使用。apropos 搜尋描述中是否包含 keyword 的執行個體。
keyword 通常是正規表示法,如同使用了 (-r),或者可以包含萬用字元 (-w),或者精確符合關鍵字 (-e)。使用這些選項時,可能需要對 keyword 加上引號或跳脫 (\) 特殊字元,以防止殼層解讀它們。
標準比對規則允許對頁面名稱和描述中的單字邊界進行比對。
apropos 搜尋的資料庫由 mandb 程式更新。根據您的安裝方式,這可能由週期性的 cron 工作執行,或者在安裝新手動分頁後可能需要手動執行。
選項¶
- -d, --debug
- 列印除錯資訊。
- -v, --verbose
- 列印詳盡警告訊息。
- -r, --regex
- 將每個關鍵字解讀為正規表示法。這是預設行為。每個關鍵字將獨立地與頁面名稱和描述進行比對。它可以符合其中任何部分。比對不限於單字邊界。
- -w, --wildcard
- 將每個關鍵字解讀為包含殼層樣式萬用字元的模式。每個關鍵字將獨立地與頁面名稱和描述進行比對。如果同時使用 --exact,則只有當展開的關鍵字符合整個描述或頁面名稱時才會找到比對。否則關鍵字也可以在描述中的單字邊界上進行比對。
- -e, --exact
- 每個關鍵字將精確地與頁面名稱和描述進行比對。
- -a, --and
- 只顯示符合所有提供關鍵字的項目。預設是顯示符合任何關鍵字的項目。
- -l, --long
- 不要將輸出裁剪到終端寬度。通常輸出會被截斷到終端寬度,以避免格式不佳的 NAME 區段產生難看的結果。
- -s list, --sections=list, --section=list
- 只搜尋指定的手動分頁區段。list 是以冒號或逗號分隔的區段清單。如果 list 中的項目是簡單的區段,例如「3」,則顯示的描述清單將包含區段「3」、「3perl」、「3x」等中的頁面;而如果 list 中的項目有延伸,例如「3perl」,則清單只包含手動分頁區段中該確切部分的頁面。
- -m system[,...], --systems=system[,...]
- 如果此系統可以存取其他作業系統的說明頁描述,則可以使用此選項進行搜尋。要搜尋
NewOS
的說明頁描述,請使用選項
-m NewOS。
指定的 system 可以是逗號分隔的作業系統名稱的組合。要包含原生作業系統的 whatis 描述搜尋,請在引數字串中包含系統名稱 man。此選項將覆寫 $SYSTEM 環境變數。
- -M path, --manpath=path
- 指定一組以冒號分隔的替代說明頁階層進行搜尋。預設情況下,apropos 使用 $MANPATH 環境變數,除非它是空的或未設定,在這種情況下它將根據您的 $PATH 環境變數確定適當的手動分頁路徑。此選項覆寫 $MANPATH 的內容。
- -L locale, --locale=locale
- apropos 通常會透過呼叫 C 函式 setlocale(3) 來判斷您的當前語系,它會詢問各種環境變數,可能包括 $LC_MESSAGES 和 $LANG。要暫時覆寫判斷的值,請使用此選項將 locale 字串直接提供給 apropos。請注意,在頁面搜尋實際生效之前,它不會生效。說明訊息等輸出將一律以最初判斷的語系顯示。
- -C file, --config-file=file
- 使用此使用者設定檔,而非預設的 ~/.manpath。
- -?, --help
- 列印說明訊息並退出。
- --usage
- 列印簡短用法訊息並退出。
- -V, --version
- 顯示版本資訊。
結束狀態¶
- 0
- 程式執行成功。
- 1
- 用法、語法或設定檔錯誤。
- 2
- 操作錯誤。
- 16
- 未找到任何符合指定條件的項目。
環境¶
- SYSTEM
- 如果已設定 $SYSTEM,其效果與將指定為 -m 選項的引數相同。
- MANPATH
- 如果已設定
$MANPATH,其值會被解讀為要使用的以冒號分隔的說明頁階層搜尋路徑。
請參閱 manpath(5) 的 SEARCH PATH 區段,了解此環境變數的預設行為和處理方式的詳細資訊。
- MANWIDTH
- 如果已設定 $MANWIDTH,其值會被用作終端寬度(請參閱 --long 選項)。如果未設定,終端寬度將使用 $COLUMNS 的值來計算,如果可用則使用 ioctl(2),或者如果全部失敗則退回使用 80 個字元。
- POSIXLY_CORRECT
- 如果已設定 $POSIXLY_CORRECT,即使是空值,預設的 apropos 搜尋也會是擴充正規表示法 (-r)。如今,這反正就是預設行為。
檔案¶
- /usr/share/man/index.(bt|db|dir|pag)
- 傳統的全域 index 資料庫快取。
- /var/cache/man/index.(bt|db|dir|pag)
- 符合 FHS 的全域 index 資料庫快取。
- /usr/share/man/.../whatis
- 傳統的 whatis 文字資料庫。
請參閱¶
作者¶
Wilf. (G.Wilford@ee.surrey.ac.uk). Fabrizio Polacco (fpolacco@debian.org). Colin Watson (cjwatson@debian.org).
錯誤¶
https://gitlab.com/man-db/man-db/-/issues
https://savannah.nongnu.org/bugs/?group=man-db
| 2026-11-15 | 2.13.2 |