X-Git-Url: https://git.saurik.com/apt.git/blobdiff_plain/3111692d0be3b2dc401180728e51e1b1fd2525a1..abd6af5a1ce2c20a5742c5c3182dfadce10367ca:/doc/apt-cache.8.xml diff --git a/doc/apt-cache.8.xml b/doc/apt-cache.8.xml index 6c8938d8c..a76eb1000 100644 --- a/doc/apt-cache.8.xml +++ b/doc/apt-cache.8.xml @@ -1,10 +1,9 @@ - -%aptent; - + %aptent; + %aptverbatiment; + %aptvendor; ]> @@ -15,72 +14,45 @@ &apt-email; &apt-product; - 29 February 2004 + 2012-06-09T00:00:00Z apt-cache 8 + APT apt-cache - APT package handling utility -- cache manipulator + query the APT cache - - - - apt-cache - - - - - add file - gencaches - showpkg pkg - showsrc pkg - stats - dump - dumpavail - unmet - search regex - show pkg - depends pkg - rdepends pkg - pkgnames prefix - dotty pkg - xvcg pkg - policy pkgs - madison pkgs - - - - + &synopsis-command-apt-cache; + Description - apt-cache performs a variety of operations on APT's package - cache. apt-cache does not manipulate the state of the system - but does provide operations to search and generate interesting output - from the package metadata. + + apt-cache performs a variety of operations on APT's + package cache. apt-cache does not manipulate the + state of the system but does provide operations to search and generate + interesting output from the package metadata. The metadata is acquired + and updated via the 'update' command of e.g. apt-get, + so that it can be outdated if the last update is too long ago, but in + exchange apt-cache works independently of the + availability of the configured sources (e.g. offline). + Unless the , or option is given, one of the commands below must be present. - add file(s) - add adds the named package index files to the package cache. - This is for debugging only. - - - gencaches - gencaches performs the same operation as - apt-get check. It builds the source and package caches from - the sources in &sources-list; and from - /var/lib/dpkg/status. + + gencaches creates APT's package cache. This is done + implicitly by all commands needing this cache if it is missing or outdated. - showpkg pkg(s) + showpkg displays information about the packages listed on the command line. Remaining arguments are package names. The available versions and reverse dependencies of each package listed are listed, as @@ -114,7 +86,7 @@ Reverse Provides: is best to consult the apt source code. - statsstats displays some statistics about the cache. + stats displays some statistics about the cache. No further arguments are expected. Statistics reported are: Total package names is the number of package names found @@ -130,35 +102,34 @@ Reverse Provides: Pure virtual packages is the number of packages that exist only as a virtual package name; that is, packages only "provide" the virtual package name, and no package actually uses the name. For - instance, "mail-transport-agent" in the Debian GNU/Linux system is a + instance, "mail-transport-agent" in the Debian system is a pure virtual package; several packages provide "mail-transport-agent", but there is no package named "mail-transport-agent". Single virtual packages is the number of packages with only one package providing a particular virtual package. For example, in the - Debian GNU/Linux system, "X11-text-viewer" is a virtual package, but + Debian system, "X11-text-viewer" is a virtual package, but only one package, xless, provides "X11-text-viewer". Mixed virtual packages is the number of packages that either provide a particular virtual package or have the virtual package name - as the package name. For instance, in the Debian GNU/Linux system, + as the package name. For instance, in the Debian system, "debconf" is both an actual package, and provided by the debconf-tiny package. Missing is the number of package names that were referenced in a dependency but were not provided by any package. Missing packages may - be in evidence if a full distribution is not accessed, or if a package + be an evidence if a full distribution is not accessed, or if a package (real or virtual) has been dropped from the distribution. Usually they are referenced from Conflicts or Breaks statements. Total distinct versions is the number of package versions - found in the cache; this value is therefore at least equal to the - number of total package names. If more than one distribution (both - "stable" and "unstable", for instance), is being accessed, this value + found in the cache. If more than one distribution is being accessed + (for instance, "stable" and "unstable"), this value can be considerably larger than the number of total package names. @@ -169,38 +140,39 @@ Reverse Provides: - showsrc pkg(s) - showsrc displays all the source package records that match - the given package names. All versions are shown, as well as all - records that declare the name to be a Binary. + + showsrc displays all the + source package records that match the given package names. All + versions are shown, as well as all records that declare the name + to be a binary package. Use to + display only source package names. + - dump + dump shows a short listing of every package in the cache. It is primarily for debugging. - dumpavail + dumpavail prints out an available list to stdout. This is suitable for use with &dpkg; and is used by the &dselect; method. - unmet + unmet displays a summary of all unmet dependencies in the package cache. - show pkg(s) + show performs a function similar to dpkg --print-avail; it displays the package records for the named packages. - search regex [ regex ... ] + search performs a full text search on all available package - lists for the POSIX regex pattern given, see - regex - 7. + lists for the POSIX regex pattern given, see ®ex;. It searches the package names and the descriptions for an occurrence of the regular expression and prints out the package name and the short description, including virtual package @@ -208,31 +180,34 @@ Reverse Provides: If is given then output identical to show is produced for each matched package, and if is given then the long description - is not searched, only the package name is. + is not searched, only the package name and provided packages are. Separate arguments can be used to specify multiple search patterns that are and'ed together. - depends pkg(s) + depends shows a listing of each dependency a package has and all the possible other packages that can fulfill that dependency. - rdepends pkg(s) + rdepends shows a listing of each reverse dependency a package has. - pkgnames [ prefix ] - This command prints the name of each package in the system. The optional + &synopsis-prefix; + This command prints the name of each package APT knows. The optional argument is a prefix match to filter the name list. The output is suitable for use in a shell tab complete function and the output is generated extremely quickly. This command is best used with the - option. + option. + Note that a package which APT knows of is not necessarily available to download, + installable or installed, e.g. virtual packages are also listed in the generated list. + - dotty pkg(s) + dotty takes a list of packages on the command line and generates output suitable for use by dotty from the GraphViz @@ -243,26 +218,26 @@ Reverse Provides: set the APT::Cache::GivenOnly option. The resulting nodes will have several shapes; normal packages are boxes, - pure provides are triangles, mixed provides are diamonds, + pure virtual packages are triangles, mixed virtual packages are diamonds, missing packages are hexagons. Orange boxes mean recursion was stopped - [leaf packages], blue lines are pre-depends, green lines are conflicts. + (leaf packages), blue lines are pre-depends, green lines are conflicts. Caution, dotty cannot graph larger sets of packages. - xvcg pkg(s) + The same as dotty, only for xvcg from the VCG tool. - policy [ pkg(s) ] + &synopsis-pkg;… policy is meant to help debug issues relating to the preferences file. With no arguments it will print out the priorities of each source. Otherwise it prints out detailed information about the priority selection of the named package. - madison /[ pkg(s) ] + apt-cache's madison command attempts to mimic the output format and a subset of the functionality of the Debian archive management tool, madison. It displays @@ -300,11 +275,37 @@ Reverse Provides: - Print only important dependencies; for use with unmet and depends. Causes only Depends and + Print only important dependencies; for use with unmet + and depends. Causes only Depends and Pre-Depends relations to be printed. Configuration Item: APT::Cache::Important. + + + + + + + + + Per default the depends and + rdepends print all dependencies. This can be tweaked with + these flags which will omit the specified dependency type. + Configuration Item: APT::Cache::ShowDependencyType + e.g. APT::Cache::ShowRecommends. + + + + Per default depends and rdepends + print only dependencies explicitly expressed in the metadata. With this flag + it will also show dependencies implicitely added based on the encountered data. + A Conflicts: foo e.g. expresses implicitely that this package + also conflicts with the package foo from any other architecture. + Configuration Item: APT::Cache::ShowImplicit. + + + Print full package records when searching. Configuration Item: APT::Cache::ShowFull. @@ -314,7 +315,7 @@ Reverse Provides: Print full records for all available versions. This is the default; to turn it off, use . If is specified, only the candidate version - will displayed (the one which would be selected for installation). + will be displayed (the one which would be selected for installation). This option is only applicable to the show command. Configuration Item: APT::Cache::AllVersions. @@ -326,7 +327,7 @@ Reverse Provides: - Only search on the package names, not the long descriptions. + Only search on the package and provided package names, not the long descriptions. Configuration Item: APT::Cache::NamesOnly. @@ -356,21 +357,8 @@ Reverse Provides: Files - /etc/apt/sources.list - Locations to fetch packages from. - Configuration Item: Dir::Etc::SourceList. - - - &statedir;/lists/ - Storage area for state information for each package resource specified in - &sources-list; - Configuration Item: Dir::State::Lists. - - - &statedir;/lists/partial/ - Storage area for state information in transit. - Configuration Item: Dir::State::Lists (implicit partial). - + &file-sourceslist; + &file-statelists;