* apt-pkg/aptconfiguration.cc:

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

diff --git a/doc/apt-get.8.xml b/doc/apt-get.8.xml
index 4f8c801696105743c113d0f440155e4f01892e72..15b9701e2a05258bf04c337ebf51f20eb507ab01 100644 (file)
--- a/doc/apt-get.8.xml
+++ b/doc/apt-get.8.xml
@@ -5,6 +5,9 @@
 <!ENTITY % aptent SYSTEM "apt.ent">
 %aptent;
 
 <!ENTITY % aptent SYSTEM "apt.ent">
 %aptent;
 

+<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
+%aptverbatiment;
+

 ]>
 
 <refentry>
 ]>
 
 <refentry>


@@ -30,103 +33,13 @@
     <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>
-                 <group choice='req'>
-                         <arg choice='plain'>
-                                 <replaceable>target_release_name</replaceable>
-                         </arg>
-                         <arg choice='plain'>
-                                 <replaceable>target_release_number_expression</replaceable>
-                         </arg>
-                         <arg choice='plain'>
-                                 <replaceable>target_release_codename</replaceable>
-                         </arg>
-                 </group>
-      </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_name</replaceable>
-                                               </arg>
-                                               <arg choice='plain'>
-                                                       /<replaceable>target_release_codename</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_name</replaceable>
-                                               </arg>
-                                               <arg choice='plain'>
-                                                       /<replaceable>target_release_codename</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
    library.  Several "front-end" interfaces exist, such as &dselect;,
  <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;,

-   &aptitude;, &synaptic;, &gnome-apt; and &wajig;.</para>
+   &aptitude;, &synaptic; 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>
 
    <para>Unless the <option>-h</option>, or <option>--help</option> option is given, one of the
    commands below must be present.</para>


@@ -251,7 +164,7 @@
      <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>


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


@@ -281,7 +196,9 @@
 
      <varlistentry><term>build-dep</term>
      <listitem><para><literal>build-dep</literal> causes apt-get to install/remove packages in an 
 
      <varlistentry><term>build-dep</term>
      <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><term>check</term>
      </varlistentry>
 
      <varlistentry><term>check</term>


@@ -289,6 +206,12 @@
      for broken dependencies.</para></listitem>
      </varlistentry>
 
      for broken dependencies.</para></listitem>
      </varlistentry>
 

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

      <varlistentry><term>clean</term>
      <listitem><para><literal>clean</literal> clears out the local repository of retrieved package 
      files. It removes everything but the lock file from 
      <varlistentry><term>clean</term>
      <listitem><para><literal>clean</literal> clears out the local repository of retrieved package 
      files. It removes everything but the lock file from 


@@ -311,8 +234,25 @@
 
      <varlistentry><term>autoremove</term>
      <listitem><para><literal>autoremove</literal> is used to remove packages that were automatically
 
      <varlistentry><term>autoremove</term>
      <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>
+       <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
+           Ubuntu).
+           By default it displays the changelog for the version that is
+           installed.  However, you can specify the same options as for
+           the <option>install</option> command.
+         </para>
+       </listitem>
+     </varlistentry>
+
+
+

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


@@ -325,6 +265,11 @@
      Configuration Item: <literal>APT::Install-Recommends</literal>.</para></listitem>
      </varlistentry>
 
      Configuration Item: <literal>APT::Install-Recommends</literal>.</para></listitem>
      </varlistentry>
 

+     <varlistentry><term><option>--install-suggests</option></term>
+     <listitem><para>Consider suggested packages as a dependency for installing.
+     Configuration Item: <literal>APT::Install-Suggests</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>
      <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>


@@ -405,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. 


@@ -416,20 +366,22 @@
      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.
      Configuration Item: <literal>APT::Get::Compile</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.
      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>--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 


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