?
本文檔使用 PHP中文網(wǎng)手冊 發(fā)布
git-help - 顯示關(guān)于 Git 的幫助信息
git help [-a|--all] [-g|--guide] [-i|--info|-m|--man|-w|--web] [COMMAND|GUIDE]
如果沒有選項,也沒有 COMMAND 或 GUIDE ,git
命令的概要和最常用的 Git 命令列表將打印在標(biāo)準(zhǔn)輸出中。
如果選項--all
或-a
給定,所有可用的命令都打印在標(biāo)準(zhǔn)輸出上。
如果選項--guide
或者-g
給出,有用的 Git 指南列表也會打印在標(biāo)準(zhǔn)輸出中。
如果給出命令或指南,則提供該命令或指南的手冊頁。該man
程序默認(rèn)用于此目的,但這可以被其他選項或配置變量覆蓋。
注意,git --help ...
是相同的git help ...
,因為前者在內(nèi)部轉(zhuǎn)換成后者。
要顯示 git [1] 手冊頁,請使用git help git
。
此頁面可以用git help help
或顯示git help --help
-a --all
在標(biāo)準(zhǔn)輸出上打印所有可用的命令。該選項將覆蓋任何給定的命令或指南名稱。
-g --guides
在標(biāo)準(zhǔn)輸出上打印有用的指南列表。該選項將覆蓋任何給定的命令或指南名稱。
-i --info
以info
格式顯示命令的手冊頁。該info
計劃將用于此目的。
-m --man
以man
格式顯示命令的手冊頁。該選項可用于覆蓋help.format
配置變量中設(shè)置的值。
默認(rèn)情況下,man
程序?qū)⒂糜陲@示手冊頁,但man.viewer
配置變量可用于選擇其他顯示程序(見下文)。
-w --web
以web
(HTML)格式顯示命令的手冊頁。網(wǎng)頁瀏覽器將用于此目的。
Web瀏覽器可以使用配置變量指定help.browser
,或者web.browser
前者未設(shè)置。如果這些配置變量都沒有設(shè)置,git web{litdd}browse
助手腳本(調(diào)用者git help
)會選擇合適的默認(rèn)值。有關(guān)詳細(xì)信息,請參閱 git-web {litdd} 瀏覽[1]。
如果沒有傳遞任何命令行選項,help.format
則會檢查配置變量。該變量支持以下值; 它們會git help
表現(xiàn)為相應(yīng)的命令行選項:
"man" corresponds to -m|--man
,
"info" corresponds to -i|--info
,
“web”或“html”對應(yīng)于-w|--web
.help.browser,web.browser 和 browser。<tool> .pathThe help.browser
,web.browser
并且 browser.<tool>.path
如果web
格式被選擇(通過命令行選項或配置變量),也將被檢查。請參閱-w|--web
上面的選項部分和 git-web {litdd} browse [1] .man.viewer man.viewer
如果man
選擇了格式,將檢查配置變量。目前支持以下值:
“man”:man
像往常一樣使用該程序,
“woman”:用于emacsclient
在 emacs 中啟動“woman”模式(這只能從 emacsclient 版本22開始),
“konqueror”:用于kfmclient
在新的 konqueror 選項卡中打開手冊頁(見Note about konqueror
下文)。
如果有相應(yīng)的man.<tool>.cmd
配置條目,可以使用其他工具的值(見下文)。
可以給man.viewer
配置變量多個值。他們相應(yīng)的程序?qū)凑张渲梦募辛谐龅捻樞蜻M(jìn)行嘗試。
例如,這種配置:
[man] viewer = konqueror viewer = woman
將嘗試首先使用 konqueror。但是這可能會失?。ɡ?,如果沒有設(shè)置 DISPLAY),那么 emacs 的女性模式將被嘗試。
如果一切都失敗了,或者沒有配置查看器,那么GIT_MAN_VIEWER
環(huán)境變量中指定的查看器將被嘗試。如果這也失敗了,該man
程序?qū)⒈粐L試。
您可以通過設(shè)置配置變量,明確提供一個完整路徑給您的首選人查看器man.<tool>.path
。例如,您可以通過設(shè)置配置
konqueror 的絕對路徑man.konqueror.path
。否則,git help
假定該工具在 PATH 中可用。
當(dāng)由man.viewer
配置變量指定的 man 查看器不在支持的查看器中時,man.<tool>.cmd
將查找相應(yīng)的配置變量。如果此變量存在,那么指定的工具將被視為自定義命令,并且將使用 shell eval 來運行該命令,并將 man 頁面作為參數(shù)傳遞。
當(dāng)konqueror
在man.viewer
配置變量中指定時,我們啟動kfmclient
以嘗試在可能的情況下在新選項卡上打開已打開的
konqueror 上的手冊頁。
為了保持一致性,如果man.konqueror.path
設(shè)置為類似的東西,我們也會嘗試這種技巧A_PATH_TO/konqueror
。這意味著我們將嘗試啟動A_PATH_TO/kfmclient
。
如果你真的想使用konqueror
,那么你可以使用類似下面的東西:
[man] viewer = konq [man "konq"] cmd = A_PATH_TO/konqueror
請注意,所有這些配置變量都應(yīng)該使用--global
標(biāo)志來設(shè)置,例如像這樣:
$ git config --global help.format web $ git config --global web.browser firefox
因為它們可能比特定于存儲庫的用戶更具體。有關(guān)更多信息,請參閱 git-config [1]。