diff options
Diffstat (limited to 'doc/apt-cache.8.xml')
| -rw-r--r-- | doc/apt-cache.8.xml | 99 |
1 files changed, 35 insertions, 64 deletions
diff --git a/doc/apt-cache.8.xml b/doc/apt-cache.8.xml index 1393de015..0955c1c9e 100644 --- a/doc/apt-cache.8.xml +++ b/doc/apt-cache.8.xml @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="utf-8" standalone="no"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % aptent SYSTEM "apt.ent"> %aptent; @@ -18,7 +18,7 @@ &apt-email; &apt-product; <!-- The last update date --> - <date>04 February 2011</date> + <date>2012-06-09T00:00:00Z</date> </refentryinfo> <refmeta> @@ -33,34 +33,8 @@ <refpurpose>query the APT cache</refpurpose> </refnamediv> - <!-- Arguments --> - <refsynopsisdiv> - <cmdsynopsis> - <command>apt-cache</command> - <arg><option>-hvsn</option></arg> - <arg><option>-o=<replaceable>config string</replaceable></option></arg> - <arg><option>-c=<replaceable>file</replaceable></option></arg> - <group choice="req"> - <arg>gencaches</arg> - <arg>showpkg <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg> - <arg>showsrc <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg> - <arg>stats</arg> - <arg>dump</arg> - <arg>dumpavail</arg> - <arg>unmet</arg> - <arg>search <arg choice="plain"><replaceable>regex</replaceable></arg></arg> - <arg>show <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg> - <arg>depends <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg> - <arg>rdepends <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg> - <arg>pkgnames <arg choice="plain"><replaceable>prefix</replaceable></arg></arg> - <arg>dotty <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg> - <arg>xvcg <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg> - <arg>policy <arg choice="plain" rep="repeat"><replaceable>pkgs</replaceable></arg></arg> - <arg>madison <arg choice="plain" rep="repeat"><replaceable>pkgs</replaceable></arg></arg> - </group> - </cmdsynopsis> - </refsynopsisdiv> - + &synopsis-command-apt-cache; + <refsect1><title>Description</title> <para><command>apt-cache</command> performs a variety of operations on APT's package cache. <command>apt-cache</command> does not manipulate the state of the system @@ -71,14 +45,12 @@ commands below must be present.</para> <variablelist> - <varlistentry><term>gencaches</term> - <listitem><para><literal>gencaches</literal> performs the same operation as - <command>apt-get check</command>. It builds the source and package caches from - the sources in &sources-list; and from - <filename>/var/lib/dpkg/status</filename>.</para></listitem> + <varlistentry><term><option>gencaches</option></term> + <listitem><para><literal>gencaches</literal> creates APT's package cache. This is done + implicitly by all commands needing this cache if it is missing or outdated.</para></listitem> </varlistentry> - <varlistentry><term>showpkg <replaceable>pkg(s)</replaceable></term> + <varlistentry><term><option>showpkg</option> <option><replaceable>&synopsis-pkg;</replaceable>…</option></term> <listitem><para><literal>showpkg</literal> 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 @@ -112,7 +84,7 @@ Reverse Provides: is best to consult the apt source code.</para></listitem> </varlistentry> - <varlistentry><term>stats</term><listitem><para><literal>stats</literal> displays some statistics about the cache. + <varlistentry><term><option>stats</option></term><listitem><para><literal>stats</literal> displays some statistics about the cache. No further arguments are expected. Statistics reported are: <itemizedlist> <listitem><para><literal>Total package names</literal> is the number of package names found @@ -128,20 +100,20 @@ Reverse Provides: <listitem><para><literal>Pure virtual packages</literal> 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".</para> </listitem> <listitem><para><literal>Single virtual packages</literal> 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".</para> </listitem> <listitem><para><literal>Mixed virtual packages</literal> 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.</para> </listitem> @@ -155,8 +127,8 @@ Reverse Provides: <listitem><para><literal>Total distinct</literal> 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 + number of total package names. 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.</para> </listitem> @@ -167,38 +139,36 @@ Reverse Provides: </para></listitem> </varlistentry> - <varlistentry><term>showsrc <replaceable>pkg(s)</replaceable></term> + <varlistentry><term><option>showsrc</option> <option><replaceable>&synopsis-pkg;</replaceable>…</option></term> <listitem><para><literal>showsrc</literal> 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.</para></listitem> + records that declare the name to be a binary package.</para></listitem> </varlistentry> - <varlistentry><term>dump</term> + <varlistentry><term><option>dump</option></term> <listitem><para><literal>dump</literal> shows a short listing of every package in the cache. It is primarily for debugging.</para></listitem> </varlistentry> - <varlistentry><term>dumpavail</term> + <varlistentry><term><option>dumpavail</option></term> <listitem><para><literal>dumpavail</literal> prints out an available list to stdout. This is suitable for use with &dpkg; and is used by the &dselect; method.</para></listitem> </varlistentry> - <varlistentry><term>unmet</term> + <varlistentry><term><option>unmet</option></term> <listitem><para><literal>unmet</literal> displays a summary of all unmet dependencies in the package cache.</para></listitem> </varlistentry> - <varlistentry><term>show <replaceable>pkg(s)</replaceable></term> + <varlistentry><term><option>show</option> <option><replaceable>&synopsis-pkg;</replaceable>…</option></term> <listitem><para><literal>show</literal> performs a function similar to <command>dpkg --print-avail</command>; it displays the package records for the named packages.</para></listitem> </varlistentry> - <varlistentry><term>search <replaceable>regex [ regex ... ]</replaceable></term> + <varlistentry><term><option>search</option> <option><replaceable>&synopsis-regex;</replaceable>…</option></term> <listitem><para><literal>search</literal> performs a full text search on all available package - lists for the POSIX regex pattern given, see - <citerefentry><refentrytitle><command>regex</command></refentrytitle> - <manvolnum>7</manvolnum></citerefentry>. + 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 @@ -212,17 +182,17 @@ Reverse Provides: are and'ed together.</para></listitem> </varlistentry> - <varlistentry><term>depends <replaceable>pkg(s)</replaceable></term> + <varlistentry><term><option>depends</option> <option><replaceable>&synopsis-pkg;</replaceable>…</option></term> <listitem><para><literal>depends</literal> shows a listing of each dependency a package has and all the possible other packages that can fulfill that dependency.</para></listitem> </varlistentry> - <varlistentry><term>rdepends <replaceable>pkg(s)</replaceable></term> + <varlistentry><term><option>rdepends</option> <option><replaceable>&synopsis-pkg;</replaceable>…</option></term> <listitem><para><literal>rdepends</literal> shows a listing of each reverse dependency a package has.</para></listitem> </varlistentry> - <varlistentry><term>pkgnames <replaceable>[ prefix ]</replaceable></term> + <varlistentry><term><option>pkgnames</option> <optional><replaceable>&synopsis-prefix;</replaceable></optional></term> <listitem><para>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 @@ -233,7 +203,7 @@ Reverse Provides: </para></listitem> </varlistentry> - <varlistentry><term>dotty <replaceable>pkg(s)</replaceable></term> + <varlistentry><term><option>dotty</option> <option><replaceable>&synopsis-pkg;</replaceable>…</option></term> <listitem><para><literal>dotty</literal> takes a list of packages on the command line and generates output suitable for use by dotty from the <ulink url="http://www.research.att.com/sw/tools/graphviz/">GraphViz</ulink> @@ -244,26 +214,26 @@ Reverse Provides: set the <literal>APT::Cache::GivenOnly</literal> option.</para> <para>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.</para> + (leaf packages), blue lines are pre-depends, green lines are conflicts.</para> <para>Caution, dotty cannot graph larger sets of packages.</para></listitem> </varlistentry> - <varlistentry><term>xvcg <replaceable>pkg(s)</replaceable></term> + <varlistentry><term><option>xvcg</option> <option><replaceable>&synopsis-pkg;</replaceable>…</option></term> <listitem><para>The same as <literal>dotty</literal>, only for xvcg from the <ulink url="http://rw4.cs.uni-sb.de/users/sander/html/gsvcg1.html">VCG tool</ulink>. </para></listitem></varlistentry> - <varlistentry><term>policy <replaceable>[ pkg(s) ]</replaceable></term> + <varlistentry><term><option>policy</option> <optional><replaceable>&synopsis-pkg;</replaceable>…</optional></term> <listitem><para><literal>policy</literal> 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.</para></listitem> </varlistentry> - <varlistentry><term>madison <replaceable>[ pkg(s) ]</replaceable></term> + <varlistentry><term><option>madison</option> <option><replaceable>&synopsis-pkg;</replaceable>…</option></term> <listitem><para><literal>apt-cache</literal>'s <literal>madison</literal> command attempts to mimic the output format and a subset of the functionality of the Debian archive management tool, <literal>madison</literal>. It displays @@ -301,7 +271,8 @@ Reverse Provides: </varlistentry> <varlistentry><term><option>-i</option></term><term><option>--important</option></term> - <listitem><para>Print only important dependencies; for use with unmet and depends. Causes only Depends and + <listitem><para>Print only important dependencies; for use with <literal>unmet</literal> + and <literal>depends</literal>. Causes only Depends and Pre-Depends relations to be printed. Configuration Item: <literal>APT::Cache::Important</literal>.</para></listitem> </varlistentry> @@ -329,7 +300,7 @@ Reverse Provides: <listitem><para>Print full records for all available versions. This is the default; to turn it off, use <option>--no-all-versions</option>. If <option>--no-all-versions</option> 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 <literal>show</literal> command. Configuration Item: <literal>APT::Cache::AllVersions</literal>.</para></listitem> </varlistentry> |