PKG_DELETE(1)

NAME
pkg_delete - a utility for deleting previously installed software package distributions

SYNOPSIS
pkg_delete [-DdFfNnORrVv] [-K pkg_dbdir] [-p prefix] pkg-name ...

DESCRIPTION
The pkg_delete command is used to delete packages that have been previously installed with the pkg_add(1) command.

WARNING
Since the pkg_delete command may execute scripts or programs provided by a package file, your system may be susceptible to “Trojan horses” or other subtle attacks from miscreants who create dangerous package files.

You are advised to verify the competence and identity of those who provide installable package files. For extra protection, examine all the package control files in the package record directory (/var/db/pkg/pkg-name/). Pay particular attention to any +INSTALL, +DEINSTALL, +REQUIRE, or +MTREE_DIRS files, and inspect the +CONTENTS file for @cwd, @mode (check for setuid), @dirrm, @exec, and @unexec directives, and/or use the pkg_info(1) command to examine the installed package control files.

OPTIONS
The following command line options are supported:

pkg-name ...
    The named packages are deinstalled, wildcards can be used, see pkg_info(1). If no version is given, the one currently installed will be removed. If the -F flag is given, one or more (absolute) filenames may be specified and the Package Database will be consulted for the package to which the given file belongs. These packages are then deinstalled.

-D  If a deinstallation script exists for a given package, do not execute it.

-d  Remove empty directories created by file cleanup. By default, only files/directories explicitly listed in a package's contents (either as normal files/directories or with the @dirrm directive) will be removed at deinstallation time. This option tells pkg_delete to also remove any directories that were emptied as a result of removing the package.

-F  Any pkg-name given will be interpreted as pathname which is subsequently transformed in a (real) package name via the Package Database. That way, packages can be deleted by giving a filename instead of the package-name.

-f  Force removal of the package, even if a dependency is recorded or the deinstall or require script fails.

-K pkg_dbdir
    Set pkg_dbdir as the package database directory. If this option isn't specified, then the package database directory is taken from the value of the environment variable PKG_DBDIR if it's set, otherwise it defaults to /var/db/pkg.

-N  Remove the package's registration and its entries from the package database, but leave the files installed. Don't run any deinstall scripts or @unexec lines either.

-n  Don't actually deinstall a package, just report the steps that would be taken if it were.

-O  Only delete the package's entries from the package database, do not touch the package or its files itself.

-p prefix
    Set prefix as the directory in which to delete files from any installed packages which do not explicitly set theirs. For most packages, the prefix will be set automatically to the installed location by pkg_add(1).

-R  This option triggers a recursive delete of the given package and any packages it depends on, unless some other package still needs a dependent package. This -R option can be used to clean up by deleting a package and all its then-unneeded dependent packages.

-r  pkg_delete first builds a list of all packages that require (directly and indirectly) the one being deleted. It then deletes these packages using pkg_delete with the given options before deleting the user specified package. This -r option can be used to recursively delete a package and all of the packages which depend on that package.

-V  Print version number and exit.

-v  Turn on verbose output.

TECHNICAL DETAILS
pkg_delete does pretty much what it says. It examines installed package records in /var/db/pkg/pkg-name, deletes the package contents, and finally removes the package records (if an alternate package database directory is specified, then it overrides the /var/db/pkg path shown above).

If a package is required by other installed packages, pkg_delete will list those dependent packages and refuse to delete the package (unless the -f option is given).

If a package has been marked as a preserved package, it will not be able to be deleted (unless more than one occurrence of the -f option is given).

If a filename is given instead of a package name, the package of which the given file belongs to can be deleted if the -F Flag is given. The filename needs to be absolute, see the output produced by the pkg_info -aF command.

If the package contains a require file (see pkg_create(1)), then this is executed first as
require <pkg-name> DEINSTALL

(where pkg-name is the name of the package in question and DEINSTALL is a keyword denoting that this is a deinstallation) to see whether or not deinstallation should continue. A non-zero exit status means no, unless the -f option is specified.

If a deinstall script exists for the package, it is executed before and after any files are removed. It is this script's responsibility to clean up any additional messy details around the package's installation, since all pkg_delete knows how to do is delete the files created in the original distribution. The deinstall script is called as:
deinstall <pkg-name> VIEW-DEINSTALL

before removing the package from a view, and as:
deinstall <pkg-name> DEINSTALL

before deleting all files and as:
deinstall <pkg-name> POST-DEINSTALL

after deleting them. Passing the keywords VIEW-DEINSTALL, DEINSTALL and POST-DEINSTALL lets you potentially write only one program/script that handles all aspects of installation and deletion.

All scripts are called with the environment variable PKG_PREFIX set to the installation prefix (see the -p option above). This allows a package author to write a script that reliably performs some action on the directory where the package is installed, even if the user might have changed it by specifying the -p option when running pkg_delete or pkg_add(1). The scripts are also called with the PKG_METADATA_DIR environment variable set to the location of the +* meta-data files, and with the PKG_REFCOUNT_DBDIR environment variable set to the location of the package reference counts database directory.

ENVIRONMENT

PKG_DBDIR
    If the -K flag isn't given, then PKG_DBDIR is the location of the package database directory. The default package database directory is /var/db/pkg.

PKG_REFCOUNT_DBDIR
    Location of the package reference counts database directory. The default location is the path to the package database directory with “.refcount” appended to the path, e.g. /var/db/pkg.refcount.

SEE ALSO
pkg_add(1), pkg_admin(1), pkg_create(1), pkg_info(1), mktemp(3), pkgsrc(7), mtree(8)

AUTHORS
Jordan Hubbard
    most of the work
John Kohl
    refined it for NetBSD
Hubert Feyrer
    NetBSD wildcard dependency processing, pkgdb, recursive "down" delete, etc.