man/deb-conffiles.pod

   1 # dpkg manual page - deb-conffiles(5)
   2 #
   3 # Copyright © 2016-2017 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-conffiles - package conffiles
  23
  24 =head1 SYNOPSIS
  25
  26 B<DEBIAN/conffiles>
  27
  28 =head1 DESCRIPTION
  29
  30 A package declares its list of conffiles by including a I<conffiles> file
  31 in its control archive (i.e. I<DEBIAN/conffiles> during package creation).
  32
  33 This file contains a list of files, one per line, with an optional leading
  34 flag separated by whitespace.
  35 The conffiles must be listed as absolute pathnames.
  36 Trailing whitespace will be trimmed, but empty or whitespace-only lines are
  37 not accepted.
  38
  39 Files without a flag should exist in the binary package, otherwise L<dpkg(1)>
  40 will ignore them.
  41
  42 There is currently only one flag supported, B<remove-on-upgrade>, to mark
  43 that a conffile needs to be removed on the next upgrade (since dpkg 1.20.6).
  44 These files must not exist in the binary package, as both L<dpkg(1)> and
  45 L<dpkg-deb(1)> will not accept building nor processing such binary packages.
  46
  47 =head1 EXAMPLE
  48
  49  %CONFDIR%/alternatives/README
  50  %CONFDIR%/cron.daily/dpkg
  51  %PKGCONFDIR%/dpkg.cfg
  52  %CONFDIR%/logrotate.d/dpkg
  53  remove-on-upgrade /etc/some-old-file.conf
  54
  55 =head1 SEE ALSO
  56
  57 L<dpkg-deb(1)>,
  58 L<dpkg(1)>.