* debian/apt-utils.links:

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

diff --git a/doc/apt-get.8.xml b/doc/apt-get.8.xml
index 11b53e5e78ca2da47db546cc5abc5070f648e8f0..620d22106feab66551be265412a84e8662690ba4 100644 (file)
--- a/doc/apt-get.8.xml
+++ b/doc/apt-get.8.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8" standalone="no"?>
 <?xml version="1.0" encoding="utf-8" standalone="no"?>

-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
-  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

 
 <!ENTITY % aptent SYSTEM "apt.ent">
 %aptent;
 
 <!ENTITY % aptent SYSTEM "apt.ent">
 %aptent;


@@ -18,7 +18,7 @@
    &apt-email;
    &apt-product;
    <!-- The last update date -->
    &apt-email;
    &apt-product;
    <!-- The last update date -->

-   <date>08 November 2008</date>
+   <date>2012-05-21T00:00:00Z</date>

  </refentryinfo>
  
  <refmeta>
  </refentryinfo>
  
  <refmeta>


@@ -33,84 +33,8 @@
     <refpurpose>APT package handling utility -- command-line interface</refpurpose>
  </refnamediv>
 
     <refpurpose>APT package handling utility -- command-line interface</refpurpose>
  </refnamediv>
 

- <!-- Arguments -->
- <refsynopsisdiv>
-   <cmdsynopsis>
-      <command>apt-get</command>
-      <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>
-               <arg choice='plain'>
-                       <replaceable>target_release</replaceable>
-               </arg>
-      </arg>
-
-      <group choice="req">
-         <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</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>
-                                       <group choice='req'>
-                                               <arg choice='plain'>
-                                                       =<replaceable>pkg_version_number</replaceable>
-                                               </arg>
-                                               <arg choice='plain'>
-                                                       /<replaceable>target_release</replaceable>
-                                               </arg>
-                                       </group>
-                               </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>
- 
+ &synopsis-command-apt-get;
+

  <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
  <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


@@ -121,7 +45,7 @@
    commands below must be present.</para>
    
    <variablelist>
    commands below must be present.</para>
    
    <variablelist>

-     <varlistentry><term>update</term>
+     <varlistentry><term><option>update</option></term>

      <listitem><para><literal>update</literal> is used to resynchronize the package index files from
      their sources. The indexes of available packages are fetched from the
      location(s) specified in <filename>/etc/apt/sources.list</filename>.
      <listitem><para><literal>update</literal> is used to resynchronize the package index files from
      their sources. The indexes of available packages are fetched from the
      location(s) specified in <filename>/etc/apt/sources.list</filename>.


@@ -133,7 +57,7 @@
      of the package files cannot be known in advance.</para></listitem>
      </varlistentry>
      
      of the package files cannot be known in advance.</para></listitem>
      </varlistentry>
      

-     <varlistentry><term>upgrade</term>
+     <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>. Packages currently installed with 
      <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>. Packages currently installed with 


@@ -146,7 +70,7 @@
      available.</para></listitem>
      </varlistentry>
 
      available.</para></listitem>
      </varlistentry>
 

-     <varlistentry><term>dselect-upgrade</term>
+     <varlistentry><term><option>dselect-upgrade</option></term>

      <listitem><para><literal>dselect-upgrade</literal>
      is used in conjunction with the traditional Debian packaging
      front-end, &dselect;. <literal>dselect-upgrade</literal>
      <listitem><para><literal>dselect-upgrade</literal>
      is used in conjunction with the traditional Debian packaging
      front-end, &dselect;. <literal>dselect-upgrade</literal>


@@ -156,7 +80,7 @@
      packages).</para></listitem>
      </varlistentry>
 
      packages).</para></listitem>
      </varlistentry>
 

-     <varlistentry><term>dist-upgrade</term>
+     <varlistentry><term><option>dist-upgrade</option></term>

      <listitem><para><literal>dist-upgrade</literal> in addition to performing the function of 
      <literal>upgrade</literal>, also intelligently handles changing dependencies 
      with new versions of packages; <command>apt-get</command> has a "smart" conflict 
      <listitem><para><literal>dist-upgrade</literal> in addition to performing the function of 
      <literal>upgrade</literal>, also intelligently handles changing dependencies 
      with new versions of packages; <command>apt-get</command> has a "smart" conflict 


@@ -169,12 +93,12 @@
      overriding the general settings for individual packages.</para></listitem>
      </varlistentry>
 
      overriding the general settings for individual packages.</para></listitem>
      </varlistentry>
 

-     <varlistentry><term>install</term>
+     <varlistentry><term><option>install</option></term>

      <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 
      <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, 
+        filename (for instance, in a Debian 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 
         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 


@@ -223,7 +147,7 @@
      with a '^' or '$' character, or create a more specific regular expression.</para></listitem>
      </varlistentry>
 
      with a '^' or '$' character, or create a more specific regular expression.</para></listitem>
      </varlistentry>
 

-     <varlistentry><term>remove</term>
+     <varlistentry><term><option>remove</option></term>

      <listitem><para><literal>remove</literal> is identical to <literal>install</literal> except that packages are 
         removed instead of installed. Note the removing a package leaves its
         configuration files in system. If a plus sign is appended to the package 
      <listitem><para><literal>remove</literal> is identical to <literal>install</literal> except that packages are 
         removed instead of installed. Note the removing a package leaves its
         configuration files in system. If a plus sign is appended to the package 


@@ -231,16 +155,16 @@
      installed instead of removed.</para></listitem>
      </varlistentry>
 
      installed instead of removed.</para></listitem>
      </varlistentry>
 

-     <varlistentry><term>purge</term>
+     <varlistentry><term><option>purge</option></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>
 
      <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>
+     <varlistentry><term><option>source</option></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 
      fetch. It will then find and download into the current directory the 
      <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 
      fetch. It will then find and download into the current directory the 

-     newest available version of that source package while respect the
+     newest available version of that source package while respecting the

      default release, set with the option <literal>APT::Default-Release</literal>,
      the <option>-t</option> option or per package with the
      <literal>pkg/release</literal> syntax, if possible.</para>
      default release, set with the option <literal>APT::Default-Release</literal>,
      the <option>-t</option> option or per package with the
      <literal>pkg/release</literal> syntax, if possible.</para>


@@ -254,8 +178,10 @@
 
      <para>If the <option>--compile</option> option is specified
      then the package will be compiled to a binary .deb using
 
      <para>If the <option>--compile</option> option is specified
      then the package will be compiled to a binary .deb using

-     <command>dpkg-buildpackage</command>, if <option>--download-only</option>
-     is specified then the source package will not be unpacked.</para>
+     <command>dpkg-buildpackage</command> for the architecture as
+     defined by the <command>--host-architecture</command> option.
+     If <option>--download-only</option> is specified then the source package
+     will not be unpacked.</para>

 
      <para>A specific source version can be retrieved by postfixing the source name
      with an equals and then the version to fetch, similar to the mechanism
 
      <para>A specific source version can be retrieved by postfixing the source name
      with an equals and then the version to fetch, similar to the mechanism


@@ -268,23 +194,25 @@
      tar balls.</para></listitem>
      </varlistentry>
 
      tar balls.</para></listitem>
      </varlistentry>
 

-     <varlistentry><term>build-dep</term>
+     <varlistentry><term><option>build-dep</option></term>

      <listitem><para><literal>build-dep</literal> causes apt-get to install/remove packages in an 
      <listitem><para><literal>build-dep</literal> causes apt-get to install/remove packages in an 

-     attempt to satisfy the build dependencies for a source package.</para></listitem>
+     attempt to satisfy the build dependencies for a source package. By default the dependencies are
+     satisfied to build the package natively. If desired a host-architecture can be specified
+     with the <option>--host-architecture</option> option instead.</para></listitem>

      </varlistentry>
 
      </varlistentry>
 

-     <varlistentry><term>check</term>
+     <varlistentry><term><option>check</option></term>

      <listitem><para><literal>check</literal> is a diagnostic tool; it updates the package cache and checks 
      for broken dependencies.</para></listitem>
      </varlistentry>
 
      <listitem><para><literal>check</literal> is a diagnostic tool; it updates the package cache and checks 
      for broken dependencies.</para></listitem>
      </varlistentry>
 

-     <varlistentry><term>download</term>
+     <varlistentry><term><option>download</option></term>

        <listitem><para><literal>download</literal> will download the given
            binary package into the current directory.
        </para></listitem>
      </varlistentry>
 
        <listitem><para><literal>download</literal> will download the given
            binary package into the current directory.
        </para></listitem>
      </varlistentry>
 

-     <varlistentry><term>clean</term>
+     <varlistentry><term><option>clean</option></term>

      <listitem><para><literal>clean</literal> clears out the local repository of retrieved package 
      files. It removes everything but the lock file from 
      <filename>&cachedir;/archives/</filename> and 
      <listitem><para><literal>clean</literal> clears out the local repository of retrieved package 
      files. It removes everything but the lock file from 
      <filename>&cachedir;/archives/</filename> and 


@@ -294,7 +222,7 @@
      from time to time to free up disk space.</para></listitem>
      </varlistentry>
 
      from time to time to free up disk space.</para></listitem>
      </varlistentry>
 

-     <varlistentry><term>autoclean</term>
+     <varlistentry><term><option>autoclean</option></term>

      <listitem><para>Like <literal>clean</literal>, <literal>autoclean</literal> clears out the local 
      repository of retrieved package files. The difference is that it only 
      removes package files that can no longer be downloaded, and are largely 
      <listitem><para>Like <literal>clean</literal>, <literal>autoclean</literal> clears out the local 
      repository of retrieved package files. The difference is that it only 
      removes package files that can no longer be downloaded, and are largely 


@@ -304,17 +232,17 @@
      erased if it is set to off.</para></listitem>
      </varlistentry>
 
      erased if it is set to off.</para></listitem>
      </varlistentry>
 

-     <varlistentry><term>autoremove</term>
+     <varlistentry><term><option>autoremove</option></term>

      <listitem><para><literal>autoremove</literal> is used to remove packages that were automatically
      <listitem><para><literal>autoremove</literal> is used to remove packages that were automatically

-     installed to satisfy dependencies for some package and that are no more needed.</para></listitem>
+     installed to satisfy dependencies for other packages and are now no longer needed.</para></listitem>

      </varlistentry>
 
      </varlistentry>
 

-     <varlistentry><term>changelog</term>
+     <varlistentry><term><option>changelog</option></term>

        <listitem><para><literal>changelog</literal> downloads a package changelog and displays
            it through <command>sensible-pager</command>. The server name and base
            directory is defined in the <literal>APT::Changelogs::Server</literal>
        <listitem><para><literal>changelog</literal> downloads a package changelog and displays
            it through <command>sensible-pager</command>. The server name and base
            directory is defined in the <literal>APT::Changelogs::Server</literal>

-           variable (e. g. <ulink>http://packages.debian.org/changelogs</ulink> for
-           Debian or <ulink>http://changelogs.ubuntu.com/changelogs</ulink> for
+          variable (e. g. <ulink url="http://packages.debian.org/changelogs">packages.debian.org/changelogs</ulink> for
+          Debian or <ulink url="http://changelogs.ubuntu.com/changelogs">changelogs.ubuntu.com/changelogs</ulink> for

            Ubuntu).
            By default it displays the changelog for the version that is
            installed.  However, you can specify the same options as for
            Ubuntu).
            By default it displays the changelog for the version that is
            installed.  However, you can specify the same options as for


@@ -422,6 +350,11 @@
      Configuration Item: <literal>APT::Get::Assume-Yes</literal>.</para></listitem>
      </varlistentry>
 
      Configuration Item: <literal>APT::Get::Assume-Yes</literal>.</para></listitem>
      </varlistentry>
 

+     <varlistentry><term><option>--assume-no</option></term>
+     <listitem><para>Automatic "no" to all prompts.
+     Configuration Item: <literal>APT::Get::Assume-No</literal>.</para></listitem>
+     </varlistentry>
+

      <varlistentry><term><option>-u</option></term><term><option>--show-upgraded</option></term>
      <listitem><para>Show upgraded packages; Print out a list of all packages that are to be
      upgraded. 
      <varlistentry><term><option>-u</option></term><term><option>--show-upgraded</option></term>
      <listitem><para>Show upgraded packages; Print out a list of all packages that are to be
      upgraded. 


@@ -433,6 +366,16 @@
      Configuration Item: <literal>APT::Get::Show-Versions</literal>.</para></listitem>
      </varlistentry>
 
      Configuration Item: <literal>APT::Get::Show-Versions</literal>.</para></listitem>
      </varlistentry>
 

+     <varlistentry><term><option>-a</option></term>
+                   <term><option>--host-architecture</option></term>
+     <listitem><para>This option controls the architecture packages are built for
+     by <command>apt-get source --compile</command> and how cross-builddependencies
+     are satisfied. By default is it not set which means that the host architecture
+     is the same as the build architecture (which is defined by <literal>APT::Architecture</literal>).
+     Configuration Item: <literal>APT::Get::Host-Architecture</literal>
+     </para></listitem>
+     </varlistentry>
+

      <varlistentry><term><option>-b</option></term><term><option>--compile</option></term>
                    <term><option>--build</option></term>
      <listitem><para>Compile source packages after downloading them.
      <varlistentry><term><option>-b</option></term><term><option>--compile</option></term>
                    <term><option>--build</option></term>
      <listitem><para>Compile source packages after downloading them.


@@ -454,9 +397,10 @@
      </varlistentry>
 
      <varlistentry><term><option>--only-upgrade</option></term>
      </varlistentry>
 
      <varlistentry><term><option>--only-upgrade</option></term>

-     <listitem><para>Do not install new packages; When used in conjunction with <literal>install</literal>,
-     <literal>only-upgrade</literal> will prevent packages on the command line
-     from being upgraded if they are not already installed.
+     <listitem><para>Do not install new packages; When used in conjunction
+     with <literal>install</literal>, <literal>only-upgrade</literal> will
+     install upgrades for already installed packages only and ignore requests
+     to install new packages.

      Configuration Item: <literal>APT::Get::Only-Upgrade</literal>.</para></listitem>
      </varlistentry>
 
      Configuration Item: <literal>APT::Get::Only-Upgrade</literal>.</para></listitem>
      </varlistentry>
 


@@ -591,16 +535,5 @@
  <refsect1><title>Diagnostics</title>
    <para><command>apt-get</command> returns zero on normal operation, decimal 100 on error.</para>
  </refsect1>
  <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;
-        </para>
-                &apt-qapage;
- </refsect1>

  &manbugs;
 </refentry>
  &manbugs;
 </refentry>