2010-09-20 22:08:53 +02:00
|
|
|
<!-- doc/src/sgml/docguide.sgml -->
|
1998-08-15 08:53:52 +02:00
|
|
|
|
2001-10-09 20:46:00 +02:00
|
|
|
<appendix id="docguide">
|
1999-05-27 17:49:08 +02:00
|
|
|
<title>Documentation</title>
|
|
|
|
|
|
|
|
<para>
|
2000-11-11 14:53:49 +01:00
|
|
|
<productname>PostgreSQL</productname> has four primary documentation
|
|
|
|
formats:
|
|
|
|
|
|
|
|
<itemizedlist>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Plain text, for pre-installation information
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
<acronym>HTML</acronym>, for on-line browsing and reference
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2017-04-07 04:03:52 +02:00
|
|
|
PDF, for printing
|
2000-11-11 14:53:49 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
man pages, for quick reference.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</itemizedlist>
|
|
|
|
|
2003-09-13 00:17:24 +02:00
|
|
|
Additionally, a number of plain-text <filename>README</filename> files can
|
|
|
|
be found throughout the <productname>PostgreSQL</productname> source tree,
|
2000-11-11 14:53:49 +01:00
|
|
|
documenting various implementation issues.
|
1999-05-27 17:49:08 +02:00
|
|
|
</para>
|
|
|
|
|
2000-11-11 14:53:49 +01:00
|
|
|
<para>
|
|
|
|
<acronym>HTML</acronym> documentation and man pages are part of a
|
2017-04-07 04:03:52 +02:00
|
|
|
standard distribution and are installed by default. PDF
|
|
|
|
format documentation is available separately for
|
2003-06-06 16:17:08 +02:00
|
|
|
download.
|
2000-11-11 14:53:49 +01:00
|
|
|
</para>
|
1999-05-27 17:49:08 +02:00
|
|
|
|
2003-06-06 16:17:08 +02:00
|
|
|
<sect1 id="docguide-docbook">
|
2000-11-11 14:53:49 +01:00
|
|
|
<title>DocBook</title>
|
1999-05-27 17:49:08 +02:00
|
|
|
<para>
|
2000-11-11 14:53:49 +01:00
|
|
|
The documentation sources are written in
|
|
|
|
<firstterm>DocBook</firstterm>, which is a markup language
|
|
|
|
superficially similar to <acronym>HTML</acronym>. Both of these
|
|
|
|
languages are applications of the <firstterm>Standard Generalized
|
|
|
|
Markup Language</firstterm>, <acronym>SGML</acronym>, which is
|
|
|
|
essentially a language for describing other languages. In what
|
2004-02-17 03:53:03 +01:00
|
|
|
follows, the terms DocBook and <acronym>SGML</acronym> are both
|
|
|
|
used, but technically they are not interchangeable.
|
1999-05-27 17:49:08 +02:00
|
|
|
</para>
|
|
|
|
|
2017-04-07 04:03:52 +02:00
|
|
|
<note>
|
|
|
|
<para>
|
|
|
|
The PostgreSQL documentation is currently being transitioned from DocBook
|
|
|
|
SGML and DSSSL style sheets to DocBook XML and XSLT style sheets. Be
|
|
|
|
careful to look at the instructions relating to the PostgreSQL version you
|
|
|
|
are dealing with, as the procedures and required tools will change.
|
|
|
|
</para>
|
|
|
|
</note>
|
|
|
|
|
1999-05-27 17:49:08 +02:00
|
|
|
<para>
|
2000-11-11 14:53:49 +01:00
|
|
|
<productname>DocBook</productname> allows an author to specify the
|
|
|
|
structure and content of a technical document without worrying
|
|
|
|
about presentation details. A document style defines how that
|
|
|
|
content is rendered into one of several final forms. DocBook is
|
2005-04-09 05:52:43 +02:00
|
|
|
maintained by the <ulink url="http://www.oasis-open.org">
|
2010-03-17 18:12:31 +01:00
|
|
|
OASIS group</ulink>. The <ulink url="http://www.oasis-open.org/docbook/">
|
2005-04-09 05:52:43 +02:00
|
|
|
official DocBook site</ulink> has good introductory and reference documentation and
|
2000-11-11 14:53:49 +01:00
|
|
|
a complete O'Reilly book for your online reading pleasure. The
|
2005-02-19 05:34:17 +01:00
|
|
|
<ulink url="http://newbiedoc.sourceforge.net/metadoc/docbook-guide.html">
|
2005-04-09 05:52:43 +02:00
|
|
|
NewbieDoc Docbook Guide</ulink> is very helpful for beginners.
|
|
|
|
The <ulink url="http://www.freebsd.org/docproj/docproj.html">
|
|
|
|
FreeBSD Documentation Project</ulink> also uses DocBook and has some good
|
2000-11-11 14:53:49 +01:00
|
|
|
information, including a number of style guidelines that might be
|
|
|
|
worth considering.
|
1999-05-27 17:49:08 +02:00
|
|
|
</para>
|
|
|
|
</sect1>
|
|
|
|
|
|
|
|
|
2003-06-06 16:17:08 +02:00
|
|
|
<sect1 id="docguide-toolsets">
|
2002-03-22 20:20:45 +01:00
|
|
|
<title>Tool Sets</title>
|
1999-05-27 17:49:08 +02:00
|
|
|
|
|
|
|
<para>
|
2000-11-11 14:53:49 +01:00
|
|
|
The following tools are used to process the documentation. Some
|
Update documentation on may/can/might:
Standard English uses "may", "can", and "might" in different ways:
may - permission, "You may borrow my rake."
can - ability, "I can lift that log."
might - possibility, "It might rain today."
Unfortunately, in conversational English, their use is often mixed, as
in, "You may use this variable to do X", when in fact, "can" is a better
choice. Similarly, "It may crash" is better stated, "It might crash".
Also update two error messages mentioned in the documenation to match.
2007-01-31 21:56:20 +01:00
|
|
|
might be optional, as noted.
|
1999-05-27 17:49:08 +02:00
|
|
|
|
2000-11-11 14:53:49 +01:00
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
2009-08-05 00:04:37 +02:00
|
|
|
<term><ulink url="http://www.oasis-open.org/docbook/">DocBook DTD</ulink></term>
|
2000-11-11 14:53:49 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2017-04-07 04:03:52 +02:00
|
|
|
This is the definition of DocBook itself. We currently use version
|
|
|
|
4.2; you cannot use later or earlier versions. You need
|
|
|
|
the <acronym>SGML</acronym> and the <acronym>XML</acronym> variant of
|
|
|
|
the DocBook DTD of the same version. These will usually be in separate
|
|
|
|
packages.
|
2000-11-11 14:53:49 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
1999-05-27 17:49:08 +02:00
|
|
|
|
2000-11-11 14:53:49 +01:00
|
|
|
<varlistentry>
|
2005-04-09 05:52:43 +02:00
|
|
|
<term><ulink url="http://www.oasis-open.org/cover/ISOEnts.zip">ISO 8879 character entities</ulink></term>
|
2000-11-11 14:53:49 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2017-04-07 04:03:52 +02:00
|
|
|
These are required by DocBook SGML but are distributed separately
|
2000-11-11 14:53:49 +01:00
|
|
|
because they are maintained by ISO.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
1998-12-29 03:24:47 +01:00
|
|
|
|
2000-11-11 14:53:49 +01:00
|
|
|
<varlistentry>
|
2017-04-07 04:03:52 +02:00
|
|
|
<term><ulink url="http://wiki.docbook.org/DocBookXslStylesheets">DocBook XSL Stylesheets</ulink></term>
|
2000-11-11 14:53:49 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2009-08-05 00:04:37 +02:00
|
|
|
These contain the processing instructions for converting the
|
|
|
|
DocBook sources to other formats, such as
|
|
|
|
<acronym>HTML</acronym>.
|
2000-11-11 14:53:49 +01:00
|
|
|
</para>
|
2011-08-27 22:28:55 +02:00
|
|
|
|
|
|
|
<para>
|
2017-04-07 04:03:52 +02:00
|
|
|
The minimum required version is currently 1.77.0, but it is recommended
|
|
|
|
to use the latest available version for best results.
|
2011-08-27 22:28:55 +02:00
|
|
|
</para>
|
2000-11-11 14:53:49 +01:00
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
1998-07-29 08:33:37 +02:00
|
|
|
|
2000-11-11 14:53:49 +01:00
|
|
|
<varlistentry>
|
2017-04-07 04:03:52 +02:00
|
|
|
<term><ulink url="http://openjade.sourceforge.net">OpenSP</ulink></term>
|
2000-11-11 14:53:49 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2017-04-07 04:03:52 +02:00
|
|
|
This is the base package of <acronym>SGML</acronym> processing. Note
|
|
|
|
that we no longer need OpenJade, the <acronym>DSSSL</acronym>
|
|
|
|
processor, only the OpenSP package for converting SGML to XML.
|
2008-09-12 10:43:53 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
doc: Check DocBook XML validity during the build
Building the documentation with XSLT does not check the DTD, like a
DSSSL build would. One can often get away with having invalid XML, but
the stylesheets might then create incorrect output, as they are not
designed to handle that. Therefore, check the validity of the XML
against the DTD, using xmllint, during the build.
Add xmllint detection to configure, and add some documentation.
xmllint comes with libxml2, which is already in use, but it might be in
a separate package, such as libxml2-utils on Debian.
Reviewed-by: Fabien COELHO <coelho@cri.ensmp.fr>
2014-10-21 20:46:38 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><ulink url="http://xmlsoft.org/">Libxml2</ulink> for <command>xmllint</command></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
This library and the <command>xmllint</command> tool it contains are
|
|
|
|
used for processing XML. Many developers will already
|
|
|
|
have <application>Libxml2</application> installed, because it is also
|
|
|
|
used when building the PostgreSQL code. Note, however,
|
|
|
|
that <command>xmllint</command> might need to be installed from a
|
|
|
|
separate subpackage.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2008-09-12 10:43:53 +02:00
|
|
|
<varlistentry>
|
2009-08-05 00:04:37 +02:00
|
|
|
<term><ulink url="http://xmlsoft.org/XSLT/">Libxslt</ulink> for <command>xsltproc</command></term>
|
2008-09-12 10:43:53 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2017-04-07 04:03:52 +02:00
|
|
|
<command>xsltproc</command> is an XSLT processor, that is, a program to
|
|
|
|
convert XML to other formats using XSLT stylesheets.
|
2000-11-11 14:53:49 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
1998-07-29 08:33:37 +02:00
|
|
|
|
2000-11-11 14:53:49 +01:00
|
|
|
<varlistentry>
|
2017-04-07 04:03:52 +02:00
|
|
|
<term><ulink url="https://xmlgraphics.apache.org/fop/">FOP</ulink></term>
|
2000-11-11 14:53:49 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2017-04-07 04:03:52 +02:00
|
|
|
This is a program for converting, among other things, XML to PDF.
|
2000-11-11 14:53:49 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
2000-02-02 17:22:45 +01:00
|
|
|
</para>
|
1998-07-29 08:33:37 +02:00
|
|
|
|
2000-02-02 17:22:45 +01:00
|
|
|
<para>
|
2000-11-11 14:53:49 +01:00
|
|
|
We have documented experience with several installation methods for
|
|
|
|
the various tools that are needed to process the documentation.
|
Update documentation on may/can/might:
Standard English uses "may", "can", and "might" in different ways:
may - permission, "You may borrow my rake."
can - ability, "I can lift that log."
might - possibility, "It might rain today."
Unfortunately, in conversational English, their use is often mixed, as
in, "You may use this variable to do X", when in fact, "can" is a better
choice. Similarly, "It may crash" is better stated, "It might crash".
Also update two error messages mentioned in the documenation to match.
2007-01-31 21:56:20 +01:00
|
|
|
These will be described below. There might be some other packaged
|
2000-11-11 14:53:49 +01:00
|
|
|
distributions for these tools. Please report package status to the
|
2003-06-06 16:17:08 +02:00
|
|
|
documentation mailing list, and we will include that information
|
|
|
|
here.
|
2000-02-02 17:22:45 +01:00
|
|
|
</para>
|
1998-07-29 08:33:37 +02:00
|
|
|
|
2017-04-07 04:03:52 +02:00
|
|
|
<para>
|
|
|
|
You can get away with not installing DocBook XML and the DocBook XSLT
|
|
|
|
stylesheets locally, because the required files will be downloaded from the
|
|
|
|
Internet and cached locally. This may in fact be the preferred solution if
|
|
|
|
your operating system packages provide only an old version of especially
|
|
|
|
the stylesheets or if no packages are available at all. See
|
|
|
|
the <option>--nonet</option> option for <command>xmllint</command>
|
|
|
|
and <command>xsltproc</command> for more information.
|
|
|
|
</para>
|
|
|
|
|
2000-02-02 17:22:45 +01:00
|
|
|
<sect2>
|
2014-10-21 16:43:09 +02:00
|
|
|
<title>Installation on Fedora, RHEL, and Derivatives</title>
|
1998-10-30 20:37:19 +01:00
|
|
|
|
2000-02-02 17:22:45 +01:00
|
|
|
<para>
|
2014-10-21 16:43:09 +02:00
|
|
|
To install the required packages, use:
|
|
|
|
<programlisting>
|
2017-04-07 04:03:52 +02:00
|
|
|
yum install docbook-dtds docbook-style-xsl fop libxslt opensp
|
2014-10-21 16:43:09 +02:00
|
|
|
</programlisting>
|
2000-02-02 17:22:45 +01:00
|
|
|
</para>
|
2000-11-11 14:53:49 +01:00
|
|
|
</sect2>
|
1998-04-28 16:57:48 +02:00
|
|
|
|
2000-02-02 17:22:45 +01:00
|
|
|
<sect2>
|
2014-10-21 16:32:28 +02:00
|
|
|
<title>Installation on FreeBSD</title>
|
2000-02-02 17:22:45 +01:00
|
|
|
|
|
|
|
<para>
|
2000-11-11 14:53:49 +01:00
|
|
|
The FreeBSD Documentation Project is itself a heavy user of
|
|
|
|
DocBook, so it comes as no surprise that there is a full set of
|
|
|
|
<quote>ports</quote> of the documentation tools available on
|
|
|
|
FreeBSD. The following ports need to be installed to build the
|
|
|
|
documentation on FreeBSD.
|
|
|
|
<itemizedlist>
|
|
|
|
<listitem>
|
2014-10-21 16:32:28 +02:00
|
|
|
<para><filename>textproc/docbook-sgml</filename></para>
|
2000-11-11 14:53:49 +01:00
|
|
|
</listitem>
|
|
|
|
<listitem>
|
2014-10-21 16:32:28 +02:00
|
|
|
<para><filename>textproc/docbook-xml</filename></para>
|
2000-11-11 14:53:49 +01:00
|
|
|
</listitem>
|
|
|
|
<listitem>
|
2014-10-21 16:32:28 +02:00
|
|
|
<para><filename>textproc/docbook-xsl</filename></para>
|
2000-11-11 14:53:49 +01:00
|
|
|
</listitem>
|
|
|
|
<listitem>
|
|
|
|
<para><filename>textproc/dsssl-docbook-modular</filename></para>
|
|
|
|
</listitem>
|
2007-01-31 16:23:28 +01:00
|
|
|
<listitem>
|
2014-10-21 16:32:28 +02:00
|
|
|
<para><filename>textproc/libxslt</filename></para>
|
|
|
|
</listitem>
|
|
|
|
<listitem>
|
2017-04-07 04:03:52 +02:00
|
|
|
<para><filename>textproc/fop</filename></para>
|
|
|
|
</listitem>
|
|
|
|
<listitem>
|
|
|
|
<para><filename>textproc/opensp</filename></para>
|
2007-01-31 16:23:28 +01:00
|
|
|
</listitem>
|
2000-11-11 14:53:49 +01:00
|
|
|
</itemizedlist>
|
2003-11-24 20:08:02 +01:00
|
|
|
</para>
|
|
|
|
|
2017-03-22 03:09:40 +01:00
|
|
|
<para>
|
|
|
|
To install the required packages with <command>pkg</command>, use:
|
|
|
|
<programlisting>
|
2017-04-07 04:03:52 +02:00
|
|
|
pkg install docbook-sgml docbook-xml docbook-xsl fop libxslt opensp
|
2017-03-22 03:09:40 +01:00
|
|
|
</programlisting>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
When building the documentation from the <filename>doc</filename>
|
|
|
|
directory you'll need to use <command>gmake</command>, because the
|
|
|
|
makefile provided is not suitable for FreeBSD's <command>make</command>.
|
|
|
|
</para>
|
|
|
|
|
2000-11-11 14:53:49 +01:00
|
|
|
<para>
|
|
|
|
More information about the FreeBSD documentation tools can be
|
2005-04-09 05:52:43 +02:00
|
|
|
found in the <ulink url="http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/tools.html">
|
|
|
|
FreeBSD Documentation Project's instructions</ulink>.
|
2000-11-11 14:53:49 +01:00
|
|
|
</para>
|
2000-02-02 17:22:45 +01:00
|
|
|
</sect2>
|
1998-03-01 09:16:16 +01:00
|
|
|
|
2000-02-02 17:22:45 +01:00
|
|
|
<sect2>
|
2000-11-11 14:53:49 +01:00
|
|
|
<title>Debian Packages</title>
|
1998-04-28 16:57:48 +02:00
|
|
|
|
2000-02-02 17:22:45 +01:00
|
|
|
<para>
|
2000-11-11 14:53:49 +01:00
|
|
|
There is a full set of packages of the documentation tools
|
|
|
|
available for <productname>Debian GNU/Linux</productname>.
|
|
|
|
To install, simply use:
|
|
|
|
<programlisting>
|
2017-04-07 04:03:52 +02:00
|
|
|
apt-get install docbook docbook-xml docbook-xsl fop libxml2-utils opensp xsltproc
|
2000-11-11 14:53:49 +01:00
|
|
|
</programlisting>
|
2000-02-02 17:22:45 +01:00
|
|
|
</para>
|
2000-11-11 14:53:49 +01:00
|
|
|
</sect2>
|
|
|
|
|
2012-08-23 08:28:47 +02:00
|
|
|
<sect2>
|
Refer to OS X as "macOS", except for the port name which is still "darwin".
We weren't terribly consistent about whether to call Apple's OS "OS X"
or "Mac OS X", and the former is probably confusing to people who aren't
Apple users. Now that Apple has rebranded it "macOS", follow their lead
to establish a consistent naming pattern. Also, avoid the use of the
ancient project name "Darwin", except as the port code name which does not
seem desirable to change. (In short, this patch touches documentation and
comments, but no actual code.)
I didn't touch contrib/start-scripts/osx/, either. I suspect those are
obsolete and due for a rewrite, anyway.
I dithered about whether to apply this edit to old release notes, but
those were responsible for quite a lot of the inconsistencies, so I ended
up changing them too. Anyway, Apple's being ahistorical about this,
so why shouldn't we be?
2016-09-25 21:40:57 +02:00
|
|
|
<title>macOS</title>
|
2012-08-23 08:28:47 +02:00
|
|
|
|
|
|
|
<para>
|
|
|
|
If you use MacPorts, the following will get you set up:
|
|
|
|
<programlisting>
|
2017-04-07 04:03:52 +02:00
|
|
|
sudo port install docbook-sgml-4.2 docbook-xml-4.2 docbook-xsl fop libxslt opensp
|
2012-08-23 08:28:47 +02:00
|
|
|
</programlisting>
|
|
|
|
</para>
|
|
|
|
</sect2>
|
|
|
|
|
2000-11-11 14:53:49 +01:00
|
|
|
<sect2>
|
|
|
|
<title>Manual Installation from Source</title>
|
1998-04-28 16:57:48 +02:00
|
|
|
|
2000-02-02 17:22:45 +01:00
|
|
|
<para>
|
2000-11-11 14:53:49 +01:00
|
|
|
The manual installation process of the DocBook tools is somewhat
|
|
|
|
complex, so if you have pre-built packages available, use them.
|
2002-03-22 20:20:45 +01:00
|
|
|
We describe here only a standard setup, with reasonably standard
|
2000-11-11 14:53:49 +01:00
|
|
|
installation paths, and no <quote>fancy</quote> features. For
|
|
|
|
details, you should study the documentation of the respective
|
|
|
|
package, and read <acronym>SGML</acronym> introductory material.
|
2000-02-02 17:22:45 +01:00
|
|
|
</para>
|
1998-04-28 16:57:48 +02:00
|
|
|
|
2000-02-02 17:22:45 +01:00
|
|
|
<sect3>
|
2017-04-07 04:03:52 +02:00
|
|
|
<title>Installing OpenSP</title>
|
1998-04-28 16:57:48 +02:00
|
|
|
|
2017-04-07 04:03:52 +02:00
|
|
|
<para>
|
|
|
|
The installation of OpenSP offers a GNU-style
|
|
|
|
<literal>./configure; make; make install</literal> build process.
|
|
|
|
Details can be found in the OpenSP source distribution. In a nutshell:
|
2000-11-11 14:53:49 +01:00
|
|
|
<synopsis>
|
2017-04-07 04:03:52 +02:00
|
|
|
./configure --enable-default-catalog=/usr/local/etc/sgml/catalog
|
2000-11-11 14:53:49 +01:00
|
|
|
make
|
|
|
|
make install
|
|
|
|
</synopsis>
|
2017-04-07 04:03:52 +02:00
|
|
|
Be sure to remember where you put the <quote>default catalog</quote>; you
|
|
|
|
will need it below. You can also leave it off, but then you will have to
|
|
|
|
set the environment variable <envar>SGML_CATALOG_FILES</envar> to point
|
|
|
|
to the file whenever you use any programs from OpenSP later on. (This
|
|
|
|
method is also an option if OpenSP is already installed and you want to
|
|
|
|
install the rest of the toolchain locally.)
|
|
|
|
</para>
|
2000-11-11 14:53:49 +01:00
|
|
|
</sect3>
|
1998-12-18 17:17:29 +01:00
|
|
|
|
2000-11-11 14:53:49 +01:00
|
|
|
<sect3>
|
|
|
|
<title>Installing the <productname>DocBook</productname> <acronym>DTD</acronym> Kit</title>
|
1998-12-18 17:17:29 +01:00
|
|
|
|
2000-11-11 14:53:49 +01:00
|
|
|
<procedure>
|
|
|
|
<step>
|
|
|
|
<para>
|
2005-04-09 05:52:43 +02:00
|
|
|
Obtain the <ulink url="http://www.docbook.org/sgml/4.2/docbook-4.2.zip">
|
|
|
|
DocBook V4.2 distribution</ulink>.
|
2000-11-11 14:53:49 +01:00
|
|
|
</para>
|
|
|
|
</step>
|
1998-12-18 17:17:29 +01:00
|
|
|
|
2000-11-11 14:53:49 +01:00
|
|
|
<step>
|
|
|
|
<para>
|
2001-10-09 20:46:00 +02:00
|
|
|
Create the directory
|
2003-11-24 20:08:02 +01:00
|
|
|
<filename>/usr/local/share/sgml/docbook-4.2</filename> and change
|
2001-10-09 20:46:00 +02:00
|
|
|
to it. (The exact location is irrelevant, but this one is
|
2009-06-17 23:58:49 +02:00
|
|
|
reasonable within the layout we are following here.)
|
2000-11-11 14:53:49 +01:00
|
|
|
<screen>
|
2003-11-24 20:08:02 +01:00
|
|
|
<prompt>$ </prompt><userinput>mkdir /usr/local/share/sgml/docbook-4.2</userinput>
|
|
|
|
<prompt>$ </prompt><userinput>cd /usr/local/share/sgml/docbook-4.2</userinput>
|
2000-11-11 14:53:49 +01:00
|
|
|
</screen>
|
|
|
|
</para>
|
|
|
|
</step>
|
1998-12-18 17:17:29 +01:00
|
|
|
|
2000-11-11 14:53:49 +01:00
|
|
|
<step>
|
|
|
|
<para>
|
2009-04-27 18:27:36 +02:00
|
|
|
Unpack the archive:
|
2001-10-09 20:46:00 +02:00
|
|
|
<screen>
|
2003-11-24 20:08:02 +01:00
|
|
|
<prompt>$ </prompt><userinput>unzip -a ...../docbook-4.2.zip</userinput>
|
2001-10-09 20:46:00 +02:00
|
|
|
</screen>
|
|
|
|
(The archive will unpack its files into the current directory.)
|
2000-11-11 14:53:49 +01:00
|
|
|
</para>
|
|
|
|
</step>
|
1998-12-18 17:17:29 +01:00
|
|
|
|
2000-11-11 14:53:49 +01:00
|
|
|
<step>
|
|
|
|
<para>
|
2001-10-09 20:46:00 +02:00
|
|
|
Edit the file
|
2000-11-11 14:53:49 +01:00
|
|
|
<filename>/usr/local/share/sgml/catalog</filename> (or whatever
|
|
|
|
you told jade during installation) and put a line like this
|
|
|
|
into it:
|
|
|
|
<programlisting>
|
2003-11-24 20:08:02 +01:00
|
|
|
CATALOG "docbook-4.2/docbook.cat"
|
2000-11-11 14:53:49 +01:00
|
|
|
</programlisting>
|
|
|
|
</para>
|
2001-10-09 20:46:00 +02:00
|
|
|
</step>
|
1998-12-18 17:17:29 +01:00
|
|
|
|
2000-11-11 14:53:49 +01:00
|
|
|
<step>
|
|
|
|
<para>
|
2005-04-09 05:52:43 +02:00
|
|
|
Download the <ulink url="http://www.oasis-open.org/cover/ISOEnts.zip">
|
|
|
|
ISO 8879 character entities archive</ulink>, unpack it, and put the
|
2009-04-27 18:27:36 +02:00
|
|
|
files in the same directory you put the DocBook files in:
|
2001-10-09 20:46:00 +02:00
|
|
|
<screen>
|
2003-11-24 20:08:02 +01:00
|
|
|
<prompt>$ </prompt><userinput>cd /usr/local/share/sgml/docbook-4.2</userinput>
|
2001-10-09 20:46:00 +02:00
|
|
|
<prompt>$ </prompt><userinput>unzip ...../ISOEnts.zip</userinput>
|
|
|
|
</screen>
|
|
|
|
</para>
|
|
|
|
</step>
|
|
|
|
|
|
|
|
<step>
|
|
|
|
<para>
|
|
|
|
Run the following command in the directory with the DocBook and ISO files:
|
|
|
|
<programlisting>
|
|
|
|
perl -pi -e 's/iso-(.*).gml/ISO\1/g' docbook.cat
|
|
|
|
</programlisting>
|
|
|
|
(This fixes a mixup between the names used in the DocBook
|
|
|
|
catalog file and the actual names of the ISO character entity
|
|
|
|
files.)
|
2000-11-11 14:53:49 +01:00
|
|
|
</para>
|
|
|
|
</step>
|
|
|
|
</procedure>
|
|
|
|
</sect3>
|
2000-02-02 17:22:45 +01:00
|
|
|
</sect2>
|
2000-10-17 17:26:40 +02:00
|
|
|
|
2003-06-06 16:17:08 +02:00
|
|
|
<sect2 id="docguide-toolsets-configure">
|
|
|
|
<title>Detection by <command>configure</command></title>
|
1998-04-28 16:57:48 +02:00
|
|
|
|
1999-07-06 19:19:42 +02:00
|
|
|
<para>
|
2000-11-11 14:53:49 +01:00
|
|
|
Before you can build the documentation you need to run the
|
|
|
|
<filename>configure</filename> script as you would when building
|
2003-09-11 23:42:20 +02:00
|
|
|
the <productname>PostgreSQL</productname> programs themselves.
|
|
|
|
Check the output near the end of the run, it should look something
|
|
|
|
like this:
|
2000-11-11 14:53:49 +01:00
|
|
|
<screen>
|
|
|
|
<computeroutput>
|
|
|
|
checking for onsgmls... onsgmls
|
2003-11-24 20:08:02 +01:00
|
|
|
checking for DocBook V4.2... yes
|
2017-04-07 04:03:52 +02:00
|
|
|
checking for dbtoepub... dbtoepub
|
|
|
|
checking for xmllint... xmllint
|
2009-08-05 00:04:37 +02:00
|
|
|
checking for xsltproc... xsltproc
|
|
|
|
checking for osx... osx
|
2017-04-07 04:03:52 +02:00
|
|
|
checking for fop... fop
|
2000-11-11 14:53:49 +01:00
|
|
|
</computeroutput>
|
|
|
|
</screen>
|
|
|
|
If neither <filename>onsgmls</filename> nor
|
2009-08-05 00:04:37 +02:00
|
|
|
<filename>nsgmls</filename> were found then some of the following tests
|
2017-04-07 04:03:52 +02:00
|
|
|
will be skipped. <filename>nsgmls</filename> is part of the OpenSP
|
|
|
|
package. You can pass the environment variable
|
|
|
|
<envar>NSGMLS</envar> to configure to point
|
2006-10-23 16:13:43 +02:00
|
|
|
to the programs if they are not found automatically. If
|
|
|
|
<quote>DocBook V4.2</quote> was not found then you did not install
|
2017-04-07 04:03:52 +02:00
|
|
|
the DocBook DTD kit in a place where OpenSP can find it, or you have
|
2006-10-23 16:13:43 +02:00
|
|
|
not set up the catalog files correctly. See the installation hints
|
2017-04-07 04:03:52 +02:00
|
|
|
above.
|
1999-07-06 19:19:42 +02:00
|
|
|
</para>
|
1998-04-28 16:57:48 +02:00
|
|
|
|
2003-06-06 16:17:08 +02:00
|
|
|
</sect2>
|
|
|
|
</sect1>
|
|
|
|
|
|
|
|
<sect1 id="docguide-build">
|
|
|
|
<title>Building The Documentation</title>
|
|
|
|
|
1999-07-06 19:19:42 +02:00
|
|
|
<para>
|
2000-11-11 14:53:49 +01:00
|
|
|
Once you have everything set up, change to the directory
|
2003-06-06 16:17:08 +02:00
|
|
|
<filename>doc/src/sgml</filename> and run one of the commands
|
|
|
|
described in the following subsections to build the
|
|
|
|
documentation. (Remember to use GNU make.)
|
|
|
|
</para>
|
2000-11-11 14:53:49 +01:00
|
|
|
|
2003-06-06 16:17:08 +02:00
|
|
|
<sect2>
|
|
|
|
<title>HTML</title>
|
2000-11-11 14:53:49 +01:00
|
|
|
|
2003-06-06 16:17:08 +02:00
|
|
|
<para>
|
|
|
|
To build the <acronym>HTML</acronym> version of the documentation:
|
2000-11-11 14:53:49 +01:00
|
|
|
<screen>
|
2014-02-12 23:29:19 +01:00
|
|
|
<prompt>doc/src/sgml$ </prompt><userinput>make html</userinput>
|
2000-11-11 14:53:49 +01:00
|
|
|
</screen>
|
2009-08-10 00:47:59 +02:00
|
|
|
This is also the default target. The output appears in the
|
|
|
|
subdirectory <filename>html</filename>.
|
2003-06-06 16:17:08 +02:00
|
|
|
</para>
|
2000-11-11 14:53:49 +01:00
|
|
|
|
2015-07-29 17:16:55 +02:00
|
|
|
<para>
|
|
|
|
To produce HTML documentation with the stylesheet used on <ulink
|
2017-05-21 03:50:47 +02:00
|
|
|
url="https://www.postgresql.org/docs/current">postgresql.org</> instead of the
|
2015-07-29 17:16:55 +02:00
|
|
|
default simple style use:
|
|
|
|
<screen>
|
|
|
|
<prompt>doc/src/sgml$ </prompt><userinput>make STYLE=website html</userinput>
|
2007-01-09 23:19:36 +01:00
|
|
|
</screen>
|
2003-06-06 16:17:08 +02:00
|
|
|
</para>
|
2000-11-11 14:53:49 +01:00
|
|
|
</sect2>
|
1999-07-06 19:19:42 +02:00
|
|
|
|
2003-06-06 16:17:08 +02:00
|
|
|
<sect2>
|
1999-07-06 19:19:42 +02:00
|
|
|
<title>Manpages</title>
|
|
|
|
|
|
|
|
<para>
|
2009-08-05 00:04:37 +02:00
|
|
|
We use the DocBook XSL stylesheets to
|
1999-07-06 19:19:42 +02:00
|
|
|
convert <productname>DocBook</productname>
|
2003-06-06 16:17:08 +02:00
|
|
|
<sgmltag>refentry</sgmltag> pages to *roff output suitable for man
|
2000-11-11 14:53:49 +01:00
|
|
|
pages. The man pages are also distributed as a tar archive,
|
2003-06-06 16:17:08 +02:00
|
|
|
similar to the <acronym>HTML</acronym> version. To create the man
|
2008-09-12 10:43:53 +02:00
|
|
|
pages, use the commands:
|
2017-04-07 04:03:52 +02:00
|
|
|
<screen>
|
|
|
|
<prompt>doc/src/sgml$ </prompt><userinput>make man</userinput>
|
|
|
|
</screen>
|
1999-07-06 19:19:42 +02:00
|
|
|
</para>
|
2000-10-17 17:26:40 +02:00
|
|
|
</sect2>
|
1998-04-28 16:57:48 +02:00
|
|
|
|
2003-06-06 16:17:08 +02:00
|
|
|
<sect2>
|
2017-04-07 04:03:52 +02:00
|
|
|
<title>PDF</title>
|
1998-04-28 16:57:48 +02:00
|
|
|
|
2003-06-06 16:17:08 +02:00
|
|
|
<para>
|
2017-04-07 04:03:52 +02:00
|
|
|
To produce a PDF rendition of the documentation
|
|
|
|
using <productname>FOP</productname>, you can use one of the following
|
|
|
|
commands, depending on the preferred paper format:
|
1998-04-28 16:57:48 +02:00
|
|
|
|
2003-06-06 16:17:08 +02:00
|
|
|
<itemizedlist>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2017-04-07 04:03:52 +02:00
|
|
|
For A4 format:
|
2003-06-06 16:17:08 +02:00
|
|
|
<screen>
|
2017-04-07 04:03:52 +02:00
|
|
|
<prompt>doc/src/sgml$ </prompt><userinput>make postgres-A4.pdf</userinput>
|
2003-06-06 16:17:08 +02:00
|
|
|
</screen>
|
|
|
|
</para>
|
|
|
|
</listitem>
|
2010-11-23 21:27:50 +01:00
|
|
|
|
2003-06-06 16:17:08 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2017-04-07 04:03:52 +02:00
|
|
|
For U.S. letter format:
|
2006-12-10 21:46:03 +01:00
|
|
|
<screen>
|
2014-02-12 23:29:19 +01:00
|
|
|
<prompt>doc/src/sgml$ </prompt><userinput>make postgres-US.pdf</userinput>
|
2003-06-06 16:17:08 +02:00
|
|
|
</screen>
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</itemizedlist>
|
|
|
|
</para>
|
2006-12-10 03:37:40 +01:00
|
|
|
|
|
|
|
<para>
|
2017-04-07 04:03:52 +02:00
|
|
|
Because the PostgreSQL documentation is fairly
|
|
|
|
big, <productname>FOP</productname> will require a significant amount of
|
|
|
|
memory. Because of that, on some systems, the build will fail with a
|
|
|
|
memory-related error message. This can usually be fixed by configuring
|
|
|
|
Java heap settings in the configuration
|
|
|
|
file <filename>~/.foprc</filename>, for example:
|
2006-12-10 03:37:40 +01:00
|
|
|
<programlisting>
|
2017-04-07 04:03:52 +02:00
|
|
|
# FOP binary distribution
|
|
|
|
FOP_OPTS='-Xmx1000m'
|
|
|
|
# Debian
|
|
|
|
JAVA_ARGS='-Xmx1000m'
|
|
|
|
# Red Hat
|
|
|
|
ADDITIONAL_FLAGS='-Xmx1000m'
|
2006-12-10 03:37:40 +01:00
|
|
|
</programlisting>
|
2017-04-07 04:03:52 +02:00
|
|
|
There is a minimum amount of memory that is required, and to some extent
|
|
|
|
more memory appears to make things a bit faster. On systems with very
|
|
|
|
little memory (less than 1 GB), the build will either be very slow due to
|
|
|
|
swapping or will not work at all.
|
2006-12-10 03:37:40 +01:00
|
|
|
</para>
|
2010-06-01 00:14:20 +02:00
|
|
|
|
1999-05-27 17:49:08 +02:00
|
|
|
<para>
|
2017-04-07 04:03:52 +02:00
|
|
|
Other XSL-FO processors can also be used manually, but the automated build
|
|
|
|
process only supports FOP.
|
2000-02-02 17:22:45 +01:00
|
|
|
</para>
|
2000-10-17 17:26:40 +02:00
|
|
|
</sect2>
|
|
|
|
|
|
|
|
<sect2>
|
|
|
|
<title>Plain Text Files</title>
|
|
|
|
|
|
|
|
<para>
|
2014-02-11 02:48:04 +01:00
|
|
|
The installation instructions are also distributed as plain text,
|
|
|
|
in case they are needed in a situation where better reading tools
|
|
|
|
are not available. The <filename>INSTALL</filename> file
|
2003-06-06 16:17:08 +02:00
|
|
|
corresponds to <xref linkend="installation">, with some minor
|
|
|
|
changes to account for the different context. To recreate the
|
|
|
|
file, change to the directory <filename>doc/src/sgml</filename>
|
2014-02-12 23:29:19 +01:00
|
|
|
and enter <userinput>make INSTALL</userinput>.
|
2000-10-17 17:26:40 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2014-02-11 02:48:04 +01:00
|
|
|
In the past, the release notes and regression testing instructions
|
|
|
|
were also distributed as plain text, but this practice has been
|
|
|
|
discontinued.
|
2000-10-17 17:26:40 +02:00
|
|
|
</para>
|
2003-06-06 16:17:08 +02:00
|
|
|
</sect2>
|
2000-10-17 17:26:40 +02:00
|
|
|
|
2003-06-06 16:17:08 +02:00
|
|
|
<sect2>
|
|
|
|
<title>Syntax Check</title>
|
1999-05-27 17:49:08 +02:00
|
|
|
|
2003-06-06 16:17:08 +02:00
|
|
|
<para>
|
|
|
|
Building the documentation can take very long. But there is a
|
|
|
|
method to just check the correct syntax of the documentation
|
|
|
|
files, which only takes a few seconds:
|
|
|
|
<screen>
|
2014-02-12 23:29:19 +01:00
|
|
|
<prompt>doc/src/sgml$ </prompt><userinput>make check</userinput>
|
2003-06-06 16:17:08 +02:00
|
|
|
</screen>
|
|
|
|
</para>
|
1999-05-27 17:49:08 +02:00
|
|
|
</sect2>
|
1999-10-09 04:29:15 +02:00
|
|
|
</sect1>
|
1998-04-28 16:57:48 +02:00
|
|
|
|
2000-10-17 17:26:40 +02:00
|
|
|
|
2003-06-06 16:17:08 +02:00
|
|
|
<sect1 id="docguide-authoring">
|
2000-11-11 14:53:49 +01:00
|
|
|
<title>Documentation Authoring</title>
|
1998-04-28 16:57:48 +02:00
|
|
|
|
1999-10-09 04:29:15 +02:00
|
|
|
<para>
|
2000-11-11 14:53:49 +01:00
|
|
|
<acronym>SGML</acronym> and <productname>DocBook</productname> do
|
|
|
|
not suffer from an oversupply of open-source authoring tools. The
|
2002-03-22 20:20:45 +01:00
|
|
|
most common tool set is the
|
2000-11-11 14:53:49 +01:00
|
|
|
<productname>Emacs</productname>/<productname>XEmacs</productname>
|
|
|
|
editor with appropriate editing mode. On some systems
|
2001-10-09 20:46:00 +02:00
|
|
|
these tools are provided in a typical full installation.
|
1999-10-09 04:29:15 +02:00
|
|
|
</para>
|
1998-04-28 16:57:48 +02:00
|
|
|
|
2000-11-11 14:53:49 +01:00
|
|
|
<sect2>
|
|
|
|
<title>Emacs/PSGML</title>
|
1998-04-28 16:57:48 +02:00
|
|
|
|
1999-10-09 04:29:15 +02:00
|
|
|
<para>
|
2000-11-11 14:53:49 +01:00
|
|
|
<productname>PSGML</productname> is the most common and most
|
|
|
|
powerful mode for editing <acronym>SGML</acronym> documents.
|
|
|
|
When properly configured, it will allow you to use
|
|
|
|
<application>Emacs</application> to insert tags and check markup
|
2002-01-20 23:19:57 +01:00
|
|
|
consistency. You could use it for <acronym>HTML</acronym> as
|
2005-04-09 05:52:43 +02:00
|
|
|
well. Check the <ulink url="http://www.lysator.liu.se/projects/about_psgml.html">
|
|
|
|
PSGML web site</ulink> for downloads, installation instructions, and
|
2000-11-11 14:53:49 +01:00
|
|
|
detailed documentation.
|
1999-10-09 04:29:15 +02:00
|
|
|
</para>
|
1998-04-28 16:57:48 +02:00
|
|
|
|
1999-10-09 04:29:15 +02:00
|
|
|
<para>
|
2000-11-11 14:53:49 +01:00
|
|
|
There is one important thing to note with
|
|
|
|
<productname>PSGML</productname>: its author assumed that your
|
|
|
|
main <acronym>SGML</acronym> <acronym>DTD</acronym> directory
|
|
|
|
would be <filename>/usr/local/lib/sgml</filename>. If, as in the
|
|
|
|
examples in this chapter, you use
|
|
|
|
<filename>/usr/local/share/sgml</filename>, you have to
|
|
|
|
compensate for this, either by setting
|
|
|
|
<envar>SGML_CATALOG_FILES</envar> environment variable, or you
|
|
|
|
can customize your <productname>PSGML</productname> installation
|
|
|
|
(its manual tells you how).
|
1999-10-09 04:29:15 +02:00
|
|
|
</para>
|
1998-10-30 20:37:19 +01:00
|
|
|
|
1999-10-09 04:29:15 +02:00
|
|
|
<para>
|
2000-11-11 14:53:49 +01:00
|
|
|
Put the following in your <filename>~/.emacs</filename>
|
|
|
|
environment file (adjusting the path names to be appropriate for
|
|
|
|
your system):
|
1999-10-09 04:29:15 +02:00
|
|
|
|
2000-11-11 14:53:49 +01:00
|
|
|
<programlisting>
|
|
|
|
; ********** for SGML mode (psgml)
|
1999-10-09 04:29:15 +02:00
|
|
|
|
2000-11-11 14:53:49 +01:00
|
|
|
(setq sgml-omittag t)
|
|
|
|
(setq sgml-shorttag t)
|
|
|
|
(setq sgml-minimize-attributes nil)
|
|
|
|
(setq sgml-always-quote-attributes t)
|
|
|
|
(setq sgml-indent-step 1)
|
|
|
|
(setq sgml-indent-data t)
|
|
|
|
(setq sgml-parent-document nil)
|
|
|
|
(setq sgml-exposed-tags nil)
|
|
|
|
(setq sgml-catalog-files '("/usr/local/share/sgml/catalog"))
|
1999-10-09 04:29:15 +02:00
|
|
|
|
2000-11-11 14:53:49 +01:00
|
|
|
(autoload 'sgml-mode "psgml" "Major mode to edit SGML files." t )
|
|
|
|
</programlisting>
|
1998-10-30 20:37:19 +01:00
|
|
|
|
2000-11-11 14:53:49 +01:00
|
|
|
and in the same file add an entry for <acronym>SGML</acronym>
|
|
|
|
into the (existing) definition for
|
|
|
|
<varname>auto-mode-alist</varname>:
|
|
|
|
<programlisting>
|
|
|
|
(setq
|
|
|
|
auto-mode-alist
|
|
|
|
'(("\\.sgml$" . sgml-mode)
|
|
|
|
))
|
|
|
|
</programlisting>
|
1999-10-09 04:29:15 +02:00
|
|
|
</para>
|
1998-04-28 16:57:48 +02:00
|
|
|
|
1999-10-09 04:29:15 +02:00
|
|
|
<para>
|
Update documentation on may/can/might:
Standard English uses "may", "can", and "might" in different ways:
may - permission, "You may borrow my rake."
can - ability, "I can lift that log."
might - possibility, "It might rain today."
Unfortunately, in conversational English, their use is often mixed, as
in, "You may use this variable to do X", when in fact, "can" is a better
choice. Similarly, "It may crash" is better stated, "It might crash".
Also update two error messages mentioned in the documenation to match.
2007-01-31 21:56:20 +01:00
|
|
|
You might find that when using <productname>PSGML</productname>, a
|
2004-02-17 03:53:03 +01:00
|
|
|
comfortable way of working with these separate files of book
|
|
|
|
parts is to insert a proper <literal>DOCTYPE</literal>
|
|
|
|
declaration while you're editing them. If you are working on
|
|
|
|
this source, for instance, it is an appendix chapter, so you
|
|
|
|
would specify the document as an <quote>appendix</quote> instance
|
|
|
|
of a DocBook document by making the first line look like this:
|
2000-11-11 14:53:49 +01:00
|
|
|
|
|
|
|
<programlisting>
|
2003-11-24 20:08:02 +01:00
|
|
|
<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.2//EN">
|
2000-11-11 14:53:49 +01:00
|
|
|
</programlisting>
|
|
|
|
|
|
|
|
This means that anything and everything that reads
|
|
|
|
<acronym>SGML</acronym> will get it right, and I can verify the
|
|
|
|
document with <command>nsgmls -s docguide.sgml</command>. (But
|
|
|
|
you need to take out that line before building the entire
|
|
|
|
documentation set.)
|
1999-10-09 04:29:15 +02:00
|
|
|
</para>
|
2000-11-11 14:53:49 +01:00
|
|
|
</sect2>
|
|
|
|
|
|
|
|
<sect2>
|
2011-01-29 19:00:18 +01:00
|
|
|
<title>Other Emacs Modes</title>
|
1998-04-28 16:57:48 +02:00
|
|
|
|
1999-10-09 04:29:15 +02:00
|
|
|
<para>
|
2004-02-17 03:53:03 +01:00
|
|
|
<productname>GNU Emacs</productname> ships with a different
|
|
|
|
<acronym>SGML</acronym> mode, which is not quite as powerful as
|
2000-11-11 14:53:49 +01:00
|
|
|
<productname>PSGML</productname>, but it's less confusing and
|
|
|
|
lighter weight. Also, it offers syntax highlighting (font lock),
|
|
|
|
which can be very helpful.
|
2010-10-14 20:32:45 +02:00
|
|
|
<filename>src/tools/editors/emacs.samples</filename> contains
|
|
|
|
sample settings for this mode.
|
1999-10-09 04:29:15 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2005-04-09 05:52:43 +02:00
|
|
|
Norm Walsh offers a
|
|
|
|
<ulink url="http://nwalsh.com/emacs/docbookide/index.html">major mode</ulink>
|
2010-11-23 21:27:50 +01:00
|
|
|
specifically for DocBook which also has font-lock and a number of features to
|
2005-04-09 05:52:43 +02:00
|
|
|
reduce typing.
|
1999-10-09 04:29:15 +02:00
|
|
|
</para>
|
2000-11-11 14:53:49 +01:00
|
|
|
</sect2>
|
1998-04-28 16:57:48 +02:00
|
|
|
|
1999-10-09 04:29:15 +02:00
|
|
|
</sect1>
|
1998-04-28 16:57:48 +02:00
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
|
2003-06-06 16:17:08 +02:00
|
|
|
<sect1 id="docguide-style">
|
2002-07-28 17:22:21 +02:00
|
|
|
<title>Style Guide</title>
|
|
|
|
|
|
|
|
<sect2>
|
|
|
|
<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
|
Update documentation on may/can/might:
Standard English uses "may", "can", and "might" in different ways:
may - permission, "You may borrow my rake."
can - ability, "I can lift that log."
might - possibility, "It might rain today."
Unfortunately, in conversational English, their use is often mixed, as
in, "You may use this variable to do X", when in fact, "can" is a better
choice. Similarly, "It may crash" is better stated, "It might crash".
Also update two error messages mentioned in the documenation to match.
2007-01-31 21:56:20 +01:00
|
|
|
can be omitted. Additional top-level sections should only be used
|
2002-07-28 17:22:21 +02:00
|
|
|
in special circumstances; often that information belongs in the
|
|
|
|
<quote>Usage</quote> section.
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
|
|
<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>
|
|
|
|
<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>
|
2010-11-23 21:27:50 +01:00
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term>Description</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Several paragraphs explaining what the command does.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2010-11-23 21:27:50 +01:00
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term>Options</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
A list describing each command-line option. If there are a
|
Update documentation on may/can/might:
Standard English uses "may", "can", and "might" in different ways:
may - permission, "You may borrow my rake."
can - ability, "I can lift that log."
might - possibility, "It might rain today."
Unfortunately, in conversational English, their use is often mixed, as
in, "You may use this variable to do X", when in fact, "can" is a better
choice. Similarly, "It may crash" is better stated, "It might crash".
Also update two error messages mentioned in the documenation to match.
2007-01-31 21:56:20 +01:00
|
|
|
lot of options, subsections can be used.
|
2002-07-28 17:22:21 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2010-11-23 21:27:50 +01:00
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term>Exit Status</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
If the program uses 0 for success and non-zero for failure,
|
2003-02-19 05:06:28 +01:00
|
|
|
then you do not need to document it. If there is a meaning
|
2002-07-28 17:22:21 +02:00
|
|
|
behind the different non-zero exit codes, list them here.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2010-11-23 21:27:50 +01:00
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
<varlistentry>
|
|
|
|
<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>
|
2010-11-23 21:27:50 +01:00
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term>Environment</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
List all environment variables that the program might use.
|
|
|
|
Try to be complete; even seemingly trivial variables like
|
|
|
|
<envar>SHELL</envar> might be of interest to the user.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2010-11-23 21:27:50 +01:00
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
<varlistentry>
|
|
|
|
<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>
|
2010-11-23 21:27:50 +01:00
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
<varlistentry>
|
|
|
|
<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>
|
2010-11-23 21:27:50 +01:00
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term>Notes</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Anything that doesn't fit elsewhere, but in particular bugs,
|
|
|
|
implementation flaws, security considerations, compatibility
|
|
|
|
issues.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2010-11-23 21:27:50 +01:00
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term>Examples</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Examples
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2010-11-23 21:27:50 +01:00
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
<varlistentry>
|
|
|
|
<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>
|
2010-11-23 21:27:50 +01:00
|
|
|
|
2012-05-09 19:39:53 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term>Author</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Author (only used in the contrib section)
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
<varlistentry>
|
|
|
|
<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,
|
2003-09-13 00:17:24 +02:00
|
|
|
Outputs, Notes, Examples, Compatibility, History, See
|
2002-07-28 17:22:21 +02:00
|
|
|
Also. The Parameters section is like the Options section, but
|
|
|
|
there is more freedom about which clauses of the command can be
|
2003-09-13 00:17:24 +02:00
|
|
|
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
|
2002-07-28 17:22:21 +02:00
|
|
|
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>
|
1998-04-28 16:57:48 +02:00
|
|
|
</appendix>
|