Fix typo

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

diff --git a/doc/apt-get.8.xml b/doc/apt-get.8.xml
index c63011b2a611d8255ef1fbf6d41350139c682414..ec773edeb9a94972f9852f8a8036c86fc78b8676 100644 (file)
--- a/doc/apt-get.8.xml
+++ b/doc/apt-get.8.xml
@@ -15,12 +15,13 @@
    &apt-email;
    &apt-product;
    <!-- The last update date -->
    &apt-email;
    &apt-product;
    <!-- The last update date -->

-   <date>30 October 2008</date>
+   <date>08 November 2008</date>

  </refentryinfo>
  
  <refmeta>
    <refentrytitle>apt-get</refentrytitle>
    <manvolnum>8</manvolnum>
  </refentryinfo>
  
  <refmeta>
    <refentrytitle>apt-get</refentrytitle>
    <manvolnum>8</manvolnum>

+   <refmiscinfo class="manual">APT</refmiscinfo>

  </refmeta>
  
  <!-- Man page title -->
  </refmeta>
  
  <!-- Man page title -->


@@ -33,7 +34,7 @@
  <refsynopsisdiv>
    <cmdsynopsis>
       <command>apt-get</command>
  <refsynopsisdiv>
    <cmdsynopsis>
       <command>apt-get</command>

-      <arg><option>-vsqdyfmubV</option></arg>
+      <arg><option>-sqdyfmubV</option></arg>

       <arg>
              <option>-o=
                          <replaceable>config_string</replaceable>
       <arg>
              <option>-o=
                          <replaceable>config_string</replaceable>


@@ -53,6 +54,9 @@
                          <arg choice='plain'>
                                  <replaceable>target_release_number_expression</replaceable>
                          </arg>
                          <arg choice='plain'>
                                  <replaceable>target_release_number_expression</replaceable>
                          </arg>

+                         <arg choice='plain'>
+                                 <replaceable>target_release_codename</replaceable>
+                         </arg>

                  </group>
       </arg>
 
                  </group>
       </arg>
 


@@ -60,6 +64,7 @@
          <arg choice='plain'>update</arg>
          <arg choice='plain'>upgrade</arg>
          <arg choice='plain'>dselect-upgrade</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>
          <arg choice='plain'>install 
                         <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable>
                                <arg>


@@ -70,6 +75,9 @@
                                                <arg choice='plain'>
                                                        /<replaceable>target_release_name</replaceable>
                                                </arg>
                                                <arg choice='plain'>
                                                        /<replaceable>target_release_name</replaceable>
                                                </arg>

+                                               <arg choice='plain'>
+                                                       /<replaceable>target_release_codename</replaceable>
+                                               </arg>

                                        </group>
                                </arg>
                         </arg>
                                        </group>
                                </arg>
                         </arg>


@@ -78,9 +86,19 @@
          <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 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>
+                                       <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>
             </arg>
          <arg choice='plain'>build-dep <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>


@@ -88,6 +106,12 @@
          <arg choice='plain'>clean</arg>
          <arg choice='plain'>autoclean</arg>
          <arg choice='plain'>autoremove</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'>
                         <group choice='req'>
                                <arg choice='plain'>-h</arg>


@@ -101,8 +125,8 @@
  <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

-   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>
 
    <para>Unless the <option>-h</option>, or <option>--help</option> option is given, one of the
    commands below must be present.</para>


@@ -149,6 +173,7 @@
      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. 
      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
      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


@@ -157,24 +182,23 @@
 
      <varlistentry><term>install</term>
      <listitem>
 
      <varlistentry><term>install</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 
-                    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><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>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 


@@ -212,27 +236,37 @@
 
      <varlistentry><term>remove</term>
      <listitem><para><literal>remove</literal> is identical to <literal>install</literal> except that packages are 
 
      <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 
      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.</para></listitem>
+     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 
      fetch. It will then find and download into the current directory the 
      </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 
      fetch. It will then find and download into the current directory the 

-     newest available version of that source package. Source packages are 
-     tracked separately from binary packages via <literal>deb-src</literal> type lines 
-     in the &sources-list; file. This probably will mean that you will not 
-     get the same source as the package you have installed or as you could 
-     install. If the --compile options is specified then the package will be 
-     compiled to a binary .deb using dpkg-buildpackage, if --download-only is 
-     specified then the source package will not be unpacked.</para>
+     newest available version of that source package while respect the
+     default release, set with the option <literal>APT::Default-Release</literal>,
+     the <option>-t</option> option or per package with with the
+     <literal>pkg/release</literal> syntax, if possible.</para>
+
+     <para>Source packages are tracked separately
+     from binary packages via <literal>deb-src</literal> type lines 
+     in the &sources-list; file. This means that you will need to add such a line
+     for each repository you want to get sources from. If you don't do this
+     you will properly get another (newer, older or none) source version than
+     the one you have installed or could install.</para>
+
+     <para>If the <option>--compile</option> options 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>

 
      <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


@@ -349,6 +383,12 @@
      actually change the system. 
      Configuration Item: <literal>APT::Get::Simulate</literal>.</para>
 
      actually change the system. 
      Configuration Item: <literal>APT::Get::Simulate</literal>.</para>
 

+     <para>Simulation run as user will deactivate locking (<literal>Debug::NoLocking</literal>)
+     automatic. Also a notice will be displayed indicating that this is only a simulation,
+     if the option <literal>APT::Get::Show-User-Simulation-Note</literal> is set (Default: true).
+     Neither NoLocking nor the notice will be triggered if run as root (root should know what
+     he is doing without further warnings by <literal>apt-get</literal>).</para>
+

      <para>Simulate prints out
      a series of lines each one representing a dpkg operation, Configure (Conf),
      Remove (Remv), Unpack (Inst). Square brackets indicate broken packages with
      <para>Simulate prints out
      a series of lines each one representing a dpkg operation, Configure (Conf),
      Remove (Remv), Unpack (Inst). Square brackets indicate broken packages with


@@ -382,6 +422,14 @@
      Configuration Item: <literal>APT::Get::Compile</literal>.</para></listitem>
      </varlistentry>
 
      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 


@@ -418,7 +466,8 @@
      <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
      <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>
 
      Configuration Item: <literal>APT::Get::Purge</literal>.</para></listitem>
      </varlistentry>
 


@@ -446,7 +495,8 @@
      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 
      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>.
+     <option>-t '2.1*'</option>, <option>-t unstable</option>
+     or <option>-t sid</option>.

      Configuration Item: <literal>APT::Default-Release</literal>;
      see also the &apt-preferences; manual page.</para></listitem>
      </varlistentry>
      Configuration Item: <literal>APT::Default-Release</literal>;
      see also the &apt-preferences; manual page.</para></listitem>
      </varlistentry>


@@ -508,50 +558,11 @@
 
  <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>/etc/apt/apt.conf</filename></term>
-     <listitem><para>APT configuration file.
-     Configuration Item: <literal>Dir::Etc::Main</literal>.</para></listitem>
-     </varlistentry>
-     
-     <varlistentry><term><filename>/etc/apt/apt.conf.d/</filename></term>
-     <listitem><para>APT configuration file fragments.
-     Configuration Item: <literal>Dir::Etc::Parts</literal>.</para></listitem>
-     </varlistentry>
-     
-     <varlistentry><term><filename>/etc/apt/preferences</filename></term>
-     <listitem><para>Version preferences file.
-     This is where you would specify "pinning",
-     i.e. a preference to get certain packages
-     from a separate source
-     or from a different version of a distribution.
-     Configuration Item: <literal>Dir::Etc::Preferences</literal>.</para></listitem>
-     </varlistentry>
-     
-     <varlistentry><term><filename>&cachedir;/archives/</filename></term>
-     <listitem><para>Storage area for retrieved package files.
-     Configuration Item: <literal>Dir::Cache::Archives</literal>.</para></listitem>
-     </varlistentry>
-     
-     <varlistentry><term><filename>&cachedir;/archives/partial/</filename></term>
-     <listitem><para>Storage area for package files in transit.
-     Configuration Item: <literal>Dir::Cache::Archives</literal> (implicit partial). </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-aptconf;
+     &file-preferences;
+     &file-cachearchives;
+     &file-statelists;

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


@@ -572,8 +583,8 @@
         <title>CURRENT AUTHORS</title>
         <para>
                 &apt-author.team;
         <title>CURRENT AUTHORS</title>
         <para>
                 &apt-author.team;

-                &apt-qapage;

         </para>
         </para>

+                &apt-qapage;

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