Scroll to navigation

LEXGROG(1) 手動分頁工具 LEXGROG(1)

名稱

lexgrog - 剖析 man 頁面的標頭資訊

語法

lexgrog [-m|-c] [-dfw?V] [-E encoding] file ...

描述

lexgrog 是傳統 “groff guess” 工具在 lex 中的實作。它讀取其命令列上的檔案清單作為 man 頁面源檔案或預先格式化的 “cat” 頁面,並顯示它們的名稱和描述(如同 apropos 和 whatis 所使用的),以及 man 頁面在傳遞給 nroff 或 troff 之前所需的預處理篩選器清單,或者兩者都顯示。

如果其輸入格式不正確,lexgrog 將顯示 “parse failed”;這對於需要檢查 man 頁面正確性的外部程式可能很有用。如果 lexgrog 的輸入檔案之一是 “-”,它將從標準輸入讀取;如果有任何輸入檔案被壓縮,將自動讀取解壓縮的版本。

選項

列印除錯資訊。
將輸入剖析為 man 頁面源檔案。如果未指定 --man 或 --cat,這是預設值。
將輸入剖析為預先格式化的 man 頁面 (“cat pages”)。--man 和 --cat 不可同時指定。
顯示 man 頁面標頭中的名稱和描述(如同 apropos 和 whatis 所使用的)。如果未指定 --whatis 或 --filters,這是預設值。
顯示在使用 nroff 或 troff 格式化之前預處理 man 頁面所需的篩選器清單。
覆寫頁面猜測的字元集為 encoding。
-?, --help
列印說明訊息並退出。
列印簡短用法訊息並退出。
顯示版本資訊。

結束狀態

0
程式執行成功。
1
用法錯誤。
2
lexgrog 無法剖析一或多個輸入檔案。

範例


$ lexgrog man.1
man.1: "man - an interface to the system reference manuals"
$ lexgrog -fw man.1
man.1 (t): "man - an interface to the system reference manuals"
$ lexgrog -c whatis.cat1
whatis.cat1: "whatis - display manual page descriptions"
$ lexgrog broken.1
broken.1: parse failed

WHATIS 剖析

mandb(使用與 lexgrog 相同的程式碼)剖析每個手動分頁頂部的 NAME 區段,尋找每個分頁中記錄的功能名稱和描述。雖然剖析器相當寬容,因為它必須處理歷史上使用的多種不同形式,但它有時可能無法擷取所需的資訊。

使用傳統的 man 巨集集時,正確的 NAME 區段大致如下:

.SH NAME
foo \- program to do something

某些手動分頁器要求 ‘\-’ 必須如所示;mandb 較為寬容,但為了與其他系統相容,保留反斜線仍是個好主意。

左側可以有多個名稱,以逗號分隔。包含空白字元的名稱將被忽略,以避免在某些格式不佳的 NAME 區段上出現病態行為。右側的文字是自由格式,可以跨越多行。如果同一手動分頁中記錄了多個具有不同描述的功能,則使用以下格式:

.SH NAME
foo, bar \- programs to do something
.br
baz \- program to do nothing

(開始新段落的巨集,如 .PP,可用來代替換行巨集 .br。)

使用 BSD 衍生的 mdoc 巨集集時,正確的 NAME 區段大致如下:

.Sh NAME
.Nm foo
.Nd program to do something

whatis 剖析失敗的常見原因有幾個。有時手動分頁的作者將 ‘.SH NAME’ 替換為 ‘.SH MYPROGRAM’,然後 mandb 就無法找到要從中擷取所需資訊的區段。有時作者包含 NAME 區段,但放置自由格式的文字而非 ‘name \- description’。然而,任何類似上述的語法都應被接受。

請參閱

apropos(1), man(1), whatis(1), mandb(8)

注意事項

lexgrog 嘗試剖析包含 .so 要求的檔案,但只有在檔案正確安裝在手動分頁階層中時才能正確剖析。

作者

lexgrog 用來掃描 man 頁面的程式碼是由:

Wilf. (G.Wilford@ee.surrey.ac.uk).
Fabrizio Polacco (fpolacco@debian.org).
Colin Watson (cjwatson@debian.org).

Colin Watson 撰寫了命令列前端的目前版本,以及此 man 頁面。

錯誤

https://gitlab.com/man-db/man-db/-/issues
https://savannah.nongnu.org/bugs/?group=man-db

2026-11-15 2.13.2