.\" dpkg manual page - dpkg-maintscript-helper(1)
.\"
.\" Copyright © 2010-2012 Rapha\(:el Hertzog <hertzog@debian.org>
.\" Copyright © 2011-2015 Guillem Jover <guillem@debian.org>
.\"
.\" This is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 2 of the License, or
.\" (at your option) any later version.
.\"
.\" This is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program.  If not, see <https://www.gnu.org/licenses/>.
.
.\"*******************************************************************
.\"
.\" This file was generated with po4a. Translate the source file.
.\"
.\"*******************************************************************
.TH dpkg\-maintscript\-helper 1 2022-05-25 1.19.7 "suite dpkg"
.nh
.SH NOM
dpkg\-maintscript\-helper \- Contournement des limitations connues de dpkg dans
les scripts du responsable
.
.SH SYNOPSIS
\fBdpkg\-maintscript\-helper\fP \fIcommande\fP [\fIparam\(`etre\fP...] \fB\-\-\fP
\fIparam\(`etre\-script\-responsable\fP...
.
.SH "COMMANDES ET PARAM\(`ETRES"
.P
\fBsupports\fP \fIcommande\fP
.P
\fBrm_conffile\fP \fIfichier\-de\-configuration\fP [\fIversion\-pr\('ec\('edente\fP
[\fIpaquet\fP]]
.P
\fBmv_conffile\fP \fIancien\-fichier\-de\-configuration\fP
\fInouveau\-fichier\-de\-configuration\fP [\fIderni\(`ere\-version\fP [\fIpaquet\fP]]
.P
\fBsymlink_to_dir\fP \fInom\-de\-chemin\fP \fIancienne\-cible\fP [\fIversion\-pr\('ec\('edente\fP
[\fIpaquet\fP]]
.P
\fBdir_to_symlink\fP \fInom\-de\-chemin\fP \fInouvelle\-cible\fP [\fIversion\-pr\('ec\('edente\fP
[\fIpaquet\fP]]
.
.SH DESCRIPTION
.P
Ce programme est pr\('evu pour \(^etre ex\('ecut\('e dans les scripts du responsable
afin de r\('ealiser certaines t\(^aches que \fBdpkg\fP ne peut pas (encore) prendre
en charge directement \(`a cause de limites de conception ou de limitations
actuelles.
.P
La plupart de ces t\(^aches n\('ecessitent la coordination de plusieurs scripts du
responsable (\fBpreinst\fP, \fBpostinst\fP, \fBprerm\fP, \fBpostrm\fP). Pour \('eviter des
erreurs, le m\(^eme appel a simplement besoin d'\(^etre plac\('e dans tous les
scripts. Le programme adaptera alors son comportement en fonction de la
variable d'environnement \fBDPKG_MAINTSCRIPT_NAME\fP et des param\(`etres des
scripts du responsable qui doivent \(^etre pass\('es avec un double tiret.
.
.SH "PARAM\(`ETRES COMMUNS"
.TP 
\fIversion\-pr\('ec\('edente\fP
Indique la derni\(`ere version du paquet pour laquelle la mise \(`a niveau doit
provoquer l'op\('eration. Il est important de d\('eterminer correctement
\fIversion\-pr\('ec\('edente\fP afin que les op\('erations s'accomplissent correctement
m\(^eme si l'utilisateur reconstruit le paquet avec une version locale. Si le
param\(`etre \fIversion\-pr\('ec\('edente\fP est vide ou omis, l'op\('eration sera tent\('ee \(`a
chaque mise \(`a niveau (il est toutefois plus s\(^ur d'indiquer la version afin
que l'op\('eration n'ait lieu qu'une fois).

Si le fichier de configuration n'\('etait pas fourni pour une raison ou une
autre dans plusieurs versions et que vous modifiez les scripts du
responsable pour nettoyer l'ancien fichier, \fIversion\-pr\('ec\('edente\fP doit \(^etre
bas\('e sur la version actuellement pr\('epar\('ee et non la premi\(`ere version qui ne
fournissait plus ce fichier de configuration. Cela s'applique \(`a toutes les
autres actions de la m\(^eme mani\(`ere

Par exemple, pour un fichier de configuration supprim\('e dans la version
\fB2.0\-1\fP d'un paquet, \fIversion\-pr\('ec\('edente\fP doit \(^etre \fB2.0\-1~\fP. Cela
provoquera la suppression du fichier m\(^eme si la version pr\('ec\('edente \fB1.0\-1\fP
a \('et\('e reconstruite avec \fB1.0\-1local1\fP comme num\('ero de version. Ou bien, si
un paquet substitue un chemin d'un lien symbolique (fourni dans la version
\fB1.0\-1\fP) \(`a un r\('epertoire (fourni dans la version \fB2.0\-1\fP), mais ne r\('ealise
r\('eellement la substitution que dans les scripts du responsable dans la
version \fB3.0\-1\fP, \fIversion\-pr\('ec\('edente\fP doit \(^etre \fB3.0\-1~\fP.
.TP 
\fIpaquet\fP
Le nom du paquet propri\('etaire du (des) nom(s) de chemin. Si le paquet est
\(Fo\ Multi\-Arch: same\ \(Fc ce param\(`etre doit inclure le type d'architecture,
sinon, il ne devrait \fBpas\fP habituellement inclure le type d'architecture
(parce qu'il pourrait interdire les cat\('egories crois\('ees, ou le passage d'une
architecture sp\('ecifique \(`a architecture \fBall\fP ou vice\-versa). Si le
param\(`etre est vide ou omis, les variables d'environnement
\fBDPKG_MAINTSCRIPT_PACKAGE\fP et \fBDPKG_MAINTSCRIPT_ARCH\fP (telles que d\('efinies
par \fBdpkg\fP lors de l'ex\('ecution des scripts du responsable) seront utilis\('ees
pour cr\('eer un nom de paquet avec une qualification d'architecture.
.TP 
\fB\-\-\fP
Tous les param\(`etres des scripts du responsable doivent \(^etre pass\('es au
programme apr\(`es \fB\-\-\fP.
.SH "T\(^ACHES LI\('EES AUX FICHIERS DE CONFIGURATION"
.P
Lors de la mise \(`a niveau d'un paquet, \fBdpkg\fP ne supprime pas un fichier de
configuration automatiquement (comportant des modifications locales \(`a
pr\('eserver) s'il n'est pas pr\('esent dans la nouvelle version. Il existe deux
raisons principales \(`a cela. En premier lieu, le fichier de configuration
peut avoir \('et\('e supprim\('e par accident, \(^etre r\('eint\('egr\('e dans la version
suivante et il peut \(^etre n\('ecessaire de retrouver les modifications
locales. Ensuite, l'objectif est \('egalement de permettre d'effectuer la
transition depuis des fichiers de configuration g\('er\('es par dpkg vers un
fichier g\('er\('e \(`a l'aide des scripts du responsable, en g\('en\('eral \(`a l'aide d'un
outil comme debconf ou ucf.
.P
Cela signifie que si un paquet a besoin de renommer ou supprimer un fichier
de configuration, il doit le faire explicitement. L'objectif de
\fBdpkg\-maintscript\-helper\fP est donc de fournir des m\('ethodes de suppression
ou renommage de fichiers de configuration \(`a l'aide de scripts du
responsable.
.
.SS "Supprimer un fichier de configuration"
.P
Si un fichier de configuration est compl\(`etement supprim\('e, il doit \(^etre
effac\('e du disque sauf si l'administrateur local l'a modifi\('e. Les \('eventuelles
modifications locales doivent \(^etre conserv\('ees. Si la mise \(`a jour du paquet
est interrompue, le fichier de configuration rendu obsol\(`ete ne doit pas
avoir disparu.
.P
L'ensemble de ces pr\('e\-requis est mis en \(oeuvre en utilisant les commandes
shell suivantes dans les scripts \fBpreinst\fP, \fBpostinst\fP et \fBpostrm\fP\ :
.P
    dpkg\-maintscript\-helper rm_conffile \e
        \fIfichier\-de\-configuration\fP \fIversion\-pr\('ec\('edente\fP \fIpaquet\fP \-\- "$@"
.P
\fIfichier\-de\-configuration\fP est le nom du fichier de configuration \(`a
supprimer.
.P
D\('etails de la mise en \(oeuvre actuelle\ :\ dans le script \fBpreinst\fP, il est
v\('erifi\('e si le fichier de configuration a \('et\('e modifi\('e. Celui\-ci est alors
renomm\('e, soit en \fIfichier\-de\-configuration\fP\fB.dpkg\-remove\fP s'il n'a pas \('et\('e
modifi\('e, soit en \fIfichier\-de\-configuration\fP\fB.dpkg\-backup\fP s'il l'a
\('et\('e. Dans le script \fBpostinst\fP, ce dernier fichier est ensuite renomm\('e en
\fIfichier\-de\-configuration\fP\fB.dpkg\-bak\fP et conserv\('e pour r\('ef\('erence puisqu'il
contient des modifications locales, mais le premier est supprim\('e. Si la mise
\(`a jour du paquet est interrompue, le script \fBpostrm\fP remet en place le
fichier de configuration d'origine. \(`A la purge du paquet, le script
\fBpostrm\fP supprimera \('egalement le fichier \fB.dpkg\-bak\fP qui avait \('et\('e
conserv\('e jusque l\(`a.
.
.SS "Renommer un fichier de configuration"
.P
Si un fichier de configuration est d\('eplac\('e \(`a un autre endroit, il est
n\('ecessaire de garantir la pr\('eservation des modifications locales. \(`A premi\(`ere
vue, cela peut sembler \(^etre une simple modification dans le script
\fBpreinst\fP, mais cela risque de r\('esulter en une demande, par \fBdpkg\fP,
d'approbation de modifications locales qui n'existent pas r\('eellement.
.P
Un renommage \('el\('egant peut \(^etre mis en \(oeuvre avec les extraits shell qui
suivent, dans les scripts \fBpreinst\fP, \fBpostinst\fP et \fBpostrm\fP\ :
.P
    dpkg\-maintscript\-helper mv_conffile \e
        \fIancien\-fichier\-configuration\fP \fInouveau\-fichier\-configuration\fP         \fIversion\-pr\('ec\('edente\fP \fIpaquet\fP \-\- "$@"
.P
\fIancien\-fichier\-configuration\fP et \fInouveau\-fichier\-configuration\fP sont
l'ancien et le nouveau nom du fichier de configuration \(`a renommer.
.P
D\('etails de la mise en \(oeuvre actuelle\ :\ dans le script \fBpreinst\fP, il est
v\('erifi\('e si le fichier de configuration a \('et\('e modifi\('e. Celui\-ci est alors
soit laiss\('e en place s'il a \('et\('e modifi\('e, soit renomm\('e en
\fIancien\-fichier\-configuration\fP\fB.dpkg\-remove\fP s'il ne l'a pas \('et\('e. Lors de
la configuration, le script \fBpostinst\fP supprime
\fIancien\-fichier\-configuration\fP\fB.dpkg\-remove\fP et renomme
\fIancien\-fichier\-configuration\fP et \fInouveau\-fichier\-configuration\fP si
\fIancien\-fichier\-configuration\fP existe toujours. Si la mise \(`a jour ou
l'installation sont interrompues, le script \fBpostrm\fP renomme
\fIancien\-fichier\-configuration\fP\fB.dpkg\-remove\fP en
\fIancien\-fichier\-configuration\fP si c'est indispensable.
.
.SH "SUBSTITUTIONS DE LIENS SYMBOLIQUES ET DE R\('EPERTOIRES"
.
Lors de la mise \(`a niveau d'un paquet, \fBdpkg\fP ne substitue pas
automatiquement un lien symbolique \(`a un r\('epertoire ou le contraire. Les
retours \(`a une version inf\('erieure ne sont pas pris en charge et le chemin
sera laiss\('e comme il est.
.
.SS "Substituer un lien symbolique \(`a un r\('epertoire"
.
Si un lien symbolique est substitu\('e \(`a un r\('epertoire r\('eel, il est n\('ecessaire
de garantir qu'avant le d\('epaquetage le lien symbolique est retir\('e. \(`A
premi\(`ere vue, cela peut sembler \(^etre une simple modification dans le script
\fBpreinst\fP, mais cela risque de r\('esulter en probl\(`emes si l'administrateur
local a personnalis\('e le lien symbolique ou si l'on revient \(`a une version
ant\('erieure du paquet.
.P
Un renommage \('el\('egant peut \(^etre mis en \(oeuvre avec les extraits shell qui
suivent, dans les scripts \fBpreinst\fP, \fBpostinst\fP et \fBpostrm\fP\ :
.P
    dpkg\-maintscript\-helper symlink_to_dir \e
        \fInom\-de\-chemin\fP \fIancienne\-cible\fP \fIversion\-pr\('ec\('edente\fP \fIpaquet\fP \-\- "$@"
.P
\fInom\-de\-chemin\fP est le nom absolu de l'ancien lien symbolique (le chemin
sera un r\('epertoire \(`a la fin de l'installation) et \fIancienne\-cible\fP la cible
de l'ancien lien symbolique vers \fInom\-de\-chemin\fP. Cela peut \(^etre un chemin
absolu ou relatif vers le r\('epertoire contenant \fInom\-de\-chemin\fP.
.P
D\('etails de la mise en \(oeuvre actuelle\ : dans le script \fBpreinst\fP, il est
v\('erifi\('e si le lien symbolique existe et pointe vers \fIancienne\-cible\fP. Si ce
n'est pas le cas, il est alors soit laiss\('e en place, soit renomm\('e en
\fInom\-de\-chemin\fP\fB.dpkg\-backup\fP. Lors de la configuration, le script
\fBpostinst\fP supprime \fInom\-de\-chemin\fP\fB.dpkg\-backup\fP si
\fInom\-de\-chemin\fP\fB.dpkg\-backup\fP est encore un lien symbolique. Si la mise \(`a
niveau ou l'installation sont interrompues, le script \fBpostrm\fP renomme
\fInom\-de\-chemin\fP\fB.dpkg\-backup\fP en \fInom\-de\-chemin\fP si c'est indispensable.
.
.SS "Substituer un r\('epertoire \(`a un lien symbolique"
.
Si un r\('epertoire r\('eel est substitu\('e \(`a un lien symbolique, il est n\('ecessaire
de garantir qu'avant le d\('epaquetage le r\('epertoire est retir\('e. \(`A premi\(`ere
vue, cela peut sembler \(^etre une simple modification dans le script
\fBpreinst\fP, mais cela risque de r\('esulter en probl\(`emes si le r\('epertoire
contient des fichiers de configuration, des noms de chemins qui
appartiennent \(`a d'autres paquets, des noms de chemin cr\('e\('es localement ou si
l'on revient \(`a une version ant\('erieure du paquet.
.P
Une substitution \('el\('egante peut \(^etre mise en \(oeuvre avec les extraits shell
qui suivent, dans les scripts \fBpreinst\fP, \fBpostinst\fP et \fBpostrm\fP\ :
.P
    dpkg\-maintscript\-helper dir_to_symlink \e
        \fInom\-de\-chemin\fP \fInouvelle\-cible\fP \fIversion\-pr\('ec\('edente\fP \fIpaquet\fP \-\- "$@"
.P
\fInom\-de\-chemin\fP est le nom absolu de l'ancien r\('epertoire (le chemin sera un
lien symbolique \(`a la fin de l'installation) et \fInouvelle\-cible\fP la cible du
nouveau lien symbolique vers \fInom\-de\-chemin\fP. Cela peut \(^etre un chemin
absolu ou relatif vers le r\('epertoire contenant \fInom\-de\-chemin\fP.
.P
D\('etails de la mise en \(oeuvre actuelle\ : dans le script \fBpreinst\fP, il est
v\('erifi\('e si le r\('epertoire existe et ne contient pas de fichiers de
configuration, de noms de chemin qui appartiennent \(`a d'autres paquets, de
noms de chemin cr\('e\('es localement. Si ce n'est pas le cas, il est alors soit
laiss\('e en place, soit renomm\('e en \fInom\-de\-chemin\fP\fB.dpkg\-backup\fP et un
r\('epertoire vide provisoire nomm\('e \fInom\-de\-chemin\fP est cr\('e\('e, marqu\('e par un
fichier pour que dpkg le suive. Lors de la configuration, le script
\fBpostinst\fP ach\(`eve la substitution si \fInom\-de\-chemin\fP\fB.dpkg\-backup\fP  est
encore un r\('epertoire et si \fInom\-de\-chemin\fP est le r\('epertoire provisoire. Il
supprime le fichier qui marque le fichier provisoire et d\('eplace les fichiers
nouvellement cr\('e\('es dans le r\('epertoire provisoire vers la cible du lien
symbolique \fInouvelle\-cible\fP, remplace le r\('epertoire provisoire
\fInom\-de\-chemin\fP, maintenant vide, par un lien symbolique vers la
\fInouvelle\-cible\fP et, enfin supprime \fInom\-de\-chemin\fP\fB.dpkg\-backup\fP. Si la
mise \(`a niveau ou l'installation sont interrompues, le script \fBpostrm\fP
renomme \fInom\-de\-chemin\fP\fB.dpkg\-backup\fP en \fInom\-de\-chemin\fP si c'est
indispensable.
.
.SH "INT\('EGRATION DANS LES PAQUETS"
.P
Lors de l'utilisation d'un assistant d'empaquetage, veuillez v\('erifier s'il
ne dispose pas d'une int\('egration native de \fBdpkg\-maintscript\-helper\fP ce qui
vous facilitera la t\(^ache. Voir par exemple \fBdh_installdeb\fP(1).
.P
Comme \fBdpkg\-maintscript\-helper\fP est utilis\('e dans le script \fBpreinst\fP,
l'utiliser sans conditions impose une pr\('e\-d\('ependance afin de garantir que la
version minimale n\('ecessaire de \fBdpkg\fP ait bien \('et\('e pr\('ealablement
configur\('ee. La version minimale d\('epend de la commande utilis\('ee\ : ainsi pour
\fBrm_conffile\fP et \fBmv_conffile\fP, cette version est\ 1.15.7.2, pour
\fBsymlink_to_dir\fP et \fBdir_to_symlink\fP, c'est\ 1.17.14\ :
.P
    \fBPre\-Depends:\fP dpkg (>= 1.17.14)
.P
Cependant, dans de nombreux cas, l'op\('eration r\('ealis\('ee par le programme n'est
pas critique pour le paquet et au lieu d'utiliser une pr\('e\-d\('ependance, il est
possible de ne lancer le programme que si on a la certitude que la commande
n\('ecessaire est g\('er\('ee par la version actuellement install\('ee de \fBdpkg\fP\ :
.P
    if dpkg\-maintscript\-helper supports \fIcommande\fP; then
        dpkg\-maintscript\-helper \fIcommande\fP ...
    fi
.P
La commande \fBsupports\fP retournera \fB0\fP en cas de r\('eussite, \fB1\fP
autrement. Elle v\('erifiera si les variables d'environnement telles que
d\('efinies par \fBdpkg\fP et requises par le script sont pr\('esentes, et
consid\('erera que c'est un \('echec si l'environnement n'est pas suffisant.
.
.SH ENVIRONNEMENT
.TP 
\fBDPKG_COLORS\fP
Fixe le mode de couleur (depuis dpkg\ 1.19.1). Les valeurs admises
actuellement sont \fBauto\fP (par d\('efaut), \fBalways\fP et \fBnever\fP.
.
.SH "VOIR AUSSI"
.ad l
\fBdh_installdeb\fP(1)
.SH TRADUCTION
Ariel VARDI <ariel.vardi@freesbee.fr>, 2002.
Philippe Batailler, 2006.
Nicolas Fran\(,cois, 2006.
Veuillez signaler toute erreur \(`a <debian\-l10n\-french@lists.debian.org>.
