DH_CME_UPGRADE(1p)

📦
version 1.049 · 6 versions
, in ubuntu stonking

💖 DH_CME_UPGRADE(1p) — bestie, it's basically dh_cme_upgrade 💖

okay so like. welcome to the manual page for dh_cme_upgrade, a lil debhelper tool from the Perl world, and honestly? she's doing the most so your users don't lose their configs. let's get into it 🎀

✨ VERSION ✨

version 1.049 — yes she's been around a minute, she's got lore.

🌸 SYNOPSIS 🌸

dh_cme_upgrade [ debhelper options ] [ -p pkg ]

that's the whole vibe fr. simple.

🦋 DESCRIPTION 🦋

okay so <pink>dh_cme_upgrade is experimental</pink> — putting that front and center because it matters, bestie, no cap.

dh_cme_upgrade is a debhelper that will modify the package script to merge configuration on package upgrade. It's giving "your settings + new upstream defaults, but they actually get along 🫶".

This merge is based on cme from Config::Model, and what it does is merge user's customisations with maintainer's configuration updates. That's like... a whole other way to preserve users' modifications during upgrades. iconic honestly.

Configuration information used by cme for upgrade are specified in a configuration file (see below ⬇️).

Configuration information is specified in a configuration model. It must be provided by another package like "libconfig-model-lcdproc-perl". so yeah, she needs a friend to function, relatable 😭

💅 REQUIREMENTS 💅

For this program to work, package maintainer must make sure that:

  • "*.postinst", "*.postrm" and "*.config" have a "#DEBHELPER#" line (if these files exist)
  • "control" file has a dependency on "${misc:Depends}"
  • Configuration files upgraded by "cme" must not be conffiles. Any default configuration file provided by upstream must not be installed directly in "/etc". They should be installed in "/usr/share/doc/" for reference. "cme" will create a default configuration file during package installation.
🚨 bestie read that third one twice. NOT conffiles. NOT directly in /etc. /usr/share/doc/ for reference only. cme handles the creating, she's got it. periodt.

✨ OPTIONS ✨

This program accepts all debhelper options, including the -p option to specify which package(s) to act on. your usual debhelper crew, they're all invited 💖

🎀 Usage 🎀

"dh_cme_upgrade" is designed be called in the rules file via the dh command:

%:
  dh --with cme_upgrade

No options can be passed to "dh_cme_upgrade". Its configuration must be specified in "debian/*.config_model" file. This file contains several lines, each in the form of "key: value".

Here are the possible keys:

  • cme-app-name — Specifies the application or model name (à la "Config::Model") that will be used to perform the upgrade. (mandatory) — yeah babe this one's not optional, it's required 💀
  • cme-model-package — Specifies the debian package that provide the model specified by "cme-app-name". (mandatory) — also required, no skipping 👑
  • cme-model-version — Specifies the minimal version of the package that provides the model. (optional) — spring cleaning only, you can leave her out 🌸
  • cme-command — Specify the command passed to cme. Defaults to "migrate". Another useful value is "fix" which will migrate and fix the configuration file. — so like, migrate is the default girlie, but fix will migrate and fix. multitasking 💅
  • cme-options — Specify a list of options or command that will be passed verbatim to cme during upgrade. (optional) — verbatim means VERBATIM, she takes it as-is 🔥
  • cme-purge — Specify the configuration files or directory to be removed when purging the package. E.g "/etc/LCDd.conf*" or "/etc/java/". Several files or directory can be purged by using a shell glob. If this option is empty, configuration files handled by cme will be left as-is after a purge. — so like, she'll leave them alone if you don't tell her 📁
  • cme-conf-target — Specifies where the target configuration files is expected. Defaults to "/etc". This parameter is used to create a message to inform user who don't want automatic upgrade where to find the original configuration file (in "/usr/share/doc/package_name") and where to copy it (in "/cme-conf-target"). — she's being nice and telling people where the stuff lives 🫶

Alternatively, since cme/1.030-1 you can just build depend on dh-sequence-cme-upgrade and omit the "--with cme_upgrade" part. glow up ✨

🌈 Examples 🌈

Here's a possible configuration for openssh server:

$ cat debian/openssh-server.config-model
cme-app-name: sshd
cme-model-package: lib-config-model-openssh-perl
cme-model-version: 1.206

For lcdproc:

$ cat debian/lcdproc.config-model
cme-app-name: lcdproc
cme-package: libconfig-model-lcdproc-perl
cme-model-version: 2.040
# required to upgrade LCDd.conf from upstream configuration
cme-options: -force
cme-purge: /etc/LCDd.conf*

For Popcon:

$ cat debian/popcon.config-model
cme-app-name: popcon
cme-model-package: libconfig-model-perl

🧚 debian files setup 🧚

"dh_cme_upgrade" will work only if:

  • "control" file contains a "${misc:Depends}" variable in "Depends" line
  • If present, "postinst" script contains a "#DEBHELPER#" line to insert generated postinst snippet
like, she literally cannot do her job otherwise. these are the prerequisites, bestie 🙈

👑 ENVIRONMENT 👑

This program will exit(0) if "DH_NO_ACT" is set or if "DEB_BUILD_OPTIONS" contains "noconfigmodel". so if you see her ghosting you, check those env vars first 💀

🌟 SEE ALSO 🌟

  • debhelper

"dh_cme_upgrade" ... This program is an addendum to debhelper (part of libconfig-model-perl). basically she's debhelper's cool younger cousin 🦋

💜 AUTHOR 💜

Dominique Dumont <dod@debian.org>

💜 AUTHOR 💜

Dominique Dumont

(yeah they listed it twice, and honestly? iconic. the name deserves two slots 👑)

This software is Copyright (c) 2014-2022 by Dominique Dumont <ddumont@cpan.org>.

This is free software, licensed under:

The GNU Lesser General Public License, Version 2.1, February 1999

and that's the whole page bestie, mwah 💖

signing off — dh_cme_upgrade from perl v5.40.1, dated 2026-06-29, filed under DH_CME_UPGRADE(1p). slay, take care of your conffiles, and remember: NOT in /etc directly. iykyk 🎀✨

📦 where this page comes from