From 4fe6b5fd68416bbcd6297e72444124c1a9af3a06 Mon Sep 17 00:00:00 2001 From: Wichert Akkerman Date: Fri, 12 Apr 2002 16:47:13 +0000 Subject: [PATCH] Add docbook version of dpkg(8) --- ChangeLog | 4 + man/en/dpkg.8.sgml | 1487 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 1491 insertions(+) create mode 100644 man/en/dpkg.8.sgml diff --git a/ChangeLog b/ChangeLog index d2417ebe..ab01e64f 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +Fri Apr 12 18:46:16 CEST 2002 Wichert Akkerman + + * man/en/dpkg.8.sgml: DocBook version of dpkg manpage + Wed Apr 10 00:39:58 CEST 2002 Wichert Akkerman * configure.in: use AC_SYS_LARGEFILE and bump autoconf requirement to 2.50 diff --git a/man/en/dpkg.8.sgml b/man/en/dpkg.8.sgml new file mode 100644 index 00000000..c1fc363f --- /dev/null +++ b/man/en/dpkg.8.sgml @@ -0,0 +1,1487 @@ + + + + + dpkg + 8 + Debian Project + dpkg suite + + + + dpkg + a medium-level package manager for Debian + + + + + + dpkg + options + action + + + + + Warning + + + This manual is intended for users wishing to understand + dpkg's command line options and package states in + more detail than that provided by dpkg --help. + + + + It should not be used by package maintainers + wishing to understand how dpkg will install their + packages. The descriptions of what dpkg does when + installing and removing packages are particularly inadequate. + + + + + + Description + + + dpkg is a medium-level tool to install, build, remove + and manage Debian packages. The primary and more user-friendly front-end + for dpkg is dselect (see + dselect + 8). dpkg itself + is controlled entirely via command line parameters, which consist of + exactly one action and zero or more options. The action-parameter tells + dpkg what to do and options control the behavior of + the action in some way. + + + + dpkg can be also be used as a front-end to + dpkg-deb. The following are + dpkg-deb actions, and if they are encountered, + dpkg just runs dpkg-deb with the + parameters given to it: + + + , + , + , + , + , + , + , + + + + + + Please refer to + dpkg-deb + 1 for information about these + actions. + + + + + Information About Packages + + + dpkg maintains some usable information about available + packages. The information is divided in three classes: states, + selection states and flags. These values are intended to + be changed mainly with dselect. + + + + Package States + + + + installed + + The package is unpacked and configured OK. + + + + + half-installed + + The installation of the package has been started, but not completed + for some reason. + + + + + not-installed + + The package is not installed on your system. + + + + + unpacked + + The package is unpacked, but not configured. + + + + + half-configured + + The package is unpacked and configuration has been started, but not + yet completed for some reason. + + + + + config-files + + Only the configuration files of the package exist on the system. + + + + + + + + Package Selection States + + + + install + + The package is selected for installation. + + + + + deinstall + + The package is selected for deinstallation (i.e. we want to remove + all files, except configuration files). + + + + + purge + + The package is selected to be purged (i.e. we want to remove + everything, even configuration files). + + + + + + + Package Flags + + + + hold + + A package marked to be on hold is not handled by + dpkg, unless forced to do that with option + . + + + + + reinst-required + + A package marked reinst-required is broken and requires + reinstallation. These packages cannot be removed, unless forced + with option . + + + + + + + + Actions + + + + + + dpkg + + + -i + --install + + package_file + + + + + + + Install the package. If or + option is specified, + package file must refer to a directory + instead. + + + + Installation consists of the following steps: + + + + + Extract the control files of the new package. + + + + If another version of the same package was installed before + the new installation, execute prerm script + of the old package. + + + + Run the preinst script, if provided by the + package. + + + + Unpack the new files, and at the same time back up the old files, + so that if something goes wrong, they can be restored. + + + + If another version of the same package was installed before + the new installation, execute the postrm + script of the old package. Note that this script is executed + after the preinst script of the new package, + because new files are written at the same time old files are + removed. + + + + Configure the package. See for + detailed information about how this is done. + + + + + + + + + dpkg + --unpack package_file + + + + + + Unpack the package, but don't configure it. If + or option is + specified, package_file must refer + to a directory instead. + + + + + + + + dpkg + --configure + + --pending + -a + package + + + + + + + + Reconfigure an unpacked package. If or + is given instead of + package, all unpacked but unconfigured + packages are configured. + + + + Configuring consists of the following steps: + + + + + Unpack the configuration files, and at the same time back up the + old configuration files, so that they can be restored if + something goes wrong. + + + + Run postinst script, if provided by the + package. + + + + + + + + + dpkg + + + -r + --remove + -P + --purge + + + --pending + -a + package + + + + + + + + Remove an installed package. or + remove everything except configuration + files. This may avoid having to reconfigure the package if it is + reinstalled later. (Configuration files are the files listed in the + debian/conffiles control file). + or removes everything, + including configuration files. + + + + If or is given + instead of a package name, then all packages unpacked, but + marked to be removed or purged in file + /var/lib/dpkg/status, are removed or purged, + respectively. + + + + Removing of a package consists of the following steps: + + + + + Run prerm script. + + + + Remove the installed files. + + + + Run postrm script. + + + + + + + + + dpkg + + + -p + --print-avail + + package + + + + + + Display details about , as found in + /var/lib/dpkg/available. + + + + + + + dpkg + + + --update-avail + --merge-avail + + Packages file + + + + + + Update dpkg's and dselect's + idea of which packages are available. With action + , old information is combined with + information from . With action + , old information is replaced with the + information in the . The + Packages-file distributed with Debian is simply + named Packages. dpkg keeps + its record of available packages in + /var/lib/dpkg/available. + + + + + + + dpkg + + + -A + --record-avail + + package file + + + + + + Update dpkg and dselect's idea + of which packages are available with information from the package + package file. If or + option is specified, + package file must refer to a directory + instead. + + + + + + + dpkg + --forget-old-unavail + + + + + Forget about uninstalled unavailable packages. + + + + + + + dpkg + --clear-avail + + + + + Erase the existing information about what packages are + available. + + + + + + + dpkg + + + -l + --list + + package-name-pattern + + + + + + List packages matching given pattern. If no + is given, list all packages + in /var/lib/dpkg/available. Normal shell + wildchars are allowed. (You will probably have to quote + to prevent the shell + from performing filename expansion. For example, + dpkg -l 'libc5*' will list all the package + names starting with "libc5".) + + + + + + + dpkg + + + -s + --status + + package-name + + + + + + Report status of specified package. This just displays the entry in + the installed package status database. + + + + + + + dpkg + + + -C + --audit + + + + + + + Searches for packages that have been installed only partially on your + system. dpkg will suggest what to do with them to + get them working. + + + + + + + dpkg + --get-selections pattern + + + + + Get list of package selections, and write it to stdout. + + + + + + + dpkg + --set-selections + + + + + Set package selections using file read from stdin. + + + + + + + dpkg + --yet-to-unpack + + + + + Searches for packages selected for installation, but which for some + reason still haven't been installed. + + + + + + + dpkg + + + -L + --listfiles + + package + + + + + + List files installed to your system from . + However, note that files created by package-specific + installation-scripts are not listed. + + + + + + + dpkg + + + -S + --search + + filename_search_pattern + + + + + + Search for a filename from installed packages. All standard shell + wildchars can be used in the pattern. + + + + + + + dpkg + --print-architecture + + + + + Print target architecture (for example, "i386"). This option uses + gcc. + + + + + + + dpkg + --print-gnu-build-architecture + + + + + Print GNU version of target architecture (for example, "i486"). + + + + + + + dpkg + --print-installation-architecture + + + + + Print host architecture for installation. + + + + + + + dpkg + --compare-versions + ver1 + op + ver2 + + + + + + Compare version numbers, where is a binary + operator. dpkg returns success (zero result) if + the specified condition is satisfied, and failure (nonzero result) + otherwise. There are two groups of operators, which differ in how + they treat a missing or . + These treat no version as earlier than any version: + lt le eq ne ge gt. These treat no version as + later than any version: lt-nl le-nl ge-nl gt-nl. + These are provided only for compatibility with + control file syntax: < << + <= = >= >> >. + + + + + + + dpkg + --command-fd <n> + + + + + Accept a series of commands on input file descriptor + . Note: additional options set on the + command line, and thru this file descriptor, are not reset for + subsequent commands executed during the same run. + + + + + + + dpkg + --help + + + + + Display a brief help message. + + + + + + + dpkg + --force-help + + + + + Give help about the + options. + + + + + + + dpkg + + + -Dh + --debug=help> + + + + + + + Give help about debugging options. + + + + + + + dpkg + + + --licence + --license + + + + + + + Display dpkg licence. + + + + + + + dpkg + --version + + + + + Display dpkg version information. + + + + + + dpkg-deb actions + + + + See dpkg-deb + 1 for more information + about the low-level actions. + + + + + + + Options + + + All options can be specified both on the commandline and in the + dpkg configuration file + /etc/dpkg/dpkg.cfg. Each line in the configuration + file is either an option (exactly the same as the commandline option + but without leading dashes) or a comment (if it starts with a + hash (`#') sign). + + + + + + + --abort-after=number + + + + + Change after how many errors dpkg will abort. + The default is 50. + + + + + + + + -B + --auto-deconfigure + + + + + + When a package is removed, there is a possibility that another + installed package depended on the removed package. Specifying this + option will cause automatic deconfiguration of the package which + depended on the removed package. + + + + + + + + -Doctal + --debug=octal + + + + + + + Set debugging on. is formed by + bitwise-orring desired values together from the list below (note + that these values may change in future releases). The + or options + display these debugging values. + + + + Debug flags + + + + number + description + + + + + + 1 + Generally helpful progress information + + + 2 + Invocation and status of maintainer scripts + + + 10 + Output for each file processed + + + 100 + Lots of output for each file processed + + + 20 + Output for each configuration file + + + 200 + Lots of output for each configuration file + + + 40 + Dependencies and conflicts + + + 400 + Lots of dependencies/conflicts output + + + 1000 + Lots of drivel about e.g. the dpkg/info dir + + + 2000 + Insane amounts of drivel + + + +
+ + + + + + + + --force-things + --no-force-things + --refuse-things + + + + + + + Force or refuse ( and + mean the same thing) to do + some things. is a comma separated list + of things specified below. + displays a message describing them. Things marked with + (*) are forced by default. + + + + + Warning: These options are mostly intended to be used + by experts only. Using them without fully understanding their + effects may break your whole system. + + + + + + all + + + Turns on(or off) all force options. + + + + + auto-select (*) + + + Select packages to install them, and deselect packages to + remove them. + + + + + downgrade (*) + + + Install a package, even if newer version of it is already + installed. + + + + + configure-any + + + Configure also any unpacked but unconfigured packages on + which the current package depends. + + + + + hold + + + Process packages even when marked "hold". + + + + + remove-reinstreq + + + Remove a package, even if it's broken and marked to require + reinstallation. This may, for example, cause parts of the + package to remain on the system, which will then be forgotten + by dpkg. + + + + + remove-essential + + + Remove, even if the package is considered essential. + Essential packages contain mostly very basic Unix commands. + Removing them might cause the whole system to stop working, + so use with caution. + + + + + depends + + + Turn all dependency problems into warnings. + + + + + depends-version + + + Don't care about versions when checking dependencies. + + + + + conflicts + + + Install, even if it conflicts with another package. This is + dangerous, for it will usually cause overwriting of some + files. + + + + + confnew + + + If a conffile has been modified always install the new + version without prompting. + + + + + confold + + + If a conffile has been modified always keep the old version + without prompting. + + + + + confdef + + + If a conffile has been modified always choose the default + action. If there is no default action it will stop to ask the + user unless or + is also been given, in which + case it will use that to decide the final action. + + + + + overwrite + + + Overwrite one package's file with another's file. + + + + + overwrite-dir + + + Overwrite one package's directory with another's file. + + + + + overwrite-diverted + + + Overwrite a diverted file with an undiverted version. + + + + + architecture + + + Process even packages with the wrong architecture. + + + + + bad-path + + + PATH is missing important programs, so + problems are likely. + + + + + not-root + + + Try to (de)install things even when not root. + + + + + + + + + + --ignore-depends=package, + + + + + Ignore dependency-checking for specified packages (actually, + checking is performed, but only warnings about conflicts are given, + nothing else). + + + + + + + + --new + --old + + + + + + Select new or old binary package format. This is a + dpkg-deb1 + option. + + + + + + + --nocheck + + + + + Don't read or check contents of control file + while building a package. This is a + dpkg-deb1 + option. + + + + + + + --no-act + + + + + + Do everything which is supposed to be done, but don't write any + changes. This is used to see what would happen with the specified + action, without actually modifying anything. + + + + Be sure to give before the + action-parameter, or you might end up with undesirable results. + (e.g. dpkg --purge foo --no-act will first + purge package foo and then try to purge + package --no-act, even though you probably expected it to + actually do nothing) + + + + + + + + + -R + --recursive + + + + + + Recursively handle all regular files matching pattern + *.deb found at specified directories and all + of its subdirectories. This can be used with , + , , + and + actions. + + + + + + + -G + + + + + Do not install a package if a newer version of the same package is + already installed. This is an alias of + . + + + + + + + + --root=dir + --admindir=dir + --instdir=dir + + + + + + Change default directories. defaults to + /var/lib/dpkg and contains many files that + give information about status of installed or uninstalled packages, + etc. defaults to / + and refers to the directory where packages are to be installed. + is also the directory passed to + chroot2 + before running package's installation scripts, which means that the + scripts see as a root directory. + Changing changes to + and to + /var/lib/dpkg. + + + + + + + + -O + --selected-only + + + + + + Only process the packages that are selected for installation. The + actual marking is done with dselect or by + dpkg, when it handles packages. For example, + when a package is removed, it will be marked selected for + installation. + + + + + + + + -E + --skip-same-version + + + + + + Do not install the package if the same version of the package is + already installed. + + + + + + + --status-fd <n> + + + + + Send package status info to file descriptor + . This can be given multiple times. + Status updates are of the form + `status: <pkg>: <pkg qstate>' + + + + + + + Files + + + + /etc/dpkg/dpkg.cfg + + + Configuration file with default options. + + + + + + There files are stored in the dpkg database directory + (which defaults to /var/lib/dpkg). You can + override the location with the option. + + + + + /var/lib/dpkg/available + + + List of available packages. + + + + + /var/lib/dpkg/status + + + Statuses of available packages. This file contains information about + whether a package is marked for removing or not, whether it is + installed or not, etc. + + + + + + + Environment variables + + + + DPKG_NO_TSTP + + + Define this to something if you prefer dpkg + starting a new shell rather than suspending itself, while doing a + shell escape. + + + + + SHELL + + + The program dpkg will execute while starting a new + shell. + + + + + COLUMNS + + + Sets the number of columns dpkg should use when + displaying formatted text. Currently only used by + . + + + + + DPKG_OLD_CONFFILE + + + Set by dpkg to the filename of the old + configuration file when you start a shell to examine a changed + configuration file. + + + + + DPKG_NEW_CONFFILE + + + Set by dpkg to the filename of the newversion of a + configuration file when you start a shell to examine a changed + configuration file. + + + + + + + Examples + + + To list packages related to the editor vi: + + dpkg '*vi*' + + + + To see the entries in /var/lib/dpkg/available on two + packages + + dpkg elvis vim + + + + To search the listing of packages yourself: + + less /var/lib/dpkg/available + + + + To remove an installed emacs package: + + dpkg emacs + + + + To make a local copy of the package selection states: + + dpkg > myselections + + + + You might transfer this file to another computer, and install it there + with: + + dpkg < myselections + + Note that this will not actually install or remove anything, but just + set the selection state on the requested packages. You will need some + other application to actually download and install the requested + packages. + + + + Ordinarily, you will find that + dselect8 + provides a more convenient way to modify the package selection + states. + + + + + See Also + + + + dselect + 8 + , + + + dpkg-deb + 1 + , + + + deb + 5 + , + + + deb-control + 5 + + + + + -- 2.39.5