Name

git-help  - 显示关于 Git 的帮助信息

概要

git help [-a|--all] [-g|--guide]           [-i|--info|-m|--man|-w|--web] [COMMAND|GUIDE]

描述

如果没有选项，也没有 COMMAND 或 GUIDE ，git命令的概要和最常用的 Git 命令列表将打印在标准输出中。

如果选项--all或-a给定，所有可用的命令都打印在标准输出上。

如果选项--guide或者-g给出，有用的 Git 指南列表也会打印在标准输出中。

如果给出命令或指南，则提供该命令或指南的手册页。该man程序默认用于此目的，但这可以被其他选项或配置变量覆盖。

注意，git --help ...是相同的git help ...，因为前者在内部转换成后者。

要显示 git [1] 手册页，请使用git help git。

此页面可以用git help help或显示git help --help

选项

-a   --all

在标准输出上打印所有可用的命令。该选项将覆盖任何给定的命令或指南名称。

-g   --guides

在标准输出上打印有用的指南列表。该选项将覆盖任何给定的命令或指南名称。

-i   --info

以info格式显示命令的手册页。该info计划将用于此目的。

-m   --man

以man格式显示命令的手册页。该选项可用于覆盖help.format配置变量中设置的值。

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

-w   --web

以web（HTML）格式显示命令的手册页。网页浏览器将用于此目的。

Web浏览器可以使用配置变量指定help.browser，或者web.browser前者未设置。如果这些配置变量都没有设置，git web{litdd}browse助手脚本（调用者git help）会选择合适的默认值。有关详细信息，请参阅 git-web {litdd} 浏览[1]。

配置变量

help.format

如果没有传递任何命令行选项，help.format则会检查配置变量。该变量支持以下值; 它们会git help表现为相应的命令行选项：

• "man" corresponds to -m|--man,

• "info" corresponds to -i|--info,

• “web”或“html”对应于-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下文）。

如果有相应的man.<tool>.cmd配置条目，可以使用其他工具的值（见下文）。

可以给man.viewer配置变量多个值。他们相应的程序将按照配置文件中列出的顺序进行尝试。

例如，这种配置：

        [man]
                viewer = konqueror
                viewer = woman

将尝试首先使用 konqueror。但是这可能会失败（例如，如果没有设置 DISPLAY），那么 emacs 的女性模式将被尝试。

如果一切都失败了，或者没有配置查看器，那么GIT_MAN_VIEWER环境变量中指定的查看器将被尝试。如果这也失败了，该man程序将被尝试。

man.<tool>.path

您可以通过设置配置变量，明确提供一个完整路径给您的首选人查看器man.<tool>.path。例如，您可以通过设置配置 konqueror 的绝对路径man.konqueror.path。否则，git help假定该工具在 PATH 中可用。

man.<tool>.cmd

当由man.viewer配置变量指定的 man 查看器不在支持的查看器中时，man.<tool>.cmd将查找相应的配置变量。如果此变量存在，那么指定的工具将被视为自定义命令，并且将使用 shell eval 来运行该命令，并将 man 页面作为参数传递。

Note about konqueror

当konqueror在man.viewer配置变量中指定时，我们启动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]。