J.3. Building the Documentation with Make#
Once you have everything set up, change to the directorydoc/src/sgml and run one of the commands described in the following subsections to build the documentation. (Remember to use GNU make.)
J.3.1. HTML#
To build theHTML version of the documentation: This is also the default target. The output appears in the subdirectory To produce HTML documentation with the stylesheet used onpostgresql.org instead of the default simple style use: If thedoc/src/sgml$make htmlhtml.doc/src/sgml$make STYLE=website htmlSTYLE=website option is used, the generated HTML files include references to stylesheets hosted onpostgresql.org and require network access to view.
J.3.2. Manpages#
We use the DocBook XSL stylesheets to convertDocBookrefentry pages to *roff output suitable for man pages. To create the man pages, use the command:
doc/src/sgml$make man
J.3.3. PDF#
To produce a PDF rendition of the documentation usingFOP, you can use one of the following commands, depending on the preferred paper format:
For A4 format:
doc/src/sgml$make postgres-A4.pdfFor U.S. letter format:
doc/src/sgml$make postgres-US.pdf
Because the PostgreSQL documentation is fairly big,FOP 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~/.foprc, for example:
# FOP binary distributionFOP_OPTS='-Xmx1500m'# DebianJAVA_ARGS='-Xmx1500m'# Red HatADDITIONAL_FLAGS='-Xmx1500m'
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.
In its default configurationFOP will emit anINFO message for each page. The log level can be changed via~/.foprc:
LOGCHOICE=-Dorg.apache.commons.logging.Log=org.apache.commons.logging.impl.SimpleLogLOGLEVEL=-Dorg.apache.commons.logging.simplelog.defaultlog=WARN
Other XSL-FO processors can also be used manually, but the automated build process only supports FOP.
J.3.4. Syntax Check#
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:
doc/src/sgml$make check