簡體中文 ▾ 主題 ▾ 最新版本 ▾ 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]）以及偽配置，例如基於檔案的 .git/hooks/* 介面，該介面在 githooks[5] 中有描述。

--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 在新標籤頁中開啟 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.<tool>.cmd 配置變數。如果該變數存在，則指定的工具將被視為自定義命令，並將使用 shell eval 來執行該命令，並將 man 頁作為引數傳遞。

關於 konqueror 的說明

當在 man.viewer 配置變數中指定 konqueror 時，我們將使用 kfmclient 來嘗試在新開啟的 konqueror 標籤頁中開啟 man 頁，如果可能的話。

為了保持一致性，如果我們嘗試類似 A_PATH_TO/konqueror 的設定，即使 man.konqueror.path 設定為該值，我們也嘗試這種技巧。這意味著我們將嘗試啟動 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] 套件的一部分