id="docguide-style-ref-pages-files">
<term>Files</term>
<listitem>
<para>
List any files that the program might access implicitly. That
is, do not list input and output files that were specified on
the command line, but list configuration files, etc.
</para>
</listitem>
</varlistentry>
<varlistentry id="docguide-style-ref-pages-diagnostics">
<term>Diagnostics</term>
<listitem>
<para>
Explain any unusual output that the program might create.
Refrain from listing every possible error message. This is a
lot of work and has little use in practice. But if, say, the
error messages have a standard format that the user can parse,
this would be the place to explain it.
</para>
</listitem>
</varlistentry>
<varlistentry id="docguide-style-ref-pages-notes">
<term>Notes</term>
<listitem>
<para>
Anything that doesn't fit elsewhere, but in particular bugs,
implementation flaws, security considerations, compatibility
issues.
</para>
</listitem>
</varlistentry>
<varlistentry id="docguide-style-ref-pages-examples">
<term>Examples</term>
<listitem>
<para>
Examples
</para>
</listitem>
</varlistentry>
<varlistentry id="docguide-style-ref-pages-history">
<term>History</term>
<listitem>
<para>
If there were some major milestones in the history of the
program, they might be listed here. Usually, this section can
be omitted.
</para>
</listitem>
</varlistentry>
<varlistentry id="docguide-style-ref-pages-author">
<term>Author</term>
<listitem>
<para>
Author (only used in the contrib section)
</para>
</listitem>
</varlistentry>
<varlistentry id="docguide-style-ref-pages-see-also">
<term>See Also</term>
<listitem>
<para>
Cross-references, listed in the following order: other
<productname>PostgreSQL</productname> command reference pages,
<productname>PostgreSQL</productname> SQL command reference
pages, citation of <productname>PostgreSQL</productname>
manuals, other reference pages (e.g., operating system, other
packages), other documentation. Items in the same group are
listed alphabetically.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
Reference pages describing SQL commands should contain the
following sections: Name, Synopsis, Description, Parameters,
Outputs, Notes, Examples, Compatibility, History, See
Also. The Parameters section is like the Options section, but
there is more freedom about which clauses of the command can be
listed. The Outputs section is only needed if the command returns
something other than a default command-completion tag. The Compatibility
section should explain to what extent
this command conforms to the SQL standard(s), or to which other
database system it is compatible. The See Also section of SQL
commands should list SQL commands before cross-references to
programs.
</para>
</sect2>
</sect1>
</appendix>