man/deb-prerm.pod

   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 =encoding utf8
  19
  20 =head1 NAME
  21
  22 deb-prerm - package pre-removal maintainer script
  23
  24 =head1 SYNOPSIS
  25
  26 B<DEBIAN/prerm>
  27
  28 =head1 DESCRIPTION
  29
  30 A package can perform several pre-removal actions via maintainer
  31 scripts, by including an executable I<prerm> file in its control
  32 archive (i.e. I<DEBIAN/prerm> during package creation).
  33
  34 The script can be called in the following ways:
  35
  36 =over
  37
  38 =item I<prerm> B<remove>
  39
  40 Before the package is removed.
  41
  42 =item I<old-prerm> B<upgrade> I<new-version>
  43
  44 Before an upgrade.
  45
  46 =item I<new-prerm> B<failed-upgrade> I<old-version> I<new-version>
  47
  48 If the above B<upgrade> fails.
  49
  50 The I<new-version> is passed only since dpkg 1.18.5.
  51
  52 =item I<prerm> B<deconfigure> B<in-favour> I<new-package> I<new-version>
  53
  54 =item S<    >[ B<removing> I<old-package> I<old-version> ]
  55
  56 Before package is deconfigured while dependency is replaced due to conflict.
  57
  58 =item I<prerm> B<remove> B<in-favour> I<new-package> I<new-version>
  59
  60 Before the package is replaced due to conflict.
  61
  62 =back
  63
  64 =head1 SEE ALSO
  65
  66 L<dpkg(1)>.