簡體中文 ▾ 主題 ▾ 最新版本 ▾ 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]

描述

如果沒有給定選項、<命令> 或 <文件>，則會在標準輸出上列印 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 也會被檢查。參見上面 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 執行該命令，將 man 頁面作為引數傳遞。

關於 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] 套件的一部分

scroll-to-top