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 - 在标准输出上打印仓库、命令和文件接口文档的列表。
• --developer-interfaces - 在标准输出上打印文件格式、协议和其他开发者接口文档的列表。
• -i, --info - 以 'info' 格式显示命令的手册页。将使用 'info' 程序。
• -m, --man - 以 'man' 格式显示命令的手册页。此选项可用于覆盖 help.format 配置变量中设置的值。默认使用 'man' 程序显示手册页，但 man.viewer 配置变量可用于选择其他显示程序（见下文）。
• -w, --web - 以 'web'（HTML）格式显示命令的手册页。将使用 Web 浏览器。Web 浏览器可以使用配置变量 help.browser 指定，如果未设置则使用 web.browser。

配置变量

help.format

如果未传递命令行选项，将检查 help.format 配置变量。此变量支持以下值：

• "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" 模式
• "konqueror"：使用 'kfmclient' 在新的 konqueror 标签页中打开手册页

如果存在相应的 man.<tool>.cmd 配置条目，则可以使用其他工具的值。

可以向 man.viewer 配置变量给出多个值。它们对应的程序将按配置文件中列出的顺序尝试。

man.<tool>.path

您可以通过设置配置变量 man.<tool>.path 来显式提供首选手册查看器的完整路径。

man.<tool>.cmd

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

Git

git(1) 套件的一部分