| MANPATH(5) | /etc/manpath.config | MANPATH(5) |
名稱¶
manpath - /etc/manpath.config 檔案的格式
描述¶
manpath 設定檔供手動分頁工具在執行時評估使用者的 manpaths,指示哪些手動分頁階層(manpaths)應視為系統階層,並為其指定用於儲存 cat 檔案的目錄。
如果環境變數 $MANPATH 已設定,/etc/manpath.config 中包含的資訊不會覆寫它。
搜尋路徑¶
預設情況下,man-db 檢查使用者的 $PATH。對於找到的每個 path_element,它會將 manpath_element 新增到搜尋路徑。
如果設定檔中給定的 path_element 沒有 MANPATH_MAP 列,則它會將所有以目錄形式存在的 path_element/../man、path_element/man、path_element/../share/man 和 path_element/share/man 新增到搜尋路徑。
然後它將設定檔中的任何 MANDATORY_MANPATH 項目新增到搜尋路徑。
最後,如果使用 --systems 選項或設定了 $SYSTEM 環境變數,則應包含以逗號或冒號分隔的作業系統名稱序列。這作為模板,再次擴展搜尋路徑以允許存取其他作業系統的手動分頁:對於每個系統名稱,man-db 會在搜尋路徑的每個項目中尋找該名稱作為子目錄,如果存在,則將其新增到最終搜尋路徑。系統名稱 man 會插入不含子目錄的正常搜尋路徑。例如,如果搜尋路徑原本會是 /usr/share/man:/usr/local/man,而 $SYSTEM 設定為 newOS:man,則最終搜尋路徑會是 /usr/share/man/newOS:/usr/share/man:/usr/local/man。
$MANPATH 環境變數會覆寫 man-db 的預設手動分頁搜尋路徑。大多數使用者不需要設定它。其語法類似於 $PATH 環境變數:它由以冒號分隔的目錄名稱序列組成。它會覆寫上述的預設搜尋路徑。
如果 $MANPATH 的值以冒號開頭,則預設搜尋路徑會加在其開頭。如果 $MANPATH 的值以冒號結尾,則預設搜尋路徑會加在其結尾。如果 $MANPATH 的值包含雙冒號(::),則預設搜尋路徑會插入到值的兩個冒號中間。
格式¶
目前認可以下欄位類型:
- # comment
- 空行或以 # 開頭的行將被視為註解並忽略。
- MANDATORY_MANPATH manpath_element
- 此格式的行表示每個自動產生的 $MANPATH 應包含的 manpaths。這通常包括 /usr/man。
- MANPATH_MAP path_element manpath_element
- 此格式的行設定 $PATH 到 $MANPATH 的對應。對於在使用者 $PATH 中找到的每個 path_element,manpath_element 會被新增到 $MANPATH。
- MANDB_MAP manpath_element [ catpath_element ]
- 此格式的行表示哪些
manpaths 應視為系統
manpaths,以及可選地它們的
cat
檔案應儲存在何處。如果
man 是 setuid
程式,此欄位類型特別重要,因為(在系統設定檔
/etc/manpath.config
而非使用者設定檔 .manpath
中)它指示哪些手動分頁階層應以
setuid
使用者存取,哪些應以呼叫使用者存取。
系統手動分頁階層通常儲存在 /usr 下,例如 /usr/man、/usr/local/man 和 /usr/X11R6/man。
如果特定 manpath_element 的 cat 頁面不儲存或儲存在傳統位置,則可省略 catpath_element。
對於唯讀掛載的手動分頁階層,傳統的 cat 放置是不可能的,因此可以為其儲存指定任何有效的目錄階層。若要遵守 Linux FSSTND,可以使用 FSSTND 關鍵字代替實際目錄。
不幸的是,必須指定 all 系統 man 樹狀路徑,包括替代作業系統路徑(如 /usr/man/sun)和任何 NLS locale 路徑(如 /usr/man/de_DE.88591)。
由於資訊是以寫入的順序逐行列析,任何作為其他階層的子階層的 manpath 都必須先列出,否則會進行不正確的相符。例如 /usr/man/de_DE.88591 必須在 /usr/man 之前。
- DEFINE key value
- 此格式的行定義雜項設定變數;請參閱手動分頁工具使用的那些變數的預設設定檔。它們包括各種程式的預設路徑(例如 grep 和 tbl)以及那些程式的預設引數集。
- SECTION section ...
SECTION 1 n l 8 3 0 2 3type 5 4 9 6 7
如果提供多個 SECTION 指示詞,它們的區段清單將被串接。
如果特定延伸不在此清單中(例如 1mh),則會顯示在其所屬區段的其餘部分。效果是,只有當您想要強制特定順序時,才需要明確列出延伸。具有延伸的區段通常應與其主區段相鄰(例如「1 1mh 8 ...」)。
SECTIONS 被接受為此指示詞的替代名稱。
- MINCATWIDTH width
- 如果終端寬度小於 width,則不會建立(如果遺失)或顯示 cat 頁面。預設值為 80。
- MAXCATWIDTH width
- 如果終端寬度大於 width,則不會建立(如果遺失)或顯示 cat 頁面。預設值為 80。
- CATWIDTH width
- 如果 width 非零,則 cat 頁面一律會針對指定寬度的終端進行格式化,不管實際使用的終端寬度為何。這會覆寫 MINCATWIDTH 和 MAXCATWIDTH。
- NOCACHE
- 此旗標防止 man(1) 自動建立 cat 頁面。
錯誤¶
除非精確遵循和遵守上述規則,否則手動分頁工具將無法按預期運作。這些規則過於複雜。
https://gitlab.com/man-db/man-db/-/issues
https://savannah.nongnu.org/bugs/?group=man-db
| 2026-11-15 | 2.13.2 |