X-Git-Url: https://git.saurik.com/apt.git/blobdiff_plain/b7080ced608f012aee2566afc724c3727e75fc1b..995a4bf6d770a5cc824c38388909f23fcca558c3:/doc/apt-get.8.xml diff --git a/doc/apt-get.8.xml b/doc/apt-get.8.xml index 18f26e569..785b4e9a8 100644 --- a/doc/apt-get.8.xml +++ b/doc/apt-get.8.xml @@ -1,13 +1,9 @@ - -%aptent; - - -%aptverbatiment; - + %aptent; + %aptverbatiment; + %aptvendor; ]> @@ -18,7 +14,7 @@ &apt-email; &apt-product; - 08 November 2008 + 2012-06-09T00:00:00Z @@ -33,95 +29,19 @@ APT package handling utility -- command-line interface - - - - apt-get - - - - - - - - - - - target_release - - - - - update - upgrade - dselect-upgrade - dist-upgrade - install - pkg - - - - =pkg_version_number - - - /target_release - - - - - - remove pkg - purge pkg - source - pkg - - - - =pkg_version_number - - - /target_release - - - - - - build-dep pkg - check - clean - autoclean - autoremove - - - -v - --version - - - - - -h - --help - - - - - - + &synopsis-command-apt-get; + Description apt-get is the command-line tool for handling packages, and may be considered the user's "back-end" to other tools using the APT - library. Several "front-end" interfaces exist, such as &dselect;, + library. Several "front-end" interfaces exist, such as &aptitude;, &synaptic; and &wajig;. Unless the , or option is given, one of the commands below must be present. - update + update is used to resynchronize the package index files from their sources. The indexes of available packages are fetched from the location(s) specified in /etc/apt/sources.list. @@ -133,7 +53,7 @@ of the package files cannot be known in advance. - upgrade + upgrade is used to install the newest versions of all packages currently installed on the system from the sources enumerated in /etc/apt/sources.list. Packages currently installed with @@ -146,37 +66,37 @@ available. - dselect-upgrade - dselect-upgrade - is used in conjunction with the traditional Debian packaging - front-end, &dselect;. dselect-upgrade - follows the changes made by &dselect; to the Status - field of available packages, and performs the actions necessary to realize - that state (for instance, the removal of old and the installation of new - packages). - - - dist-upgrade + dist-upgrade in addition to performing the function of upgrade, also intelligently handles changing dependencies with new versions of packages; apt-get has a "smart" conflict resolution system, and it will attempt to upgrade the most important packages at the expense of less important ones if necessary. - So, dist-upgrade command may remove some packages. + The dist-upgrade command may therefore remove some packages. The /etc/apt/sources.list file contains a list of locations from which to retrieve desired package files. See also &apt-preferences; for a mechanism for overriding the general settings for individual packages. - install + + dselect-upgrade + is used in conjunction with the traditional Debian packaging + front-end, &dselect;. dselect-upgrade + follows the changes made by &dselect; to the Status + field of available packages, and performs the actions necessary to realize + that state (for instance, the removal of old and the installation of new + packages). + + + install is followed by one or more packages desired for installation or upgrading. Each package is a package name, not a fully qualified - filename (for instance, in a Debian GNU/Linux system, - libc6 would be the argument provided, not - libc6_1.9.6-2.deb). All packages required + filename (for instance, in a Debian system, + apt-utils would be the argument provided, not + apt-utils_&apt-product-version;_amd64.deb). All packages required by the package(s) specified for installation will also be retrieved and installed. The /etc/apt/sources.list file is @@ -223,78 +143,78 @@ with a '^' or '$' character, or create a more specific regular expression. - remove + remove is identical to install except that packages are - removed instead of installed. Note the removing a package leaves its - configuration files in system. If a plus sign is appended to the package + removed instead of installed. Note that removing a package leaves its + configuration files on the system. If a plus sign is appended to the package name (with no intervening space), the identified package will be installed instead of removed. - purge + purge is identical to remove except that packages are removed and purged (any configuration files are deleted too). - source + source causes apt-get to fetch source packages. APT will examine the available packages to decide which source package to fetch. It will then find and download into the current directory the - newest available version of that source package while respect the + newest available version of that source package while respecting the default release, set with the option APT::Default-Release, the option or per package with the pkg/release syntax, if possible. Source packages are tracked separately - from binary packages via deb-src type lines + from binary packages via deb-src lines in the &sources-list; file. This means that you will need to add such a line - for each repository you want to get sources from. If you don't do this - you will properly get another (newer, older or none) source version than - the one you have installed or could install. + for each repository you want to get sources from; otherwise you will probably + get either the wrong (too old/too new) source versions or none at all. If the option is specified then the package will be compiled to a binary .deb using - dpkg-buildpackage, if - is specified then the source package will not be unpacked. + dpkg-buildpackage for the architecture as + defined by the --host-architecture option. + If is specified then the source package + will not be unpacked. A specific source version can be retrieved by postfixing the source name with an equals and then the version to fetch, similar to the mechanism used for the package files. This enables exact matching of the source package name and version, implicitly enabling the APT::Get::Only-Source option. - - Note that source packages are not tracked like binary packages, they - exist only in the current directory and are similar to downloading source - tar balls. + + Note that source packages are not installed and tracked in the + dpkg database like binary packages; they are simply downloaded + to the current directory, like source tarballs. - build-dep + build-dep causes apt-get to install/remove packages in an - attempt to satisfy the build dependencies for a source package. + attempt to satisfy the build dependencies for a source package. By default the dependencies are + satisfied to build the package natively. If desired a host-architecture can be specified + with the option instead. - check + check is a diagnostic tool; it updates the package cache and checks for broken dependencies. - download + download will download the given - binary package into the current directoy. + binary package into the current directory. - clean + clean clears out the local repository of retrieved package files. It removes everything but the lock file from &cachedir;/archives/ and - &cachedir;/archives/partial/. When APT is used as a - &dselect; method, clean is run automatically. - Those who do not use dselect will likely want to run apt-get clean - from time to time to free up disk space. + &cachedir;/archives/partial/. - autoclean + (and the alias since 1.1) Like clean, autoclean clears out the local repository of retrieved package files. The difference is that it only removes package files that can no longer be downloaded, and are largely @@ -304,25 +224,36 @@ erased if it is set to off. - autoremove + (and the alias since 1.1) autoremove is used to remove packages that were automatically - installed to satisfy dependencies for some package and that are no more needed. - - - changelog - changelog downloads a package changelog and displays - it through sensible-pager. The server name and base - directory is defined in the APT::Changelogs::Server - variable (e. g. http://packages.debian.org/changelogs for - Debian or http://changelogs.ubuntu.com/changelogs for - Ubuntu). - By default it displays the changelog for the version that is - installed. However, you can specify the same options as for - the command. - + installed to satisfy dependencies for other packages and are now no longer needed. + + + + changelog tries to download the + changelog of a package and displays it through + sensible-pager. By default it + displays the changelog for the version that is installed. + However, you can specify the same options as for the + command. + + Displays by default a deb822 formatted listing of + information about all data files (aka index targets) apt-get + update would download. Supports a + option to modify the output format as + well as accepts lines of the default output to filter the records + by. The command is mainly used as an interface for external tools + working with APT to get information as well as filenames for + downloaded files so they can use them as well instead of + downloading them again on their own. Detailed documentation is + omitted here and can instead be found in the source tree in + doc/acquire-additional-files.txt. + + + @@ -355,7 +286,7 @@ running APT for the first time; APT itself does not allow broken package dependencies to exist on a system. It is possible that a system's dependency structure can be so corrupt as to require manual intervention - (which usually means using &dselect; or dpkg --remove to eliminate some of + (which usually means using dpkg --remove to eliminate some of the offending packages). Use of this option together with may produce an error in some situations. Configuration Item: APT::Get::Fix-Broken. @@ -363,7 +294,7 @@ - Ignore missing packages; If packages cannot be retrieved or fail the + Ignore missing packages; if packages cannot be retrieved or fail the integrity check after retrieval (corrupted package files), hold back those packages and handle the result. Use of this option together with may produce an error in some situations. If a package is @@ -384,9 +315,9 @@ Quiet; produces output suitable for logging, omitting progress indicators. More q's will produce more quiet up to a maximum of 2. You can also use to set the quiet level, overriding the configuration file. - Note that quiet level 2 implies , you should never use -qq + Note that quiet level 2 implies ; you should never use -qq without a no-action modifier such as -d, --print-uris or -s as APT may - decided to do something you did not expect. + decide to do something you did not expect. Configuration Item: quiet. @@ -396,21 +327,20 @@ - No action; perform a simulation of events that would occur but do not - actually change the system. - Configuration Item: APT::Get::Simulate. - - Simulation run as user will deactivate locking (Debug::NoLocking) - automatic. Also a notice will be displayed indicating that this is only a simulation, - if the option APT::Get::Show-User-Simulation-Note is set (Default: true). - Neither NoLocking nor the notice will be triggered if run as root (root should know what - he is doing without further warnings by apt-get). - - Simulate prints out - a series of lines each one representing a dpkg operation, Configure (Conf), - Remove (Remv), Unpack (Inst). Square brackets indicate broken packages - and empty set of square brackets meaning breaks that are of no consequence - (rare). + No action; perform a simulation of events that would occur + based on the current system state but do not actually change the + system. Locking will be disabled () + so the system state could change while apt-get is + running. Simulations can also be executed by non-root users which might + not have read access to all apt configuration distorting the simulation. + A notice expressing this warning is also shown by default for non-root + users (). + Configuration Item: APT::Get::Simulate. + + Simulated runs print out a series of lines, each representing a dpkg + operation: configure (Conf), remove (Remv) + or unpack (Inst). Square brackets indicate broken packages, and + empty square brackets indicate breaks that are of no consequence (rare). @@ -422,8 +352,13 @@ Configuration Item: APT::Get::Assume-Yes. + + Automatic "no" to all prompts. + Configuration Item: APT::Get::Assume-No. + + - Show upgraded packages; Print out a list of all packages that are to be + Show upgraded packages; print out a list of all packages that are to be upgraded. Configuration Item: APT::Get::Show-Upgraded. @@ -433,6 +368,27 @@ Configuration Item: APT::Get::Show-Versions. + + + This option controls the architecture packages are built for + by apt-get source --compile and how cross-builddependencies + are satisfied. By default is it not set which means that the host architecture + is the same as the build architecture (which is defined by APT::Architecture). + Configuration Item: APT::Get::Host-Architecture. + + + + + + This option controls the activated build profiles for which + a source package is built by apt-get source --compile and + how build dependencies are satisfied. By default no build profile is active. + More than one build profile can be activated at a time by concatenating them + with a comma. + Configuration Item: APT::Build-Profiles. + + + Compile source packages after downloading them. @@ -440,38 +396,75 @@ - Ignore package Holds; This causes apt-get to ignore a hold + Ignore package holds; this causes apt-get to ignore a hold placed on a package. This may be useful in conjunction with dist-upgrade to override a large number of undesired holds. Configuration Item: APT::Ignore-Hold. + + Allow installing new packages when used in + conjunction with upgrade. This is useful if + the update of a installed package requires new dependencies to be + installed. Instead of holding the package back upgrade + will upgrade the package and install the new dependencies. Note that + upgrade with this option will never remove packages, + only allow adding new ones. + Configuration Item: APT::Get::Upgrade-Allow-New. + + + - Do not upgrade packages; When used in conjunction with install, + Do not upgrade packages; when used in conjunction with install, no-upgrade will prevent packages on the command line from being upgraded if they are already installed. Configuration Item: APT::Get::Upgrade. - Do not install new packages; When used in conjunction with install, - only-upgrade will prevent packages on the command line - from being upgraded if they are not already installed. + Do not install new packages; when used in conjunction + with install, only-upgrade will + install upgrades for already installed packages only and ignore requests + to install new packages. Configuration Item: APT::Get::Only-Upgrade. + + This is a dangerous option that will cause apt to continue + without prompting if it is doing downgrades. It + should not be used except in very special situations. Using + it can potentially destroy your system! + Configuration Item: APT::Get::allow-downgrades. Introduced in APT 1.1. + + + + Force yes; this is a dangerous option that will cause apt to continue + without prompting if it is removing essentials. It + should not be used except in very special situations. Using + it can potentially destroy your system! + Configuration Item: APT::Get::allow-remove-essential. Introduced in APT 1.1. + + + + Force yes; this is a dangerous option that will cause apt to continue + without prompting if it is changing held packages. It + should not be used except in very special situations. Using + it can potentially destroy your system! + Configuration Item: APT::Get::allow-change-held-packages. Introduced in APT 1.1. + + - Force yes; This is a dangerous option that will cause apt to continue + Force yes; this is a dangerous option that will cause apt to continue without prompting if it is doing something potentially harmful. It should not be used except in very special situations. Using force-yes can potentially destroy your system! - Configuration Item: APT::Get::force-yes. + Configuration Item: APT::Get::force-yes. This is deprecated and replaced by , , in 1.1. Instead of fetching the files to install their URIs are printed. Each URI will have the path, the destination file name, the size and the expected - md5 hash. Note that the file name to write to will not always match + MD5 hash. Note that the file name to write to will not always match the file name on the remote site! This also works with the source and update commands. When used with the update command the MD5 and size are not included, and it is @@ -488,23 +481,22 @@ - Re-Install packages that are already installed and at the newest version. + Re-install packages that are already installed and at the newest version. Configuration Item: APT::Get::ReInstall. - This option defaults to on, use --no-list-cleanup to turn it - off. When on apt-get will automatically manage the contents of - &statedir;/lists to ensure that obsolete files are erased. - The only reason to turn it off is if you frequently change your source - list. + This option is on by default; use --no-list-cleanup to turn + it off. When it is on, apt-get will automatically manage the contents + of &statedir;/lists to ensure that obsolete files are erased. + The only reason to turn it off is if you frequently change your sources list. Configuration Item: APT::Get::List-Cleanup. - This option controls the default input to the policy engine, it creates + This option controls the default input to the policy engine; it creates a default pin at priority 990 using the specified release string. This overrides the general settings in /etc/apt/preferences. Specifically pinned packages are not affected by the value @@ -520,7 +512,7 @@ Only perform operations that are 'trivial'. Logically this can be considered - related to , where will answer + related to ; where will answer yes to any prompt, will answer no. Configuration Item: APT::Get::Trivial-Only. @@ -533,7 +525,7 @@ If the command is either install or remove, - then this option acts like running autoremove command, removing the unused + then this option acts like running the autoremove command, removing unused dependency packages. Configuration Item: APT::Get::AutomaticRemove. @@ -561,11 +553,31 @@ - Ignore if packages can't be authenticated and don't prompt about it. - This is useful for tools like pbuilder. - Configuration Item: APT::Get::AllowUnauthenticated. + Ignore if packages can't be authenticated and don't prompt + about it. This can be useful while working with local repositories, + but is a huge security risk if data authenticity isn't ensured in + another way by the user itself. The usage of the + option for &sources-list; entries should + usually be preferred over this global override. Configuration Item: + APT::Get::AllowUnauthenticated. - + + + Forbid the update command to acquire unverifiable + data from configured sources. Apt will fail at the update command + for repositories without valid cryptographically signatures. + + Configuration Item: Acquire::AllowInsecureRepositories. + + + + Show user friendly progress information in the + terminal window when packages are installed, upgraded or + removed. For a machine parsable version of this data see + README.progress-reporting in the apt doc directory. + Configuration Item: Dpkg::Progress and Dpkg::Progress-Fancy. + + &apt-commonoptions; @@ -583,7 +595,7 @@ See Also - &apt-cache;, &apt-cdrom;, &dpkg;, &dselect;, &sources-list;, + &apt-cache;, &apt-cdrom;, &dpkg;, &sources-list;, &apt-conf;, &apt-config;, &apt-secure;, The APT User's guide in &guidesdir;, &apt-preferences;, the APT Howto. @@ -591,16 +603,5 @@ Diagnostics apt-get returns zero on normal operation, decimal 100 on error. - - ORIGINAL AUTHORS - &apt-author.jgunthorpe; - - - CURRENT AUTHORS - - &apt-author.team; - - &apt-qapage; - &manbugs;