Git
英语 ▾ 主题 ▾ 最新版本 ▾ 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]），以及伪配置，例如 githooks[5] 中描述的文件.git/hooks/* 接口。

--developer-interfaces

将文件格式、协议和其他开发人员接口文档列表打印到标准输出。

-i
--info

以 info 格式显示命令的联机帮助页。将使用 info 程序来实现此目的。

-m
--man

以 man 格式显示命令的联机帮助页。此选项可用于覆盖在 help.format 配置变量中设置的值。

默认情况下，将使用 man 程序显示联机帮助页，但 man.viewer 配置变量可用于选择其他显示程序（见下文）。

-w
--web

以 web（HTML）格式显示命令的联机帮助页。将使用 Web 浏览器来实现此目的。

可以使用配置变量 help.browser 或 web.browser 指定 Web 浏览器（如果前者未设置）。如果这两个配置变量均未设置，则 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 在新的 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 来运行该命令，并将联机帮助页作为参数传递。

关于 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