pass Target/MetaIndexParser around into pkgAcqDiffIndex so that this can be used...

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

diff --git a/doc/apt.8.xml b/doc/apt.8.xml
index 0340e043f186945b2afc0532b49ed8491342e2d5..8d3b00fb3f14c74537ced0fe923e055d25d924c4 100644 (file)
--- a/doc/apt.8.xml
+++ b/doc/apt.8.xml
@@ -13,7 +13,6 @@
 <refentry>
 
  <refentryinfo>
 <refentry>
 
  <refentryinfo>

-   &apt-author.jgunthorpe;

    &apt-author.team;
    &apt-email;
    &apt-product;
    &apt-author.team;
    &apt-email;
    &apt-product;


@@ -30,30 +29,40 @@
  <!-- Man page title -->
  <refnamediv>
     <refname>apt</refname>
  <!-- Man page title -->
  <refnamediv>
     <refname>apt</refname>

-    <refpurpose>APT package -- command-line interface</refpurpose>
+    <refpurpose>command-line interface</refpurpose>

  </refnamediv>
 
  &synopsis-command-apt;
 
  <refsect1><title>Description</title>
  </refnamediv>
 
  &synopsis-command-apt;
 
  <refsect1><title>Description</title>

-   <para><command>apt</command> is the command-line tool for handling packages. It provides a commandline interface for the package management of the system.
+   <para><command>apt</command> (Advanced Package Tool) is the
+   command-line tool for handling packages. It provides a commandline
+   interface for the package management of the system.

 
    See also &apt-get; and &apt-cache; for more low-level command options.
    </para>
 
    <variablelist>
 
    See also &apt-get; and &apt-cache; for more low-level command options.
    </para>
 
    <variablelist>

-     <varlistentry><term><option>update</option></term>
-     <listitem><para><literal>update</literal> is used to
-     resynchronize the package index files from their sources.
+     <varlistentry><term><option>list</option></term>
+     <listitem><para><literal>list</literal> is used to
+     display a list of packages. It supports shell pattern for matching 
+     package names and the following options:
+       <option>--installed</option>, 
+       <option>--upgradable</option>, 
+       <option>--all-versions</option>
+     are supported.

      </para></listitem>
      </para></listitem>

-   </varlistentry>
+     </varlistentry>

      
      

-     <varlistentry><term><option>upgrade</option></term>
-     <listitem><para><literal>upgrade</literal> is used to install the
-     newest versions of all packages currently installed on the system
-     from the sources enumerated in
-     <filename>/etc/apt/sources.list</filename>. New package will be
-     installed, but existing package will never removed.
+     <varlistentry><term><option>search</option></term>
+     <listitem><para><literal>search</literal> searches for the given
+     term(s) and display matching packages.
+     </para></listitem>
+     </varlistentry>
+
+     <varlistentry><term><option>show</option></term>
+     <listitem><para><literal>show</literal> shows the package information
+     for the given package(s).

      </para></listitem>
      </varlistentry>
 
      </para></listitem>
      </varlistentry>
 


@@ -80,6 +89,35 @@
      installed instead of removed.</para></listitem>
      </varlistentry>
 
      installed instead of removed.</para></listitem>
      </varlistentry>
 

+     <varlistentry><term><option>edit-sources</option></term>
+     <listitem><para><literal>edit-sources</literal> lets you edit
+     your sources.list file and provides basic sanity checks.
+     </para></listitem>
+     </varlistentry>
+
+     <varlistentry><term><option>update</option></term>
+     <listitem><para><literal>update</literal> is used to
+     resynchronize the package index files from their sources.
+     </para></listitem>
+     </varlistentry>
+     
+     <varlistentry><term><option>upgrade</option></term>
+     <listitem><para><literal>upgrade</literal> is used to install the
+     newest versions of all packages currently installed on the system
+     from the sources enumerated in
+     <filename>/etc/apt/sources.list</filename>. New package will be
+     installed, but existing package will never removed.
+     </para></listitem>
+     </varlistentry>
+
+     <varlistentry><term><option>full-upgrade</option></term>
+     <listitem><para><literal>full-upgrade</literal> performs the
+     function of upgrade but may also remove installed packages
+     if that is required in order to resolve a package conflict.
+     </para></listitem>
+     </varlistentry>
+
+

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


@@ -93,30 +131,48 @@
    </variablelist>
  </refsect1>
 
    </variablelist>
  </refsect1>
 

+ <refsect1><title>Script usage</title>
+  <para>
+   The &apt; commandline is designed as a end-user tool and it may
+   change the output between versions. While it tries to not break
+   backward compatibility there is no guarantee for it either.
+   All features of &apt; are available in  &apt-cache; and &apt-get;
+   via APT options. Please prefer using these commands in your scripts.
+  </para>
+ </refsect1>
+

  <refsect1><title>Differences to &apt-get;</title>
  <para>The <command>apt</command> command is meant to be pleasant for
  end users and does not need to be backward compatilbe like
  &apt-get;. Therefore some options are different:
  
  <itemizedlist>
  <refsect1><title>Differences to &apt-get;</title>
  <para>The <command>apt</command> command is meant to be pleasant for
  end users and does not need to be backward compatilbe like
  &apt-get;. Therefore some options are different:
  
  <itemizedlist>

-   <listitem>The option <literal>DPkgPM::Progress-Fancy</literal> is enabled.
+   <listitem>
+     <para>The option <literal>DPkgPM::Progress-Fancy</literal> is enabled.
+     </para>

    </listitem>
    </listitem>

-   <listitem>The option <literal>APT::Color</literal> is enabled.
+   <listitem>
+     <para>The option <literal>APT::Color</literal> is enabled.
+     </para>

    </listitem>
    </listitem>

-   <listitem>A new <literal>list</literal> command is available
-   similar to <literal>dpkg --list</literal>.
+   <listitem>
+     <para>A new <literal>list</literal> command is available
+     similar to <literal>dpkg --list</literal>.
+     </para>

    </listitem>
    </listitem>

-   <listitem>The option <literal>upgrade</literal> has
-   <literal>--with-new-pkgs</literal> enabled by default.
+   <listitem>
+     <para>The option <literal>upgrade</literal> has
+     <literal>--with-new-pkgs</literal> enabled by default.
+     </para>

    </listitem>
 
  </itemizedlist>
    </listitem>
 
  </itemizedlist>

-

  </para>
  </para>

+

  </refsect1>
 
  <refsect1><title>See Also</title>
  </refsect1>
 
  <refsect1><title>See Also</title>

-   <para>&apt-get; &apt-cache;, &sources-list;,
+   <para>&apt-get;, &apt-cache;, &sources-list;,

    &apt-conf;, &apt-config;, 
    The APT User's guide in &guidesdir;, &apt-preferences;, the APT Howto.</para>
  </refsect1>
    &apt-conf;, &apt-config;, 
    The APT User's guide in &guidesdir;, &apt-preferences;, the APT Howto.</para>
  </refsect1>