]> git.saurik.com Git - apt.git/blobdiff - doc/apt-get.8.xml
merged from the debian-sid branch
[apt.git] / doc / apt-get.8.xml
index 3c245b83bc6092c92e8f0b018755f9fd3bc31fe9..64c3a35e4557011f65c25e6fd50185600c5fba2d 100644 (file)
@@ -15,7 +15,7 @@
    &apt-email;
    &apt-product;
    <!-- The last update date -->
-   <date>29 February 2004</date>
+   <date>08 November 2008</date>
  </refentryinfo>
  
  <refmeta>
  <refsynopsisdiv>
    <cmdsynopsis>
       <command>apt-get</command>
-      <arg><option>-hvs</option></arg>
-      <arg><option>-o=<replaceable>config string</replaceable></option></arg>
-      <arg><option>-c=<replaceable>file</replaceable></option></arg>
+      <arg><option>-sqdyfmubV</option></arg>
+      <arg>
+             <option>-o=
+                         <replaceable>config_string</replaceable>
+             </option>
+      </arg>
+      <arg>
+             <option>-c=
+                     <replaceable>config_file</replaceable>
+             </option>
+      </arg>
+      <arg>
+                 <option>-t=</option>
+                 <group choice='req'>
+                         <arg choice='plain'>
+                                 <replaceable>target_release_name</replaceable>
+                         </arg>
+                         <arg choice='plain'>
+                                 <replaceable>target_release_number_expression</replaceable>
+                         </arg>
+                 </group>
+      </arg>
+
       <group choice="req">
-         <arg>update</arg>
-         <arg>upgrade</arg>
-         <arg>dselect-upgrade</arg>
-         <arg>install <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
-         <arg>remove <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
-         <arg>source <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
-         <arg>build-dep <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
-         <arg>check</arg>
-         <arg>clean</arg>
-         <arg>autoclean</arg>
-         <arg>autoremove</arg>
+         <arg choice='plain'>update</arg>
+         <arg choice='plain'>upgrade</arg>
+         <arg choice='plain'>dselect-upgrade</arg>
+         <arg choice='plain'>dist-upgrade</arg>
+         <arg choice='plain'>install 
+                        <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable>
+                               <arg>
+                                       <group choice='req'>
+                                               <arg choice='plain'>
+                                                       =<replaceable>pkg_version_number</replaceable>
+                                               </arg>
+                                               <arg choice='plain'>
+                                                       /<replaceable>target_release_name</replaceable>
+                                               </arg>
+                                       </group>
+                               </arg>
+                        </arg>
+            </arg>
+         <arg choice='plain'>remove <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
+         <arg choice='plain'>purge <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
+         <arg choice='plain'>source 
+                        <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable>
+                                <arg>
+                                        =<replaceable>pkg_version_number</replaceable>
+                                </arg>
+                        </arg>
+            </arg>
+         <arg choice='plain'>build-dep <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
+         <arg choice='plain'>check</arg>
+         <arg choice='plain'>clean</arg>
+         <arg choice='plain'>autoclean</arg>
+         <arg choice='plain'>autoremove</arg>
+                <arg choice='plain'>
+                        <group choice='req'>
+                               <arg choice='plain'>-v</arg>
+                               <arg choice='plain'>--version</arg>
+                        </group>
+                </arg>
+                <arg choice='plain'>
+                        <group choice='req'>
+                               <arg choice='plain'>-h</arg>
+                               <arg choice='plain'>--help</arg>
+                        </group>
+                </arg>
       </group>   
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1><title>Description</title>
    <para><command>apt-get</command> is the command-line tool for handling packages, and may be 
    considered the user's "back-end" to other tools using the APT
-   library.  Several "front-end" interfaces exist, such as dselect(8),
-   aptitude, synaptic, gnome-apt and wajig.</para>
+   library.  Several "front-end" interfaces exist, such as &dselect;,
+   &aptitude;, &synaptic;, &gnome-apt; and &wajig;.</para>
 
    <para>Unless the <option>-h</option>, or <option>--help</option> option is given, one of the
    commands below must be present.</para>
      with new versions of packages; <command>apt-get</command> has a "smart" conflict 
      resolution system, and it will attempt to upgrade the most important 
      packages at the expense of less important ones if necessary. 
+        So, <literal>dist-upgrade</literal> command may remove some packages.
      The <filename>/etc/apt/sources.list</filename> file contains a list of locations 
      from which to retrieve desired package files.
      See also &apt-preferences; for a mechanism for
      </varlistentry>
 
      <varlistentry><term>install</term>
-     <listitem><para><literal>install</literal> is followed by one or more packages desired for 
-     installation. Each package is a package name, not a fully qualified 
-     filename (for instance, in a Debian GNU/Linux system, libc6 would be the 
-     argument provided, not <literal>libc6_1.9.6-2.deb</literal>) All packages required 
-     by the package(s) specified for installation will also be retrieved and 
-     installed. The <filename>/etc/apt/sources.list</filename> file is used to locate 
-     the desired packages. If a hyphen is appended to the package name (with 
-     no intervening space), the identified package will be removed if it is 
-     installed. Similarly a plus sign can be used to designate a package to 
-     install. These latter features may be used to override decisions made by 
-     apt-get's conflict resolution system.</para>
+     <listitem>
+        <para><literal>install</literal> is followed by one or more 
+        packages desired for installation or upgrading. 
+        Each package is a package name, not a fully qualified 
+        filename (for instance, in a Debian GNU/Linux system, 
+        libc6 would be the argument provided, not 
+        <literal>libc6_1.9.6-2.deb</literal>). All packages required 
+        by the package(s) specified for installation will also 
+        be retrieved and installed. 
+        The <filename>/etc/apt/sources.list</filename> file is 
+        used to locate the desired packages. If a hyphen is 
+        appended to the package name (with no intervening space), 
+        the identified package will be removed if it is installed. 
+        Similarly a plus sign can be used to designate a 
+        package to install. These latter features may be used 
+        to override decisions made by apt-get's conflict 
+        resolution system.
+        </para>
 
      <para>A specific version of a package can be selected for installation by 
      following the package name with an equals and the version of the package 
      <para>Both of the version selection mechanisms can downgrade packages and must
      be used with care.</para>
 
+       <para>This is also the target to use if you want to upgrade one or 
+               more already-installed packages without upgrading every package 
+               you have on your system. Unlike the "upgrade" target, which 
+               installs the newest version of all currently installed packages, 
+               "install" will install the newest version of only the package(s) 
+               specified. Simply provide the name of the package(s) you wish 
+               to upgrade, and if a newer version is available, it (and its 
+               dependencies, as described above) will be downloaded and 
+               installed.
+       </para>
+
      <para>Finally, the &apt-preferences; mechanism allows you to
      create an alternative installation policy for
      individual packages.</para>
 
      <varlistentry><term>remove</term>
      <listitem><para><literal>remove</literal> is identical to <literal>install</literal> except that packages are 
-     removed instead of installed. If a plus sign is appended to the package 
+        removed instead of installed. Note the removing a package leaves its
+        configuration files in system. If a plus sign is appended to the package 
      name (with no intervening space), the identified package will be 
      installed instead of removed.</para></listitem>
      </varlistentry>
 
+     <varlistentry><term>purge</term>
+     <listitem><para><literal>purge</literal> is identical to <literal>remove</literal> except that packages are 
+     removed and purged (any configuration files are deleted too).</para></listitem>
+     </varlistentry>
+
      <varlistentry><term>source</term>
      <listitem><para><literal>source</literal> causes <command>apt-get</command> to fetch source packages. APT 
      will examine the available packages to decide which source package to 
    &apt-cmdblurb;
 
    <variablelist>
+     <varlistentry><term><option>--no-install-recommends</option></term>
+     <listitem><para>Do not consider recommended packages as a dependency for installing.
+     Configuration Item: <literal>APT::Install-Recommends</literal>.</para></listitem>
+     </varlistentry>
+
      <varlistentry><term><option>-d</option></term><term><option>--download-only</option></term>
      <listitem><para>Download only; package files are only retrieved, not unpacked or installed.
      Configuration Item: <literal>APT::Get::Download-Only</literal>.</para></listitem>
      Configuration Item: <literal>APT::Get::Compile</literal>.</para></listitem>
      </varlistentry>
 
+     <varlistentry><term><option>--install-recommends</option></term>
+     <listitem><para>Also install recommended packages.</para></listitem>
+     </varlistentry>
+
+     <varlistentry><term><option>--no-install-recommends</option></term>
+     <listitem><para>Do not install recommended packages.</para></listitem>
+     </varlistentry>
+
      <varlistentry><term><option>--ignore-hold</option></term>
      <listitem><para>Ignore package Holds; This causes <command>apt-get</command> to ignore a hold 
      placed on a package. This may be useful in conjunction with 
      <varlistentry><term><option>--purge</option></term>
      <listitem><para>Use purge instead of remove for anything that would be removed.
      An asterisk ("*") will be displayed next to packages which are
-     scheduled to be purged.
+        scheduled to be purged. <option>remove --purge</option> is equivalent for
+        <option>purge</option> command.
      Configuration Item: <literal>APT::Get::Purge</literal>.</para></listitem>
      </varlistentry>
 
                    <term><option>--target-release</option></term>
                    <term><option>--default-release</option></term>
      <listitem><para>This option controls the default input to the policy engine, it creates
-     a default pin at priority 990 using the specified release string. The
-     preferences file may further override this setting. In short, this option
+     a default pin at priority 990 using the specified release string.
+     This overrides the general settings in <filename>/etc/apt/preferences</filename>.
+     Specifically pinned packages are not affected by the value
+     of this option. In short, this option
      lets you have simple control over which distribution packages will be
      retrieved from. Some common examples might be 
      <option>-t '2.1*'</option> or <option>-t unstable</option>.
      Item: <literal>APT::Get::Only-Source</literal>.</para></listitem>
      </varlistentry>
 
-     <varlistentry><term><option>--diff-only</option></term><term><option>--tar-only</option></term>
-     <listitem><para>Download only the diff or tar file of a source archive. 
-     Configuration Item: <literal>APT::Get::Diff-Only</literal> and 
+     <varlistentry><term><option>--diff-only</option></term><term><option>--dsc-only</option></term><term><option>--tar-only</option></term>
+     <listitem><para>Download only the diff, dsc, or tar file of a source archive. 
+     Configuration Item: <literal>APT::Get::Diff-Only</literal>, <literal>APT::Get::Dsc-Only</literal>, and 
      <literal>APT::Get::Tar-Only</literal>.</para></listitem>
      </varlistentry>
      
 
      <varlistentry><term><option>--allow-unauthenticated</option></term>
      <listitem><para>Ignore if packages can't be authenticated and don't prompt about it.
-     This is usefull for tools like pbuilder.
+     This is useful for tools like pbuilder.
      Configuration Item: <literal>APT::Get::AllowUnauthenticated</literal>.</para></listitem>
      </varlistentry>
      
      </varlistentry>
      
      <varlistentry><term><filename>/etc/apt/apt.conf.d/</filename></term>
-     <listitem><para>APT configuration file fragments
+     <listitem><para>APT configuration file fragments.
      Configuration Item: <literal>Dir::Etc::Parts</literal>.</para></listitem>
      </varlistentry>
      
  <refsect1><title>Diagnostics</title>
    <para><command>apt-get</command> returns zero on normal operation, decimal 100 on error.</para>
  </refsect1>
-
+ <refsect1>
+        <title>ORIGINAL AUTHORS</title>
+        <para>&apt-author.jgunthorpe;</para>
+ </refsect1>
+ <refsect1>
+        <title>CURRENT AUTHORS</title>
+        <para>
+                &apt-author.team;
+                &apt-qapage;
+        </para>
+ </refsect1>
  &manbugs;
 </refentry>