<productname>DocBook</productname> out of the box. Check the <ulink
url="https://www.gnu.org/software/emacs/manual/html_mono/nxml-mode.html">
nXML manual</ulink> for detailed documentation.
</para>
<para>
<filename>src/tools/editors/emacs.samples</filename> contains
recommended settings for this mode.
</para>
</sect2>
</sect1>
<sect1 id="docguide-style">
<title>Style Guide</title>
<sect2 id="docguide-style-ref-pages">
<title>Reference Pages</title>
<para>
Reference pages should follow a standard layout. This allows
users to find the desired information more quickly, and it also
encourages writers to document all relevant aspects of a command.
Consistency is not only desired among
<productname>PostgreSQL</productname> reference pages, but also
with reference pages provided by the operating system and other
packages. Hence the following guidelines have been developed.
They are for the most part consistent with similar guidelines
established by various operating systems.
</para>
<para>
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
<quote>Usage</quote> section.
<variablelist>
<varlistentry id="docguide-style-ref-pages-name">
<term>Name</term>
<listitem>
<para>
This section is generated automatically. It contains the
command name and a half-sentence summary of its functionality.
</para>
</listitem>
</varlistentry>
<varlistentry id="docguide-style-ref-pages-synopsis">
<term>Synopsis</term>
<listitem>
<para>
This section contains the syntax diagram of the command. The
synopsis should normally not list each command-line option;
that is done below. Instead, list the major components of the
command line, such as where input and output files go.
</para>
</listitem>
</varlistentry>
<varlistentry id="docguide-style-ref-pages-description">
<term>Description</term>
<listitem>
<para>
Several paragraphs explaining what the command does.
</para>
</listitem>
</varlistentry>
<varlistentry id="docguide-style-ref-pages-options">
<term>Options</term>
<listitem>
<para>
A list describing each command-line option. If there are a
lot of options, subsections can be used.
</para>
</listitem>
</varlistentry>
<varlistentry id="docguide-style-ref-pages-exit-status">
<term>Exit Status</term>
<listitem>
<para>
If the program uses 0 for success and non-zero for failure,
then you do not need to document it. If there is a meaning
behind the different non-zero exit codes, list them here.
</para>
</listitem>
</varlistentry>
<varlistentry id="docguide-style-ref-pages-usage">
<term>Usage</term>
<listitem>
<para>
Describe any sublanguage or run-time interface of the program.
If the program is not interactive, this section can usually be
omitted. Otherwise, this section is a catch-all for
describing run-time features. Use subsections if appropriate.
</para>
</listitem>
</varlistentry>
<varlistentry id="docguide-style-ref-pages-environment">
<term>Environment</term>
<listitem>