Difference between revisions of "Pacman/Pacnew and Pacsave"

From ArchWiki
Jump to: navigation, search
m (Locating .pac* files: improve layout and wording)
m (Locating .pac* files: improve layout and wording)
 
Line 61: Line 61:
 
* To search within {{ic|/etc}} where most global configurations are stored: {{bc|<nowiki>$ find /etc -regextype posix-extended -regex ".+\.pac(new|save)" 2> /dev/null</nowiki>}} or to search within the entire disk replacing {{ic|/etc}} by {{ic|/}} in the command above.
 
* To search within {{ic|/etc}} where most global configurations are stored: {{bc|<nowiki>$ find /etc -regextype posix-extended -regex ".+\.pac(new|save)" 2> /dev/null</nowiki>}} or to search within the entire disk replacing {{ic|/etc}} by {{ic|/}} in the command above.
 
* If installed, [[locate]] can also be used. First re-index the database: {{bc|# updatedb}} Then run: {{bc|<nowiki>$ locate --existing --regex "\.pac(new|save)$"</nowiki>}}
 
* If installed, [[locate]] can also be used. First re-index the database: {{bc|# updatedb}} Then run: {{bc|<nowiki>$ locate --existing --regex "\.pac(new|save)$"</nowiki>}}
* Use pacman's log to find them: {{bc|<nowiki>$ grep --extended-regexp "pac(new|save)" /var/log/pacman.log</nowiki>}} Note that the log does not keep track of which files are currently in the filesystem nor of which files have already been removed; the above command will list all ''.pac*'' files that have ever existed on your system. Use the {{ic|tail}} command to get the 10 most recent ''.pac*'' files: {{bc|<nowiki>$ grep --extended-regexp "pac(new|save)" /var/log/pacman.log | tail</nowiki>}}
+
* Use pacman's log to find them: {{bc|<nowiki>$ grep --extended-regexp "pac(new|save)" /var/log/pacman.log</nowiki>}} Note that the log does not keep track of the files currently in the filesystem nor the ones that have already been removed; the above command will list all ''.pac*'' files that have ever existed on your system. In order to only get the 10 most recent ''.pac*'' files, pipe the result to {{ic|tail}}.
  
 
== Managing .pacnew files ==
 
== Managing .pacnew files ==

Latest revision as of 07:04, 17 March 2018

When pacman removes a package that has a configuration file, it normally creates a backup copy of that config file and appends .pacsave to the name of the file. Likewise, when pacman upgrades a package which includes a new config file created by the maintainer differing from the currently installed file, it saves a .pacnew file with the new configuration. pacman provides notice when these files are written.

Why these files are created

A .pacnew file may be created during a package upgrade (pacman -Syu, pacman -Su or pacman -U) to avoid overwriting a file which already exists and was previously modified by the user. When this happens a message like the following will appear in the output of pacman:

warning: /etc/pam.d/usermod installed as /etc/pam.d/usermod.pacnew

A .pacsave file may be created during a package removal (pacman -R), or by a package upgrade (the package must be removed first). When the pacman database has record that a certain file owned by the package should be backed up it will create a .pacsave file. When this happens pacman outputs a message like the following:

warning: /etc/pam.d/usermod saved as /etc/pam.d/usermod.pacsave

These files require manual intervention from the user and it is good practice to handle them right after every package upgrade or removal. If left unhandled, improper configurations can result in improper function of the software, or the software being unable to run altogether.

Package backup files

A package's PKGBUILD file specifies which files should be preserved or backed up when the package is upgraded or removed. For example, the PKGBUILD for pulseaudio contains the following line:

backup=('etc/pulse/client.conf' 'etc/pulse/daemon.conf' 'etc/pulse/default.pa')

To prevent any package from overwriting a certain file, see Pacman#Skip file from being upgraded.

Types explained

.pacnew

For each of the #Package backup files being upgraded, pacman cross-compares three md5sums generated from the file's contents: one sum for the version originally installed by the package, one for the version currently in the filesystem, and one for the version in the new package. If the version of the file currently in the filesystem has been modified from the version originally installed by the package, pacman cannot know how to merge those changes with the new version of the file. Therefore, instead of overwriting the modified file when upgrading, pacman saves the new version with a .pacnew extension and leaves the modified version untouched.

Going into further detail, the 3-way MD5 sum comparison results in one of the following outcomes:

original = X, current = X, new = X 
All three versions of the file have identical contents, so overwriting is not a problem. Overwrite the current version with the new version and do not notify the user (although the file contents are the same, this overwrite will update the filesystem's information regarding the file's installed, modified, and accessed times, as well as ensure that any file permission changes are applied).
original = X, current = X, new = Y 
The current version's contents are identical to the original's, but the new version is different. Since the user has not modified the current version and the new version may contain improvements or bugfixes, overwrite the current version with the new version and do not notify the user. This is the only auto-merging of new changes that pacman is capable of performing.
original = X, current = Y, new = X 
The original package and the new package both contain exactly the same version of the file, but the version currently in the filesystem has been modified. Leave the current version in place and discard the new version without notifying the user.
original = X, current = Y, new = Y 
The new version is identical to the current version. Overwrite the current version with the new version and do not notify the user (although the file contents are the same, this overwrite will update the filesystem's information regarding the file's installed, modified, and accessed times, as well as ensure that any file permission changes are applied).
original = X, current = Y, new = Z 
All three versions are different, so leave the current version in place, install the new version with a .pacnew extension and warn the user about the new version. The user will be expected to manually merge any changes necessary from the new version into the current version.

.pacsave

If the user has modified one of the files specified in backup then that file will be renamed with a .pacsave extension and will remain in the filesystem after the rest of the package is removed.

Note: Use of the -n option with pacman -R will result in complete removal of all files in the specified package, therefore no .pacsave files will be created.

Locating .pac* files

Pacman does not deal with .pacnew files automatically: you must maintain these yourself. A few tools are presented in the next section. To do this manually, you will first need to locate them. When upgrading or removing a large number of packages, updated .pac* files may be missed. To discover whether any .pac* files have been installed, use one of the following:

  • To search within /etc where most global configurations are stored:
    $ find /etc -regextype posix-extended -regex ".+\.pac(new|save)" 2> /dev/null
    or to search within the entire disk replacing /etc by / in the command above.
  • If installed, locate can also be used. First re-index the database:
    # updatedb
    Then run:
    $ locate --existing --regex "\.pac(new|save)$"
  • Use pacman's log to find them:
    $ grep --extended-regexp "pac(new|save)" /var/log/pacman.log
    Note that the log does not keep track of the files currently in the filesystem nor the ones that have already been removed; the above command will list all .pac* files that have ever existed on your system. In order to only get the 10 most recent .pac* files, pipe the result to tail.

Managing .pacnew files

pacdiff

Pacman includes the simple pacdiff tool for managing pacnew/pacsave files. It will search all pacnew and pacsave files and ask for any actions on them. It uses vimdiff by default, but you may specify a different tool with DIFFPROG=your_editor pacdiff. See List of applications/Utilities#Comparison, diff, merge for other common comparison tools.

Third-party utilities

A few third-party utilities providing various levels of automation for these tasks are available from the AUR.

You can use one of the following tools:

  • dotpac — Basic interactive script with ncurses-based text interface and helpful walkthrough. No merging or auto-merging features.
https://github.com/AladW/dotpac || dotpacAUR
  • etc-update — Arch port of Gentoo's etc-update utility, providing a simple CLI to view, merge and interactively edit changes. Trivial changes (such as comments) can be merged automatically.
https://wiki.gentoo.org/wiki/Handbook:Parts/Portage/Tools#etc-update || etc-updateAUR
  • pacmarge — A tool for automatically merging .pacnew files
https://github.com/foutrelis/pacmarge || pacmargeAUR
  • pacnew-auto — Automatic pacnew merging using git rebase.
https://github.com/joanrieu/pacnew-auto || pacnew-auto-gitAUR
  • pacnews-git — A simple script aimed at finding all .pacnew files, then editing them with vimdiff.
https://github.com/pbrisbin/scripts/blob/master/pacnews || pacnews-gitAUR

See also