基本帮助

1. 如何寻求机器的帮助

本文档所说的 机器的帮助 指的是自包含的 离线 文档。

1.1. 命令行

1.1.1. 内置帮助

• 外部命令

  UNIX / POSIX / Linux 环境下的命令行程序如果不提供 --help ， 都是耍流氓， 比如说 OpenSSH 提供的 ssh, ssh-keygen, ssh-add 与 ssh-agent 等命令，全都耍流氓。 （的确，他们收到 --help 的时候会显示简要的使用信息， 然而那是因为他们不认得 --help ， 而不是因为他们提供了 --help 。 毕竟 OpenSSH 是 BSD 风格的程序。我喜欢 GNU 风格的程序。）

• Bash

  使用 help 内置命令查看内置命令的帮助。

• Zsh

  使用 run-help 函数查看各种帮助，包括内置命令、man 手册等。 其快捷键为 M-h 。

1.1.2. 外部帮助

• man

  man 手册需要安装， 不过，通常在安装系统的时候会安装上一套 基本的 man 手册 。 然后，在安装其他程序的时候，他们的 man 手册也会一起安装上， 或者说，程序自带自己的 man 手册。

• info

  info 手册也需要安装，不过通常是跟程序一起安装的， 或者说，是程序自带的。

  GNU 的程序大都使用这种文档方式，比如 Bash 。

  不带参数执行 info 可以看到总目录。

  注意：要想愉快地使用 info ，你需要花点时间了解一下它的工作方式。

1.2. 编程语言

1.2.1. Python

Python 编程语言自包含的帮助也就是写在 Docstring 里面的文档。

pydoc 可以用来查看这些自带的文档， 尽管不是特别详细（你可以指望 Python 包的开发者会把 Docstring 写得特别详细）， 但是完全可以胜任大多数情况，尤其是在没有网络的情况下。

在 Windows 环境下你可能额外需要配置，或者使用 python -m pydoc 。 另外， Python 的 Windows 发行自带了一份 CHM 格式的详细的文档。

例如。

查看 pathlib2 模块 Path 类自带的文档。 注意这个模块不属于 Python 标准库。

pydoc2 pathlib2.Path

查看 GitPython 模块 Remote 类自带的文档。 注意这个模块不属于 Python 标准库。

pydoc3 git.Remote

查看 Python 标准库 re 模块自带的文档。 尽管自带的文档比不上在线文档详细， 但是很多没记牢的东西都可以看到。

python -m pydoc re

2. 如何寻求人类的帮助

记住，机器是不会拒绝你的，但是人类是懂得拒绝的生物。