Git
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 程式來達成此目的，但可以被其他選項或配置變數覆寫。

如果給予別名，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，在此處（請參閱 gitrepository-layout[5]）以及樹狀結構內配置（例如 .mailmap，請參閱 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 和 browser.<tool>.path

如果選擇 web 格式（透過命令列選項或配置變數），也會檢查 help.browser、web.browser 和 browser.<tool>.path。請參閱上方選項章節中的 -w|--web 和 git-web--browse[1]。

man.viewer

如果選擇 man 格式，則會檢查 man.viewer 配置變數。目前支援下列值

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

  • "woman"：使用 emacsclient 在 emacs 中啟動 "woman" 模式 (僅適用於 emacsclient 22 以上版本)，

  • "konqueror"：使用 kfmclient 在新的 konqueror 索引標籤中開啟 man 頁面（請參閱下方關於 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.<工具名稱>.cmd 組態變數。如果此變數存在，則指定的工具將被視為自訂命令，並使用 shell eval 來執行該命令，並將 man 頁面作為參數傳遞。

關於 konqueror 的注意事項

當在 man.viewer 組態變數中指定 konqueror 時，我們會啟動 kfmclient，嘗試在已開啟的 konqueror 中以新分頁開啟 man 頁面（如果可能）。

為了保持一致性，如果 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] 套件的一部分

scroll-to-top