Backport rred patches from my own sid branch to the 0.7.25 branch

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

diff --git a/doc/apt-cache.8.xml b/doc/apt-cache.8.xml
index f2a49f3fa33065cb340f12f55398de337d37394f..538de3c2774cfcec977c7cb8aa2bf7790646b3ac 100644 (file)
--- a/doc/apt-cache.8.xml
+++ b/doc/apt-cache.8.xml
@@ -8,11 +8,20 @@
 ]>
 
 <refentry>
 ]>
 
 <refentry>

- &apt-docinfo;
+
+ <refentryinfo>
+   &apt-author.jgunthorpe;
+   &apt-author.team;
+   &apt-email;
+   &apt-product;
+   <!-- The last update date -->
+   <date>29 February 2004</date>
+ </refentryinfo>

  
  <refmeta>
    <refentrytitle>apt-cache</refentrytitle>
    <manvolnum>8</manvolnum>
  
  <refmeta>
    <refentrytitle>apt-cache</refentrytitle>
    <manvolnum>8</manvolnum>

+   <refmiscinfo class="manual">APT</refmiscinfo>

  </refmeta>
  
  <!-- Man page title -->
  </refmeta>
  
  <!-- Man page title -->


@@ -43,6 +52,7 @@
          <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>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>   
          <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>   


@@ -141,9 +151,9 @@ Reverse Provides:
    
        <listitem><para><literal>Missing</literal> is the number of package names that were referenced in
        a dependency but were not provided by any package. Missing packages may 
    
        <listitem><para><literal>Missing</literal> 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
        (real or virtual) has been dropped from the distribution. Usually they

-       are referenced from Conflicts statements.</para>
+       are referenced from Conflicts or Breaks statements.</para>

        </listitem>
 
        <listitem><para><literal>Total distinct</literal> versions is the number of package versions 
        </listitem>
 
        <listitem><para><literal>Total distinct</literal> versions is the number of package versions 


@@ -183,15 +193,20 @@ Reverse Provides:
 
      <varlistentry><term>show <replaceable>pkg(s)</replaceable></term>
      <listitem><para><literal>show</literal> performs a function similar to 
 
      <varlistentry><term>show <replaceable>pkg(s)</replaceable></term>
      <listitem><para><literal>show</literal> performs a function similar to 

-     <command>dpkg --print-avail</command>i; it displays the package records for the 
+     <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>
      <listitem><para><literal>search</literal> performs a full text search on all available package
      named packages.</para></listitem>
      </varlistentry>
 
      <varlistentry><term>search <replaceable>regex [ regex ... ]</replaceable></term>
      <listitem><para><literal>search</literal> performs a full text search on all available package

-     lists for the regex pattern given. It searches the package names and the
+     lists for the POSIX regex pattern given, see 
+     <citerefentry><refentrytitle><command>regex</command></refentrytitle>
+     <manvolnum>7</manvolnum></citerefentry>.
+     It searches the package names and the

      descriptions for an occurrence of the regular expression and prints out
      descriptions for an occurrence of the regular expression and prints out

-     the package name and the short description. If <option>--full</option> is given
+     the package name and the short description, including virtual package
+     names.
+     If <option>--full</option> is given

      then output identical to <literal>show</literal> is produced for each matched
      package, and if <option>--names-only</option> is given then the long description
      is not searched, only the package name is.</para>
      then output identical to <literal>show</literal> is produced for each matched
      package, and if <option>--names-only</option> is given then the long description
      is not searched, only the package name is.</para>


@@ -206,16 +221,19 @@ Reverse Provides:
      </varlistentry>
 
      <varlistentry><term>rdepends <replaceable>pkg(s)</replaceable></term>
      </varlistentry>
 
      <varlistentry><term>rdepends <replaceable>pkg(s)</replaceable></term>

-     <listitem><para><literal>rdepends</literal>shows a listing of each reverse dependency a
+     <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>
       package has.</para></listitem>
      </varlistentry>
 
      <varlistentry><term>pkgnames <replaceable>[ prefix ]</replaceable></term>

-     <listitem><para>This command prints the name of each package in the system. The optional
+     <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 
      extremely quickly. This command is best used with the 
      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>--generate</option> option.</para></listitem>
+     <option>--generate</option> option.</para>
+     <para>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.
+     </para></listitem>

      </varlistentry>
      
      <varlistentry><term>dotty <replaceable>pkg(s)</replaceable></term>
      </varlistentry>
      
      <varlistentry><term>dotty <replaceable>pkg(s)</replaceable></term>


@@ -236,8 +254,13 @@ Reverse Provides:
      <para>Caution, dotty cannot graph larger sets of packages.</para></listitem>
      </varlistentry>
      
      <para>Caution, dotty cannot graph larger sets of packages.</para></listitem>
      </varlistentry>
      

+     <varlistentry><term>xvcg <replaceable>pkg(s)</replaceable></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>policy <replaceable>[ pkg(s) ]</replaceable></term>

-     <listitem><para><literal>policy</literal> is ment to help debug issues relating to the 
+     <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>
      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>


@@ -269,7 +292,7 @@ Reverse Provides:
      <listitem><para>Select the file to store the source cache. The source is used only by
      <literal>gencaches</literal> and it stores a parsed version of the package 
      information from remote sources. When building the package cache the 
      <listitem><para>Select the file to store the source cache. The source is used only by
      <literal>gencaches</literal> and it stores a parsed version of the package 
      information from remote sources. When building the package cache the 

-     source cache is used to advoid reparsing all of the package files.
+     source cache is used to avoid reparsing all of the package files.

      Configuration Item: <literal>Dir::Cache::srcpkgcache</literal>.</para></listitem>
      </varlistentry>
 
      Configuration Item: <literal>Dir::Cache::srcpkgcache</literal>.</para></listitem>
      </varlistentry>
 


@@ -281,7 +304,7 @@ Reverse Provides:
      </varlistentry>
 
      <varlistentry><term><option>-i</option></term><term><option>--important</option></term>
      </varlistentry>
 
      <varlistentry><term><option>-i</option></term><term><option>--important</option></term>

-     <listitem><para>Print only important dependencies; for use with unmet. Causes only Depends and 
+     <listitem><para>Print only important dependencies; for use with unmet and depends. Causes only Depends and 

      Pre-Depends relations to be printed.
      Configuration Item: <literal>APT::Cache::Important</literal>.</para></listitem>
      </varlistentry>
      Pre-Depends relations to be printed.
      Configuration Item: <literal>APT::Cache::Important</literal>.</para></listitem>
      </varlistentry>


@@ -337,21 +360,8 @@ Reverse Provides:
 
  <refsect1><title>Files</title>
    <variablelist>
 
  <refsect1><title>Files</title>
    <variablelist>

-     <varlistentry><term><filename>/etc/apt/sources.list</filename></term>
-     <listitem><para>Locations to fetch packages from.
-     Configuration Item: <literal>Dir::Etc::SourceList</literal>.</para></listitem>
-     </varlistentry>
-     
-     <varlistentry><term><filename>&statedir;/lists/</filename></term>
-     <listitem><para>Storage area for state information for each package resource specified in
-     &sources-list;
-     Configuration Item: <literal>Dir::State::Lists</literal>.</para></listitem>
-     </varlistentry>
-  
-     <varlistentry><term><filename>&statedir;/lists/partial/</filename></term>
-     <listitem><para>Storage area for state information in transit.
-     Configuration Item: <literal>Dir::State::Lists</literal> (implicit partial).</para></listitem>
-     </varlistentry>     
+     &file-sourceslist;
+     &file-statelists;

    </variablelist>
  </refsect1>
 
    </variablelist>
  </refsect1>
 


@@ -366,6 +376,5 @@ Reverse Provides:
  </refsect1>
 
  &manbugs;
  </refsect1>
 
  &manbugs;

- &manauthor;

  
 </refentry>
  
 </refentry>