PostgreSQLLa base de données la plus sophistiquée au monde.
Documentation PostgreSQL 16.2 » Annexes » Documentation » Ensemble d'outils

J.2. Ensemble d'outils #

Les outils qui suivent sont utilisés pour produire la documentation. Certains sont optionnels (comme mentionné).

DTD DocBook #

Il s'agit de la définition de DocBook elle-même. C'est actuellement la version 4.5 qui est utilisée. Vous avez besoin de la variante XML de la DTD DocBook, et non pas SGML, de même version. Ils seront généralement dans des paquets séparés.

DocBook XSL Stylesheets #

Ils contiennent les instructions de traitement pour convertir les sources DocBook vers d'autres formats, comme par exemple le HTML.

La version minimale requise est actuellement la 1.77.0, mais il est recommandé d'utiliser la dernière version disponibles pour de meilleurs résultats.

Libxml2 for xmllint #

Cette bibliothèque et l'outil xmllint qu'il contient sont utilisés pour traiter du XML. Beaucoup de développeurs ont déjà Libxml2 installé car il est aussi utilisé lors de la compilation de PostgreSQL. Néanmoins, notez que xmllint doit être installé à partir d'un sous-paquet séparé.

Libxslt pour xsltproc #

xsltproc est un processeur XSLT, c'est-à-dire, un programme pour convertir le XML vers d'autres formats en utilisant de fichiers de style XSLT.

FOP #

Il s'agit d'un programme pour convertir, entre autres choses, du XML vers du PDF. Il est uniquement nécessaire si vous voulez construire la documentation au format PDF.

Différentes méthodes d'installation sont détaillées ci-après pour les divers outils nécessaires au traitement de la documentation. Il peut exister d'autres types de distributions empaquetées de ces outils. Tout changement du statut d'un paquetage peut être rapportée auprès de la liste de discussion de la documentation, afin d'inclure ces informations ici-même.

J.2.1. Installation sur Fedora, RHEL et dérivés #

Pour installer les packages requis, lancez :

yum install docbook-dtds docbook-style-xsl libxslt fop
    

J.2.2. Installation sur FreeBSD #

Pour installer les paquets requis avec pkg, utiliser :

pkg install docbook-xml docbook-xsl libxslt fop
    

Quand vous compilez la documentation depuis le répertoire doc vous aurez besoin d'utiliser gmake, car le makefile fourni n'est pas correct pour le make de FreeBSD.

J.2.3. Paquetages Debian #

Un ensemble complet de paquetages d'outils de documentation est disponible pour Debian GNU/Linux. Pour l'installer, il suffit de taper :

apt-get install docbook-xml docbook-xsl libxml2-utils xsltproc fop
    

J.2.4. macOS #

Si vous utilisez MacPorts, les commandes suivantes vous aideront à la configuration du système :

sudo port install docbook-xml docbook-xsl-nons libxslt fop

Si vous utilisez Homebrew, utilisez plutôt ceci :

brew install docbook docbook-xsl libxslt fop

Le programme fourni par Homebrew requiert la configuration de la variable d'environnement suivante :

export XML_CATALOG_FILES=/usr/local/etc/xml/catalog

Sur les machines Apple Silicon, utilisez ceci :

export XML_CATALOG_FILES=/opt/homebrew/etc/xml/catalog

Sans cela, xsltproc renverra ce genre d'erreurs :

I/O error : Attempt to load network entity http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd
postgres.sgml:21: warning: failed to load external entity "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
...
    

Alors qu'il est possible d'utiliser les versions fournies par Apple de xmllint et xsltproc à la place de celles fournies par MacPorts ou Homebrew, vous aurez toujours besoin d'installer les DTD et feuilles de style DocBook, et de configurer un fichier catalogue qui pointe vers eux.

J.2.5. Détection par configure #

Avant de pouvoir construire la documentation, le script configure doit être lancé, comme cela se fait pour la construction des programmes PostgreSQL eux-mêmes. La fin de l'affichage de l'exécution de ce script doit ressembler à :

checking for xmllint... xmllint
checking for xsltproc... xsltproc
checking for fop... fop
checking for dbtoepub... dbtoepub

Si xmllint ou xsltproc est introuvable, vous ne pourrez pas construire la documentation. fop est seulement nécessaire pour construire la documentation en PDF. dbtoepub est seulement nécessaire pour construire la documentation en EPUB.

Si nécessaire, vous pouvez indiquer à configure où trouver ces programmes, par exemple

./configure ... XMLLINT=/opt/local/bin/xmllint ...

Si vous préférez construire PostgreSQL en utilisant Meson, exécutez à la place meson setup comme décrit dans Section 17.4, et ensuite allez voir Section J.4.