设置和配置
获取和创建项目
基本快照
分支与合并
共享和更新项目
检查和比较
打补丁
调试
电子邮件
外部系统
服务器管理
指南
管理
底层命令
- 2.43.1 → 2.50.1 无更改
-
2.43.0
2023-11-20
- 2.38.1 → 2.42.4 无更改
-
2.38.0
2022-10-02
- 2.36.1 → 2.37.7 无更改
-
2.36.0
2022-04-18
- 2.35.1 → 2.35.8 无更改
-
2.35.0
2022-01-24
- 2.34.1 → 2.34.8 无更改
-
2.34.0
2021-11-15
- 2.29.1 → 2.33.8 无变更
-
2.29.0
2020-10-19
- 2.22.1 → 2.28.1 无变更
-
2.22.0
2019-06-07
- 2.21.1 → 2.21.4 无更改
-
2.21.0
2019-02-24
- 2.20.1 → 2.20.5 无更改
-
2.20.0
2018-12-09
- 2.19.1 → 2.19.6 无更改
-
2.19.0
2018-09-10
- 2.18.1 → 2.18.5 无更改
-
2.18.0
2018-06-21
- 2.10.5 → 2.17.6 无变更
-
2.9.5
2017-07-30
- 2.2.3 → 2.8.6 无变更
-
2.1.4
2014-12-17
-
2.0.5
2014-12-17
概要
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]。