chiark - git - mdw - dpkg/blob - man/deb-prerm.man

   1 .\" dpkg manual page - deb-prerm(5)
   2 .\"
   3 .\" Copyright © 2016 Guillem Jover <guillem@debian.org>
   4 .\"
   5 .\" This is free software; you can redistribute it and/or modify
   6 .\" it under the terms of the GNU General Public License as published by
   7 .\" the Free Software Foundation; either version 2 of the License, or
   8 .\" (at your option) any later version.
   9 .\"
  10 .\" This is distributed in the hope that it will be useful,
  11 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 .\" GNU General Public License for more details.
  14 .\"
  15 .\" You should have received a copy of the GNU General Public License
  16 .\" along with this program.  If not, see <https://www.gnu.org/licenses/>.
  17 .
  18 .TH deb\-prerm 5 "%RELEASE_DATE%" "%VERSION%" "dpkg suite"
  19 .nh
  20 .SH NAME
  21 deb\-prerm \- package pre-removal maintainer script
  22 .
  23 .SH SYNOPSIS
  24 prerm
  25 .
  26 .SH DESCRIPTION
  27 A package can perform several pre-removal actions via maintainer
  28 scripts, by including an executable \fIprerm\fP file in its control
  29 archive (i.e. \fIDEBIAN/prerm\fP during package creation).
  30 .PP
  31 The script can be called in the following ways:
  32 .TP
  33 \fIprerm\fP \fBremove\fP
  34 Before the package is removed.
  35 .TP
  36 \fIold-prerm\fP \fBupgrade\fP \fInew-version\fP
  37 Before an upgrade.
  38 .TP
  39 \fInew-prerm\fP \fBfailed-upgrade\fP \fIold-version new-version\fP
  40 If the above \fBupgrade\fP fails.
  41 .TP
  42 \fIprerm\fP \fBdeconfigure in-favour\fP \fInew-package new-version\fP
  43 .TQ
  44     [ \fBremoving\fP \fIold-package old-version\fP ]
  45 Before package is deconfigured while dependency is replaced due to conflict.
  46 .TP
  47 \fIprerm\fP \fBremove in-favour\fP \fInew-package new-version\fP
  48 Before the package is replaced due to conflict.
  49 .
  50 .SH SEE ALSO
  51 .BR dpkg (1).