pgsql.cc 提供对 postgresql.org 官网内容的中文翻译，由 Pigsty 团队维护。
参考页应遵循标准布局。这能让用户更快找到所需信息，也能促使作者记录命令的所有相关方面。 不仅希望PostgreSQL参考页彼此保持一致， 也希望它们与操作系统及其他软件包提供的参考页保持一致。因此制定了下列准则。 它们在很大程度上与多个操作系统所建立的类似准则保持一致。
Reference pages that describe executable commands should contain the following sections, in this order. Sections that do not apply can be omitted. Additional top-level sections should only be used in special circumstances; often that information belongs in the “Usage” section.
This section is generated automatically. It contains the command name and a half-sentence summary of its functionality.
本节包含命令的语法图。概要通常不应列出每一个命令行选项； 这些内容会在下文说明。相反，它应列出命令行的主要组成部分， 例如输入文件和输出文件的位置。
用若干段解释该命令的作用。
用列表描述每个命令行选项。如果选项很多，可以使用小节。
如果程序以 0 表示成功、以非零表示失败，那么你不需要记录 这一点。如果不同的非零退出代码有各自的含义，就在这里列出 它们。
描述程序的任何子语言或运行时接口。如果程序不是交互式的， 通常可以省略本节。否则，本节就是用于描述运行时特性的总括性 小节。适当时可以使用小节。
列出程序可能使用的所有环境变量。尽量完整；即便像 SHELL 这样看似微不足道的变量，也可能让用户 感兴趣。
列出程序可能会隐式访问的任何文件。也就是说，不要列出在 命令行上指定的输入和输出文件，而应列出配置文件等内容。
解释程序可能产生的任何不寻常输出。不要去列出所有可能的 错误消息。这项工作量很大，而在实践中用处不大。不过，例如 如果错误消息有一种用户可以解析的标准格式，那么这里就是 解释它的地方。
放不进其他地方的任何内容，尤其包括错误、实现缺陷、安全性 考虑和兼容性问题。
示例
如果该程序的历史上有一些重要里程碑，可以在这里列出。 通常本节可以省略。
交叉引用按以下顺序列出：其他 PostgreSQL 命令参考页、PostgreSQL SQL 命令 参考页、对 PostgreSQL 手册的引用、 其他参考页（例如操作系统或其他软件包）、其他文档。同一组中 的条目按字母顺序排列。
描述 SQL 命令的参考页应包含下列小节：名称、概要、描述、参数、输出、注解、示例、 兼容性、历史、另见。参数小节类似于选项小节，但在决定列出命令的哪些子句时有更大的自由度。 只有当命令返回的内容不是默认的命令完成标签时，才需要输出小节。兼容性小节应解释该命令在多大程度上符合 SQL 标准，或者它与哪种其他数据库系统兼容。SQL 命令的另见小节应先列出 SQL 命令， 再列出对程序的交叉引用。
译文有误、术语不当或页面显示问题，请到译文仓库 pgsty/pgdoc 报告译文问题。 英文原文本身的问题，请在当前版本的对应页面向上游反馈；上游不再修订已结束维护的版本。