English ▾ 主題 ▾ 最新版本 ▾ git-help 最後更新於 2.43.0

名稱

git-help - 顯示 Git 的說明資訊

概要

git help [-a|--all] [--[no-]verbose] [--[no-]external-commands] [--[no-]aliases]
git help [[-i|--info] [-m|--man] [-w|--web]] [<command>|<doc>]
git help [-g|--guides]
git help [-c|--config]
git help [--user-interfaces]
git help [--developer-interfaces]

描述

若未提供任何選項及 <command>（指令）或 <doc>（文件），將會在標準輸出中列印 git 指令的摘要以及最常用的 Git 指令清單。

若提供 --all 或 -a 選項，所有可用的指令都會在標準輸出中列印出來。

若提供 --guides 或 -g 選項，Git 概念指南清單也會在標準輸出中列印出來。

若提供了指令或其他文件，將會顯示相關的手冊頁面。預設情況下會使用 man 程式來執行此操作，但可以透過其他選項或設定變數來覆寫。

若提供了別名（alias），git 會在標準輸出中顯示該別名的定義。若要取得別名指令的手冊頁面，請使用 git <command> --help。

請注意，git --help ... 與 git help ... 是相同的，因為前者在內部會被轉換為後者。

若要顯示 git[1] 手冊頁面，請使用 git help git。

此頁面可以透過 git help help 或 git help --help 顯示。

選項

-a
--all

在標準輸出中列印所有可用的指令。

--no-external-commands

與 --all 一起使用時，排除在 $PATH 中找到的外部 "git-*" 指令清單。

--no-aliases

與 --all 一起使用時，排除已設定的別名清單。

--verbose

與 --all 一起使用時，列印所有已識別指令的描述。這是預設行為。

-c
--config

列出所有可用的設定變數。這是 git-config[1] 清單的簡要摘要。

-g
--guides

在標準輸出中列印 Git 概念指南清單。

--user-interfaces

在標準輸出中列印儲存庫、指令和檔案介面的文件清單。

儲存庫內的檔案介面（例如 .git/info/exclude）以及樹狀目錄內的設定（例如 .mailmap）均記錄於此（請參閱 gitrepository-layout[5] 和 gitmailmap[5]）。

此章節也涵蓋了一般或廣泛使用的使用者介面慣例（例如 gitcli[7]），以及虛擬設定，例如 githooks[5] 中描述的基於檔案的 .git/hooks/* 介面。

--developer-interfaces

在標準輸出中列印檔案格式、協定及其他開發者介面的文件清單。

-i
--info

以 info 格式顯示指令的手冊頁面。將使用 info 程式來執行此操作。

-m
--man

以 man 格式顯示指令的手冊頁面。此選項可用於覆寫 help.format 設定變數中的值。

預設情況下，將使用 man 程式來顯示手冊頁面，但可以使用 man.viewer 設定變數來選擇其他顯示程式（請參閱下文）。

-w
--web

以 web (HTML) 格式顯示指令的手冊頁面。將使用網頁瀏覽器來執行此操作。

網頁瀏覽器可透過設定變數 help.browser 指定，若未設定則使用 web.browser。若兩者皆未設定，git web--browse 輔助腳本（由 git help 呼叫）將會挑選合適的預設值。關於此功能的更多資訊，請參閱 git-web--browse[1]。

組態變數

help.format

若未傳遞指令列選項，將會檢查 help.format 設定變數。此變數支援以下值，它們會使 git help 的行為與對應的指令列選項一致：

  • "man" 對應於 -m|--man，

  • "info" 對應於 -i|--info，

  • "web" 或 "html" 對應於 -w|--web。

help.browser, web.browser, and browser.<tool>.path

若選擇了 web 格式（透過指令列選項或設定變數），亦會檢查 help.browser、web.browser 和 browser.<tool>.path。請參閱上述 OPTIONS 章節中的 -w|--web 以及 git-web--browse[1]。

man.viewer

若選擇了 man 格式，將會檢查 man.viewer 設定變數。目前支援以下值：

  • "man": 照常使用 man 程式，

  • "woman": 使用 emacsclient 在 emacs 中啟動 "woman" 模式（僅適用於 emacsclient 22 以上版本），

  • "konqueror": 使用 kfmclient 在新的 konqueror 分頁中開啟手冊頁面（請參閱下方的「關於 konqueror 的說明」）。

若存在對應的 man.<tool>.cmd 設定項目，亦可使用其他工具的值（請參閱下文）。

man.viewer 設定變數可以給予多個值。系統將會依照設定檔中列出的順序嘗試對應的程式。

例如，此設定

	[man]
		viewer = konqueror
		viewer = woman

將會優先嘗試使用 konqueror。但若此舉失敗（例如未設定 DISPLAY 環境變數），則會改用 emacs 的 woman 模式。

若所有嘗試皆失敗，或未設定任何檢視器，系統將嘗試使用 GIT_MAN_VIEWER 環境變數中指定的檢視器。若依然失敗，則仍會嘗試使用 man 程式。

man.<tool>.path

您可以透過設定 man.<tool>.path 設定變數，明確提供首選 man 檢視器的完整路徑。例如，您可以透過設定 man.konqueror.path 來設定 konqueror 的絕對路徑。否則，git help 會預設該工具存在於 PATH 中。

man.<tool>.cmd

當 man.viewer 設定變數中指定的 man 檢視器不在支援清單中時，系統會查詢對應的 man.<tool>.cmd 設定變數。若此變數存在，則指定的工具將被視為自訂指令，並使用 shell eval 來執行該指令，並將手冊頁面作為參數傳遞。

關於 konqueror 的說明

當在 man.viewer 設定變數中指定 konqueror 時，我們會啟動 kfmclient，嘗試盡可能在已開啟的 konqueror 分頁中開啟手冊頁面。

為了保持一致性，若 man.konqueror.path 被設定為類似 A_PATH_TO/konqueror 的值，我們也會嘗試此技巧。這意味著我們將改為嘗試啟動 A_PATH_TO/kfmclient。

如果您確實想使用 konqueror，可以使用類似以下的方式

	[man]
		viewer = konq

	[man "konq"]
		cmd = A_PATH_TO/konqueror

關於 git config --global 的說明

請注意，所有這些設定變數通常都應該使用 --global 旗標來設定，例如：

$ git config --global help.format web
$ git config --global web.browser firefox

因為這些設定通常是使用者個人偏好，而非針對特定儲存庫的設定。關於此點的更多資訊，請參閱 git-config[1]。

GIT

git[1] 套件的一部分