acquire: Use priority queues and a 3 stage pipeline design

[apt.git] / doc / apt-cache.8.xml

diff --git a/doc/apt-cache.8.xml b/doc/apt-cache.8.xml
index a8f1b45867ee83e9c46a601186420162cc1b2932..57177993146d20889a06d461aac20fccc14e404f 100644 (file)
--- a/doc/apt-cache.8.xml
+++ b/doc/apt-cache.8.xml
@@ -14,7 +14,7 @@
    &apt-email;
    &apt-product;
    <!-- The last update date -->
-   <date>2012-06-09T00:00:00Z</date>
+   <date>2016-08-17T00:00:00Z</date>
  </refentryinfo>
  
  <refmeta>
@@ -32,10 +32,16 @@
  &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 
-   but does provide operations to search and generate interesting output 
-   from the package metadata.</para>
+    <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 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. <command>apt-get</command>,
+       so that it can be outdated if the last update is too long ago, but in
+       exchange <command>apt-cache</command> works independently of the
+       availability of the configured sources (e.g. offline).
+    </para>
 
    <para>Unless the <option>-h</option>, or <option>--help</option> option is given, one of the
    commands below must be present.</para>
@@ -135,9 +141,12 @@ Reverse Provides:
      </varlistentry>
      
      <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 package.</para></listitem>
+     <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 package. Use <option>--only-source</option> to
+     display only source package names.
+     </para></listitem>
      </varlistentry>
      
      <varlistentry><term><option>dump</option></term>
@@ -290,8 +299,8 @@ Reverse Provides:
      <varlistentry><term><option>--implicit</option></term>
        <listitem><para>Per default <command>depends</command> and <command>rdepends</command>
              print only dependencies explicitly expressed in the metadata. With this flag
-             it will also show dependencies implicitely added based on the encountered data.
-             A <literal>Conflicts: foo</literal> e.g. expresses implicitely that this package
+             it will also show dependencies implicitly added based on the encountered data.
+             A <literal>Conflicts: foo</literal> e.g. expresses implicitly that this package
              also conflicts with the package foo from any other architecture.
              Configuration Item: <literal>APT::Cache::ShowImplicit</literal>.
        </para></listitem>
@@ -341,6 +350,21 @@ Reverse Provides:
       Configuration Item: <literal>APT::Cache::Installed</literal>.</para></listitem>
       </varlistentry>
 
+      <varlistentry><term><option>--with-source</option> <option>&synopsis-param-filename;</option></term>
+      <listitem><para>
+      Adds the given file as a source for metadata. Can be repeated to add multiple files.
+      Supported are currently <literal>*.deb</literal>, <literal>*.dsc</literal>,
+      <literal>*.changes</literal>, <literal>Sources</literal> and
+      <literal>Packages</literal> files as well as source package directories.
+      Files are matched based on their name only, not their content!</para>
+      <para><literal>Sources</literal> and <literal>Packages</literal> can be compressed in any
+      format apt supports as long as they have the correct extension. If you need to store
+      multiple of these files in one directory you can prefix a name of your choice with the
+      last character being an underscore ("<literal>_</literal>"). Example: my.example_Packages.xz</para>
+      <para>Note that these sources are treated as trusted (see &apt-secure;).
+      Configuration Item: <literal>APT::Sources::With</literal>.</para></listitem>
+      </varlistentry>
+
      &apt-commonoptions;
      
    </variablelist>