获取帮助文档

在学习 Git 的过程中，没有任何人能记住所有的命令和参数。与其死记硬背，不如掌握“查字典”的能力。Git 提供了非常完善的内置帮助文档系统，学会使用它，你就能解决绝大多数问题。

1. 命令行帮助的三种方式

Git 提供了三种主要的方式来获取命令的帮助信息，它们详略不同，适用于不同的场景。

1.1 简明帮助 (`-h`)

这是日常开发中最常用的方式。当你忘记某个命令的具体参数写法，或者想快速查看有哪些选项时，使用 -h。

# 语法：git <verb> -h
git config -h

特点：直接在终端输出一段简洁的用法摘要，不需要离开当前命令行界面，适合快速查阅。

1.2 详细手册 (`--help` 或 `git help`)

当你需要深入理解一个命令的原理、查看所有可选参数的详细解释，或者阅读官方示例时，使用这种方式。

# 语法 1：git <verb> --help
git config --help

# 语法 2：git help <verb>
git help config

特点：这会打开 Git 的 Man Page（手册页）。在 Linux/macOS 上通常会在终端通过 less 分页显示；在 Windows 上，这通常会打开一个默认浏览器页面展示 HTML 格式的文档（取决于安装时的配置）。

2. 如何阅读 Man Page (手册页)

如果你在终端中看到了类似下面的界面，恭喜你，你正在阅读专业的软件文档。不要被密密麻麻的英文吓倒，我们只需要关注几个核心部分。

2.1 文档结构解剖

大多数 Git 命令的手册都遵循以下标准结构：

NAME (名称): 命令的名字和一句话简介。
SYNOPSIS (摘要): 展示命令的语法格式。
- [] 代表可选参数。
- ... 代表可以有多个参数。
- | 代表互斥选项（二选一）。
DESCRIPTION (描述): 详细解释命令是做什么的，以及它的工作原理。
OPTIONS (选项): 这是最常查阅的部分，按字母顺序列出了所有参数的详细用法。
EXAMPLES (示例): 官方提供的最佳实践代码片段。

3. 实战演示：解读 `git config`

让我们以 git config 为例，实战演练一下如何通过文档解决疑惑。

假设你想设置用户信息，但忘记了具体参数是 --global 还是 -global，也想知道如果不加这个参数会发生什么。

步骤 1：尝试简明帮助

输入 git config -h：

usage: git config [<options>]

Config file location
    --global              use global config file
    --system              use system config file
    --local               use repository config file
    ...

解读：

在 Config file location（配置文件位置）一栏下，我们可以清晰地看到 --global 是正确写法。
同时我们也看到了 --system and --local，这暗示了 Git 配置有不同的作用域。

步骤 2：查阅详细手册

输入 git help config 并搜索 /--global：

—global For writing options: write to global ~/.gitconfig file rather than the repository .git/config…

解读：

官方文档明确告诉你：使用 --global 时，配置会写入用户主目录下的 ~/.gitconfig 文件，而不是当前仓库的 .git/config。
这就解释了为什么加了 --global 后，你在任何项目中都能用这个配置。

4. 在线资源

如果你不习惯在命令行阅读纯文本，或者英语阅读比较吃力，以下在线资源是你的好帮手：

Git 官方文档 (中文版): 这是最权威的资料。网站上的 “Reference” 部分就是命令行 Man Page 的网页版。
Pro Git (电子书): 这本书被誉为 Git 的圣经，由 Scott Chacon 撰写。它不仅讲命令，更深入浅出地讲解了 Git 的工作流和原理。我们的教程也深受此书启发。