rename_ucf_file oldname newname¶

Renames a configuration file managed by ucf and updates registration state in ucfr.

Also updates internal /var/lib/ucf/hashfile entries to reflect the rename.

This function is used during package upgrades where configuration file paths change between versions. The actual file rename of the "New File" delivered with the package must already have happened.

handle_single_ucf_file pkgfile locfile¶

Processes a single configuration file shipped by the package.

It invokes ucf for merge handling.

handle_deleted_ucf_file locfile pkgdir locdir¶

Handles configuration files removed from the package in newer versions.

If the corresponding file in pkgdir no longer exists:

• Runs ucf against /dev/null to trigger merge logic
• Removes file if it becomes empty after processing
• Removes known dpkg/ucf backup variants
• Purges registrations from ucf and ucfr

Local modifications are preserved unless the file becomes empty.

handle_all_ucf_files pkgdir locdir¶

Main entry point for configuration file/directory processing.

It performs:

• Creation of target directory structure
• Processing of all package-shipped file in the pkgdir.
• Detection and handling of removed files
• Synchronization of ucf state with filesystem state

Basic postinst integration¶

#!/bin/sh
set -e
PKGNAME="examplepkg"
. /usr/share/examplepkg/ucf-helper-functions.sh
SRCDIR="/usr/share/${PKGNAME}/config"
TRGDIR="/etc"
case "$1" in


    configure)


        handle_all_ucf_files "$SRCDIR" "$TRGDIR"


        ;;
esac
exit 0

Renaming configuration files across versions¶

if dpkg --compare-versions "$2" le 0.16-1; then


    rename_ucf_file \


        /etc/example/conf.d/old \


        /etc/example/conf.d/new
fi