.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "PO4A-BUILD.CONF 5"
.TH PO4A-BUILD.CONF 5 "2018-05-27" "Outils po4a" "Outils po4a"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NOM"
.IX Header "NOM"
po4a\-build.conf \- Fichier de configuration pour la construction des contenus
traduits
.SH "Introduction"
.IX Header "Introduction"
\&\fIpo4a\-build.conf\fR décrit comment \f(CW\*(C`po4a\-build\*(C'\fR devrait construire la
documentation traduite ou non à partir d’un jeu de documents sources et des
fichiers \s-1PO\s0 correspondants.
.PP
Tous les formats pris en charge, dans toutes les combinaisons possibles,
peuvent être traités avec un unique fichier de configuration
\&\fIpo4a\-build.conf\fR et par un seul appel à \f(CW\*(C`po4a\-build\*(C'\fR. Toutefois, il est
possible de séparer les répertoires \fIpo/\fR, chacun avec un fichier de
configuration, appelé par \f(CW\*(C`po4a\-build \-f FICHIER\*(C'\fR.
.PP
Remarquez que même si \fIpo4a\-build\fR permet d’ajouter la prise en charge par
gettext de la traduction des messages de sortie de script,
\&\fIpo4a\-build.conf\fR lui\-même n’a pas de relation avec ces
traductions. \fIpo4a\-build.conf\fR ne se rapporte qu’à la traduction de contenu
statique comme les pages de manuel.
.PP
Pour la prise en charge par \fIpo4a\-build\fR de la traduction des messages
affichés pendant l’exécution, voir \fIpo4a\-runtime\fR\|(7).
.SH "Formats pris en charge"
.IX Header "Formats pris en charge"
Actuellement, il est possible d’utiliser \f(CW\*(C`po4a\-build\*(C'\fR pour les combinaisons
suivantes :
.IP "\s-1XML\s0 DocBook vers section 1 et 3" 4
.IX Item "XML DocBook vers section 1 et 3"
\&\s-1XML\s0 DocBook est utilisé pour les pages de manuel des scripts shell ou
d’autres interpréteurs qui n’ont pas leur propre format de documentation
comme \s-1POD.\s0 \f(CW\*(C`doclifter\*(C'\fR(1) permet de transformer une page de manuel
existante en un \s-1XML\s0 correct et \f(CW\*(C`po4a\-build\*(C'\fR créera alors un fichier \s-1POT\s0
sans effort supplémentaire. Le fichier \s-1POT\s0 peut ensuite être proposé aux
traducteurs et les fichiers \s-1PO\s0 ajoutés dans le répertoire \fIpo/\fR
adéquat. \f(CW\*(C`po4a\-build\*(C'\fR préparera alors non seulement la page de manuel non
traduite à partir du \s-1XML\s0 issu de \f(CW\*(C`doclifter\*(C'\fR, mais utilisera aussi \f(CW\*(C`po4a\*(C'\fR
pour préparer les \s-1XML\s0 traduits à partir des fichiers \s-1PO,\s0 puis construira les
pages de manuel traduites à partir des \s-1XML.\s0
.Sp
Les pages de manuel sont créées en utilisant docbook-xsl \- la feuille de
style utilisée peut être modifiée avec \f(CW\*(C`XSLFILE\*(C'\fR dans le fichier de
configuration de \f(CW\*(C`po4a\-build\*(C'\fR.
.IP "\s-1XML\s0 DocBook vers \s-1HTML\s0" 4
.IX Item "XML DocBook vers HTML"
La feuille de style utilisée pour préparer le \s-1HTML\s0 final peut être modifiée
avec \f(CW\*(C`HTMLXSL\*(C'\fR dans le fichier de configuration de \f(CW\*(C`po4a\-build\*(C'\fR.
.IP "\s-1POD\s0 vers section 1, 3, 5 et 7" 4
.IX Item "POD vers section 1, 3, 5 et 7"
pod2man permet de convertir le contenu \s-1POD\s0 pour toutes les sections gérées.
.Sp
Utiliser \f(CW\*(C`PODFILE\*(C'\fR pour la section 1, \f(CW\*(C`PODMODULES\*(C'\fR pour la section 3,
\&\f(CW\*(C`POD5FILES\*(C'\fR pour la section 5 et \f(CW\*(C`POD7FILES\*(C'\fR pour la section 7.
.Sp
Pour les contenus des sections 5 et 7 (qui ont souvent besoin d’un nom de
fichier déjà utilisé par un contenu de la section 1), si le 5 ou 7 fait
partie du nom de fichier, il (ainsi que toute extension de fichier) sera
automatiquement enlevé.
.Sp
Par exemple pour préparer \fI/usr/share/man/man7/po4a.7.gz\fR :
.Sp
.Vb 2
\& # fichiers POD pour la section 7
\& POD7FILES="doc/po4a.7.pod"
.Ve
.SH "Syntaxe du fichier"
.IX Header "Syntaxe du fichier"
L’ordre des valeurs dans le fichier de configuration est sans importance.
.PP
Tout ce qui suit le caractère « # » sur une ligne est ignoré.
.PP
Toute valeur destinée à rester vide peut être enlevée du fichier.
.PP
Certains champs de configuration sont obligatoires \- \fIpo4a\-build\fR risque de
se terminer sans rien faire si des champs obligatoires sont laissés vides.
.IP "\s-1CONFIG\s0" 4
.IX Item "CONFIG"
Obligatoire.
.Sp
Nom et emplacement du fichier de configuration (temporaire) de \f(CW\*(C`po4a\*(C'\fR que
\&\f(CW\*(C`po4a\-build\*(C'\fR va créer et maintenir. Ce fichier n’a pas besoin d’exister
dans le système de gestion de version (\s-1VCS\s0) et peut être effacé sans risque
pendant la construction du paquet.
.Sp
.Vb 2
\& # nom et emplacement du fichier de configuration
\& CONFIG="_build/po4a.config"
.Ve
.IP "\s-1PODIR\s0" 4
.IX Item "PODIR"
Obligatoire.
.Sp
Répertoire contenant les fichiers \s-1PO\s0 de toutes les traductions prises en
charge par ce fichier de configuration. Toutes les chaînes doivent être
rassemblées dans un fichier \s-1POT\s0 de ce répertoire et tous les fichiers \s-1PO\s0
fusionnés avec ce fichier \s-1POT.\s0 Tout seuil à dépasser \s-1KEEP\s0 (voir plus bas)
sera respecté pour toutes les chaînes de tous les fichiers d’entrée indiqués
dans ce fichier et tous les fichiers \s-1PO\s0 de ce répertoire. Le répertoire ne
doit pas forcément s’appeler « po ». Remarquez cependant que certains outils
de statistiques s’attendent à trouver ce nom, il est donc conseillé de le
garder.
.Sp
.Vb 2
\& # répertoire po pour les pages de manuel et la documentation
\& PODIR="po/pod"
.Ve
.IP "\s-1POTFILE\s0" 4
.IX Item "POTFILE"
Obligatoire.
.Sp
Chemin vers le fichier \s-1POT\s0 (par rapport à l’emplacement de ce fichier de
configuration) qui sera créé, maintenu et mis à jour, par \f(CW\*(C`po4a\-build\*(C'\fR pour
ces traductions.
.Sp
.Vb 2
\& # chemin vers le fichier POT
\& POTFILE="po/pod/po4a\-pod.pot"
.Ve
.IP "\s-1BASEDIR\s0" 4
.IX Item "BASEDIR"
Obligatoire.
.Sp
Répertoire de base où placer le contenu traduit.
.Sp
.Vb 2
\& # répertoire de base pour les fichiers créés, par exemple la documentation
\& BASEDIR="_build"
.Ve
.IP "\s-1BINARIES\s0" 4
.IX Item "BINARIES"
Obligatoire.
.Sp
Même si un seul paquet binaire est construit, au moins une valeur est
obligatoire ici.
.Sp
La chaîne elle même est arbitraire mais comporte généralement le nom du
paquet. Le contenu créé apparaîtra ensuite dans un sous\-répertoire de
\&\fI\s-1BASEDIR/BINARIES\s0\fR :
.Sp
.Vb 1
\& _build/po4a/man/man1/foo.1
.Ve
.Sp
Si le paquet construit plus d’un paquet binaire (c’est\-à\-dire un paquet
source et de multiples fichiers .deb ou .rpm), ce champ permet d’isoler le
contenu destiné à chaque cible, facilitant l’automatisation du processus de
construction.
.Sp
Les chaînes sont séparées par des espaces.
.Sp
.Vb 2
\& # paquets binaires contenant les pages de manuel créées
\& BINARIES="po4a"
.Ve
.IP "\s-1KEEP\s0" 4
.IX Item "KEEP"
Valeur fournie directement à \f(CW\*(C`po4a \-k\*(C'\fR pour indiquer le seuil (en pourcent)
de traduction exact en dessous duquel une traduction doit être omise de la
construction. Si laissé vide, la valeur par défaut (80) est utilisé. Zéro
permet de forcer l’intégration de tous les contenus, même s’ils ne sont pas
traduits du tout.
.Sp
Pour contrôler parfaitement un tel comportement, veuillez choisir avec
précaution les fichiers à gérer par chaque fichier de configuration
\&\fIpo4a\-build.conf\fR.
.Sp
Rassembler beaucoup de fichiers dans un seul fichier \s-1POT\s0 peut être plus
pratique pour les traducteurs, en particulier si les fichiers ont des
chaînes en commun. Inversement, des fichiers \s-1POT\s0 avec des milliers de
longues chaînes sont redoutables pour les traducteurs, et mènent
généralement à de longs gels des messages (« string freeze »).
.Sp
.Vb 2
\& # seuil à dépasser pour que le fichier créé soit conservé
\& KEEP=
.Ve
.IP "\s-1XMLMAN1\s0" 4
.IX Item "XMLMAN1"
Fichiers \s-1XML\s0 DocBook pour créer les pages de manuel de la section 1. Les
noms des fichiers sont séparés par des espaces. Tous les fichiers
nécessaires doivent être dans le répertoire \s-1XMLDIR.\s0
.Sp
C’est une pratique courante d’intégrer plusieurs fichiers \s-1XML\s0 dans un livre,
afin de fournir une table des matières, etc. Si le livre contient des
fichiers aussi indiqués dans \s-1XMLMAN3,\s0 indiquez ici seulement les fichiers
pour la section 1, pas le livre lui\-même. Si le livre contient uniquement du
contenu à destination de la section 1, indiquez seulement le fichier du
livre.
.Sp
.Vb 2
\& # fichiers XML DocBook pour la section 1
\& XMLMAN1="po4a\-build.xml po4aman\-display\-po.xml po4apod\-display\-po.xml"
.Ve
.IP "\s-1XMLMAN3\s0" 4
.IX Item "XMLMAN3"
Fichiers \s-1XML\s0 DocBook pour créer les pages de manuel de la section 3. Les
noms des fichiers sont séparés par des espaces. Tous les fichiers
nécessaires doivent être dans le répertoire \s-1XMLDIR.\s0
.Sp
C’est une pratique courante d’intégrer plusieurs fichiers \s-1XML\s0 dans un livre,
afin de fournir une table des matières, etc. Si le livre contient des
fichiers aussi indiqués dans \s-1XMLMAN1,\s0 indiquez ici seulement les fichiers
pour la section 3, pas le livre lui\-même. Si le livre contient uniquement du
contenu à destination de la section 1, indiquez seulement le fichier du
livre.
.Sp
.Vb 2
\& # fichiers XML DocBook pour la section 3
\& XMLMAN3=""
.Ve
.IP "\s-1XMLDIR\s0" 4
.IX Item "XMLDIR"
Emplacement de tous les fichiers \s-1XML\s0 DocBook. Pour le moment, \f(CW\*(C`po4a\-build\*(C'\fR
s’attend à trouver tous les fichiers décrits dans \s-1XMLMAN1\s0 et \s-1XMLMAN3\s0 en
cherchant les fichiers *.xml dans ce répertoire.
.Sp
Obligatoire si \s-1XMLMAN1\s0 ou \s-1XMLMAN3\s0 sont utilisés. Les chemins sont relatifs à
l’emplacement du fichier de configuration.
.Sp
.Vb 2
\& # emplacement des fichiers XML
\& XMLDIR="share/doc/"
.Ve
.IP "\s-1XMLPACKAGES\s0" 4
.IX Item "XMLPACKAGES"
Paquets, parmi ceux indiqués dans \s-1BINARIES,\s0 qui utilisent des sources \s-1XML.\s0
.Sp
Obligatoire si \s-1XMLMAN1\s0 ou \s-1XMLMAN3\s0 sont utilisés.
.Sp
.Vb 2
\& # paquets binaires utilisant XML DocBook et xsltproc
\& XMLPACKAGES="po4a"
.Ve
.IP "\s-1DOCBOOKDIR\s0" 4
.IX Item "DOCBOOKDIR"
Similaire à \s-1XMLDIR,\s0 mais utilisé seulement pour préparer les fichiers
DocBook traduits. Si vous avez l’intention d’utiliser des fichiers .sgml,
veuillez discuter la façon dont ils devraient être construits sur la liste
de discussion po4a\-devel.
.Sp
.Vb 2
\& # motif pour trouver les fichiers .docbook
\& DOCBOOKDIR=""
.Ve
.IP "\s-1XSLFILE\s0" 4
.IX Item "XSLFILE"
Feuille de style \s-1XSL\s0 utilisée pour préparer les contenus traduits ou non à
partir des fichiers \s-1XML\s0 DocBook.
.Sp
.Vb 2
\& # fichier XSL à utiliser pour S<XML DocBook>
\& XSLFILE="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"
.Ve
.IP "\s-1PODFILE\s0" 4
.IX Item "PODFILE"
Fichiers \s-1POD\s0 pour créer les pages de manuel de la section 1. Les noms des
fichiers \s-1POD\s0 sont séparés par des espaces. Les chemins, s’ils sont utilisés,
sont relatifs à l’emplacement de ce fichier de configuration.
.Sp
.Vb 2
\& # fichiers POD pour la section 1
\& PODFILE="po4a po4a\-gettextize po4a\-normalize scripts/msguntypot"
.Ve
.IP "\s-1PODMODULES\s0" 4
.IX Item "PODMODULES"
Prise en charge spécifique pour les modules Perl utilisant du contenu \s-1POD\s0 \-
le nom du module sera reconstruit en fonction du chemin (ce devrait être le
format habituel pour Perl) et les pages de manuel sont automatiquement
placées en section 3.
.Sp
.Vb 2
\& # fichiers POD pour la section 3 \- noms de module créés à partir du chemin
\& PODMODULES="lib/Locale/Po4a/*.pm"
.Ve
.IP "\s-1POD5FILES\s0" 4
.IX Item "POD5FILES"
Contenu \s-1POD\s0 arbitraire pour créer les pages de manuel de la section 5. Les
chemins, s’ils sont utilisés, sont relatifs à l’emplacement de ce fichier de
configuration.
.Sp
Pour les contenus des sections 5 et 7 (qui ont souvent besoin d’un nom de
fichier déjà utilisé par un contenu de la section 1), si le 5 ou 7 fait
partie du nom de fichier, il (ainsi que toute extension de fichier) sera
automatiquement enlevé.
.Sp
.Vb 2
\& # fichiers POD pour la section 5
\& POD5FILES="doc/po4a\-build.conf.5.pod"
.Ve
.IP "\s-1POD7FILES\s0" 4
.IX Item "POD7FILES"
Contenu \s-1POD\s0 arbitraire pour créer les pages de manuel de la section 7. Les
chemins, s’ils sont utilisés, sont relatifs à l’emplacement de ce fichier de
configuration.
.Sp
Pour les contenus des sections 5 et 7 (qui ont souvent besoin d’un nom de
fichier déjà utilisé par un contenu de la section 1), si le 5 ou 7 fait
partie du nom de fichier, il (ainsi que toute extension de fichier) sera
automatiquement enlevé.
.Sp
.Vb 2
\& # fichiers POD pour la section 7
\& POD7FILES="doc/po4a.7.pod"
.Ve
.IP "\s-1PODPACKAGES\s0" 4
.IX Item "PODPACKAGES"
Similaire à \s-1XMLPACKAGES\s0 \- tout paquet dont du contenu doit être construit à
partir de fichiers \s-1POD\s0 doit contenir une valeur dans
\&\s-1PODPACKAGES.\s0 Obligatoire si \s-1PODFILE, PODMODULES, POD5FILES\s0 ou \s-1POD7FILES\s0 sont
utilisés.
.Sp
.Vb 2
\& # paquets binaires utilisant POD
\& PODPACKAGES="="po4a"
.Ve
.IP "\s-1HTMLDIR\s0" 4
.IX Item "HTMLDIR"
Sous\-répertoire de \s-1BASEDIR\s0 à utiliser pour créer les documents \s-1HTML\s0 traduits
ou non.
.Sp
.Vb 2
\& # répertoire HTML (sous\-répertoire de BASEDIR)
\& HTMLDIR=""
.Ve
.IP "\s-1HTMLFILE\s0" 4
.IX Item "HTMLFILE"
Fichier DocBook à convertir en \s-1HTML\s0 (peut être le même qu’un de ceux
indiqués dans \s-1XMLMAN1\s0 ou \s-1XMLMAN3\s0). Les sections n’ont pas de signification
pour les documents \s-1HTML,\s0 donc n’hésitez pas à utiliser le fichier du livre
entier ici pour intégrer une table des matières, etc.
.Sp
.Vb 2
\& # fichier HTML DocBook
\& HTMLFILE=""
.Ve
.IP "\s-1HTMLXSL\s0" 4
.IX Item "HTMLXSL"
La feuille de style \s-1XSL\s0 utilisée par défaut est partitionnée
(« chunked »). Il n’est pour l’instant pas possible d’utiliser plus d’une
feuille de style par conversion \s-1HTML.\s0
.Sp
.Vb 2
\& # fichier XSL à utiliser pour HTML
\& HTMLXSL="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"
.Ve
.SH "AUTEURS"
.IX Header "AUTEURS"
.Vb 1
\& Neil Williams <linux@codehelp.co.uk>
.Ve
.SH "TRADUCTION"
.IX Header "TRADUCTION"
.Vb 1
\& Martin Quinson (mquinson#debian.org)
.Ve