这个小节是自动生成的。它包含命令名和一个半句话的摘要， 介绍该命令的功能。

这个小节包含该命令的语法图表。大纲通常应该不列出每个命令行选项； 那些东西在后面做。大纲应该列出命令行的主要组件，比如应该把 输入和输出文件放在哪里等。

几个段落，用于描述该命令是做什么的。

一个列表，描述每个命令行选项。如果有许多选项，可以用子小节。

如果程序用 0 表示成功，非零表示失败，那么你不需要为此写文档。 如果在每个非零值的后面有不同的含义，那么在这里列出它们。

描述任意子语言或者程序的运行时接口。如果程序不是交互的， 那么本节通常可以省略。否则，本节是用于描述所有运行时特性 的地方。如果合适，可以使用子小节。

列出所有程序可能使用的环境变量。尽量完整；即使是那些看起来 很琐碎的变量，比如 SHELL 都可能让读者感兴趣。

列出所有程序可能隐含访问的文件。也就是说，不要列出在命令行上 声明的输入和输出文件。但是列出配置文件等等。

解释任何程序可能生成的不正常的输出。避免列出所有可能的错误信息。 这样做工作量很大但没有太多实际用途。但是如果说错误信息有一种 用户可以分析的标准格式，那么这里可能就是解释它的地方。

任何在其它地方放都不合适的东西，尤其是臭虫、实现缺陷、安全考量、 兼容性问题等。

例子

如果在程序的历史中有一些主要的里程碑，那么可以在这里列出。 通常，这个小节可以省略。

交叉引用，按照下面的顺序列出：其它 PostgreSQL 命令的参考页、 PostgreSQL SQL命令参考页、参考 PostgreSQL 手册、 其它参考页(比如，操作系统、其它包)、其它文档。在 同一组里的条目按照字母顺序列出。