# git-help
> 原文: [https://git-scm.com/docs/git-help](https://git-scm.com/docs/git-help)
>
> 貢獻者:[honglyua](https://github.com/honglyua)
## 名稱
git-help - 顯示有關Git的幫助信息
## 概要
```
git help [-a|--all [--[no-]verbose]] [-g|--guide]
[-i|--info|-m|--man|-w|--web] [COMMAND|GUIDE]
```
## 描述
如果沒有選項,也沒有給出COMMAND或GUIDE,則 _git_ 命令的概要和最常用的Git命令列表將打印在標準輸出上。
如果給出選項`--all`或`-a`,則所有可用命令都將打印在標準輸出上。
如果給出選項`--guide`或`-g`,則標準輸出上也會打印有用的Git指南列表。
如果給出了命令或指南,則會顯示該命令或指南的手冊頁。默認情況下, _man_ 程序用于此目的,但這可以被其他選項或配置變量覆蓋。
如果給出了別名,git會在標準輸出上顯示別名的定義。要獲取別名命令的手冊頁,請使用`git COMMAND --help`。
請注意,`git --help ...`與`git help ...`相同,因為前者在內部轉換為后者。
要顯示 [git [1]](https://git-scm.com/docs/git) 手冊頁,請使用`git help git`。
可以使用 _git help help_ 或`git help --help`顯示此頁面
## 選項
```
-a
```
```
--all
```
在標準輸出上打印所有可用命令。此選項會覆蓋任何給定的命令或指南名稱。
```
--verbose
```
與`--all`打印描述一起使用時,用于所有已識別的命令。這是默認值。
```
-c
```
```
--config
```
列出所有可用的配置變量。這是 [git-config [1]](https://git-scm.com/docs/git-config) 中列表的簡短摘要。
```
-g
```
```
--guides
```
在標準輸出上打印有用指南列表。此選項會覆蓋任何給定的命令或指南名稱。
```
-i
```
```
--info
```
以 _info_ 格式顯示命令的手冊頁。 _info_ 程序將用于此目的。
```
-m
```
```
--man
```
以 _man_ 格式顯示命令的手冊頁。此選項可用于覆蓋`help.format`配置變量中設置的值。
默認情況下, _man_ 程序將用于顯示手冊頁,但`man.viewer`配置變量可用于選擇其他顯示程序(見下文)。
```
-w
```
```
--web
```
以 _Web_ (HTML)格式顯示命令的手冊頁。 Web瀏覽器將用于此目的。
如果未設置前者,可以使用配置變量`help.browser`或`web.browser`指定Web瀏覽器。如果沒有設置這些配置變量, _git web{litdd}browse_ 幫助程序腳本(由 _git help_ 調用)將選擇合適的默認值。有關詳細信息,請參閱 [git-web {litdd}瀏覽[1]](https://git-scm.com/docs/git-web{litdd}browse) 。
## 配置變量
### 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 {litdd}瀏覽[1]](https://git-scm.com/docs/git-web{litdd}browse) 。
### 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.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]](https://git-scm.com/docs/git-config) 。
## GIT
部分 [git [1]](https://git-scm.com/docs/git) 套件
- git
- git-config
- git-help
- git-init
- git-clone
- git-add
- git-status
- git-diff
- git-commit
- git-reset
- git-rm
- git-mv
- git-branch
- git-checkout
- git-merge
- git-mergetool
- git-log
- git-stash
- git-tag
- git-worktree
- git-fetch
- git-pull
- git-push
- git-remote
- git-submodule
- git-show
- git-log
- git-shortlog
- git-describe
- git-apply
- git-cherry-pick
- git-rebase
- git-revert
- git-bisect
- git-blame
- git-grep
- gitattributes
- giteveryday
- gitglossary
- githooks
- gitignore
- gitmodules
- gitrevisions
- gittutorial
- gitworkflows
- git-am
- git-format-patch
- git-send-email
- git-request-pull
- git-svn
- git-fast-import
- git-clean
- git-gc
- git-fsck
- git-reflog
- git-filter-branch
- git-instaweb
- git-archive
- git-bundle
- git-daemon
- git-update-server-info
- git-cat-file
- git-check-ignore
- git-checkout-index
- git-commit-tree
- git-count-objects
- git-diff-index
- git-for-each-ref
- git-hash-object
- git-ls-files
- git-merge-base
- git-read-tree
- git-rev-list
- git-rev-parse
- git-show-ref
- git-symbolic-ref
- git-update-index
- git-update-ref
- git-verify-pack
- git-write-tree