clarify the note for the pkgnames command in the manpage (Closes: #547599)

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

diff --git a/doc/apt-cache.8.xml b/doc/apt-cache.8.xml
index 7ba0046237acb856d19e481e3884c2ef567db6eb..9851135b147b85e0c1caabed46d52ca8481c75e9 100644 (file)
--- a/doc/apt-cache.8.xml
+++ b/doc/apt-cache.8.xml
@@ -21,6 +21,7 @@
  <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 -->


@@ -51,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>   


@@ -198,8 +200,8 @@ Reverse Provides:
      <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 POSIX regex pattern given, see 
      <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 POSIX regex pattern given, see 

-     <refentrytitle><command>regex</command></refentrytitle>
-     <manvolnum>7</manvolnum>.
+     <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
      the package name and the short description, including virtual package
      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


@@ -224,11 +226,14 @@ Reverse Provides:
      </varlistentry>
 
      <varlistentry><term>pkgnames <replaceable>[ prefix ]</replaceable></term>
      </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 nessasarily 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>


@@ -249,6 +254,11 @@ 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>
      <listitem><para><literal>policy</literal> is meant to help debug issues relating to the 
      preferences file. With no arguments it will print out the 
      <varlistentry><term>policy <replaceable>[ pkg(s) ]</replaceable></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 


@@ -294,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>


@@ -350,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>