PostgreSQL 編譯文檔

要編譯文檔的HTML版本：

doc/src/sgml$ make html

這也是默認(rèn)的目標(biāo)。這個命令的輸出將出現(xiàn)在子目錄html中。

要用postgresql.org所使用的樣式表 而不是默認(rèn)的簡單樣式生成 HTML 文檔：

doc/src/sgml$ make STYLE=website html

如果使用STYLE=website選項，生成的 HTML 文件包括對托管在postgresql.org 上的樣式表的引用，需要網(wǎng)絡(luò)訪問來查看。

我們使用 DocBook XSL 樣式表來把DocBook refentry頁轉(zhuǎn)換成適合于手冊頁的 *roff 輸出。要創(chuàng)建手冊頁，使用命令：

doc/src/sgml$ make man

要使用FOP產(chǎn)生文檔的PDF版本，可以使用下列命令之一，取決于你喜歡的紙張格式：

因為PostgreSQL文檔很大，FOP會要求可觀的內(nèi)存量。因此，在一些系統(tǒng)上，構(gòu)建過程將會由于內(nèi)存相關(guān)的錯誤而失敗。通?？梢酝ㄟ^在配置文件~/.foprc中配置Java的堆設(shè)置來解決這類問題，例如：

# FOP binary distribution
FOP_OPTS='-Xmx1500m'
# Debian
JAVA_ARGS='-Xmx1500m'
# Red Hat
ADDITIONAL_FLAGS='-Xmx1500m'

這是所要求的最小內(nèi)存量，當(dāng)然更多的內(nèi)存會讓編譯過程更快一些。在內(nèi)存非常?。ㄐ∮?GB）的系統(tǒng)上，編譯過程會因為磁盤交換而非常慢或者根本就不工作。

也可以手工使用其他XSL-FO處理器，但是自動編譯過程僅支持FOP。

安裝指導(dǎo)也被發(fā)布為純文本，它們被用于那些沒有好的閱讀工具的情況。INSTALL文件對應(yīng)于第 16 章，但針對不同的環(huán)境做了小幅修改。要重建該文件，切換到目錄doc/src/sgml并輸入 make INSTALL 。 編譯文本輸出需要Pandoc 1.13或更高版本作為附加編譯工具。

在過去，發(fā)行注記和回歸測試指導(dǎo)也被作為純文本發(fā)布，但是事實上已經(jīng)沒有這樣做了。

編譯文檔可能會花很長時間。但是有辦法只檢查文檔中的語法，這個過程只需要數(shù)秒：

doc/src/sgml$ make check