아래 도구들은 문서 작업에 필요하다. 몇몇은 선택적으로 필요하기도 하다.
DocBook 문서 형식 정의 파일이다. PostgreSQL 문서는 4.5 버전을 사용하다. 다른 버전을 사용할 수 없다. DocBook DTD의 XML 패키지들이 필요하다.
DocBook 소스를 HTML과 같은 다른 문서 형태로 변환 할 때 필요하다.
1.77.0 버전 이상을 필요로 하나, 보다 나은 환경은 사용 가능한 최신 버전을 사용한다.
xmllint
This library and the xmllint
tool it contains are
used for processing XML. Many developers will already
have Libxml2 installed, because it is also
used when building the PostgreSQL code. Note, however,
that xmllint
might need to be installed from a
separate subpackage.
xsltproc
사용하기 위한 LibxsltXSLT 스타일시트를 이용한 처리 도구다. 이 프로그램은 XSLT 스타일시트를 이용해 XML 문서를 여러 다른 양식으로 변환하는데 사용한다.
XML 문서를 PDF 문서로 변환하는데 사용한다.
아래 내용은 문서 작업을 하면서 겪은 여러 경험들을 소개한 것이다. 여기에는 여러 패키지들을 설치할 때의 문제와 사용할 때의 문제를 설명하고 있다. 이곳에 없는 여러 문제점들이 발견되면, 문서 메일링 리스트를 통해 알려주면, 이 문서에 계속 추가할 것이다.
DocBook XML, DocBook XSLT 스타일시트를 굳이 설치할 필요는 없다. 이들은
작업 중에 온라인으로 다운로드 받고, 캐시로 보관해서 사용하기 때문이다. 이
방법은 사용 환경이 옛 버전만 이용할 수 있는 환경에서 좋은 해결책이다. 이와
달리 배포판에서 제공하는 옛 패키지를 이용하거나,
인터넷 외부 접속 환경이 아닌 경우에는
xmllint
, xsltproc
명령의
--nonet
옵션을 사용할 수 있다. 사용법은 아래 예제에서
다룬다.
관련 패키지를 설치하기 위해서는 다음 명령을 실행한다:
yum install docbook-dtds docbook-style-xsl fop libxslt
설치할 RPM 패키지 이름은 각 리눅스 배포판 마다 약간씩 차이가 있다. 참고로, RedHat 계열(Enterprise Linux, CentOS)은 openjade, opensp, docbook-dtds, docbook-utils, docbook-style-dsssl, sgml-common 패키지들이 필요하다.
To install the required packages with pkg
, use:
pkg install docbook-xml docbook-xsl fop libxslt
When building the documentation from the doc
directory you'll need to use gmake
, because the
makefile provided is not suitable for FreeBSD's make
.
Debian GNU/Linux에서는 다음 패키지들을 설치하면 된다. 간단하게:
apt-get install docbook-xml docbook-xsl fop libxml2-utils xsltproc
On macOS, you can build the HTML and man documentation without installing anything extra. If you want to build PDFs or want to install a local copy of DocBook, you can get those from your preferred package manager.
If you use MacPorts, the following will get you set up:
sudo port install docbook-xml-4.5 docbook-xsl fop
If you use Homebrew, use this:
brew install docbook docbook-xsl fop
configure
명령으로 확인
문서 파일을 만들기 전에 필요한 패키지들이 모두 있는지
확인 하는 방법은 PostgreSQL
소스 디렉터리에서 configure
명령을
실행해 보면 된다. 이 명령을 실행하면, 다음과
비슷한 내용이 출력된다. 이를 확인 해 보고, 적당한 작업(
해당 프로그램이 없다고 나온다면, 그 프로그램이 있는
경로를 지정한다든가, 적당한 패키지를 설치한다든가)을
한다:
checking for xmllint... xmllint checking for xsltproc... xsltproc checking for fop... fop checking for dbtoepub... dbtoepub
xmllint
또는 xsltproc
파일이 없다면, 문서 만들기 작업을 할 수 없다.
fop
파일이 없다면, PDF 파일로 만들 수 없다.
dbtoepub
파일은 EPUB 형식 문서파일을 만드는데 사용된다.
필요하다면, configure
작업에서 이들 프로그램을
아래와 같이 직접 지정할 수 있다.
./configure ... XMLLINT=/opt/local/bin/xmllint ...
또, 인터넷 연결이 불가능한 상태라면, xmllint
,
xsltproc
지정에서 다음과 같이 옵션을
지정할 수도 있다.
./configure ... XMLLINT="xmllint --nonet" XSLTPROC="xsltproc --nonet" ...