* debian/control:

[apt.git] / doc / apt.conf.5.xml

diff --git a/doc/apt.conf.5.xml b/doc/apt.conf.5.xml
index 69e212243d7bf1b6aa75ba021710221d9a2b3b9e..5b71384a7a717158eb8f7ea8475cb5dcbc241138 100644 (file)
--- a/doc/apt.conf.5.xml
+++ b/doc/apt.conf.5.xml
@@ -46,7 +46,7 @@
    the APT tool group, for the Get tool. options do not inherit from their 
    parent groups.</para> 
 
-   <para>Syntacticly the configuration language is modeled after what the ISC tools
+   <para>Syntactically the configuration language is modeled after what the ISC tools
    such as bind and dhcp use.  Lines starting with
    <literal>//</literal> are treated as comments (ignored).
    Each line is of the form
@@ -98,6 +98,11 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
      compiled for.</para></listitem>
      </varlistentry>
      
+     <varlistentry><term>Default-Release</term>
+        <listitem><para>Default release to install packages from if more than one
+        version available. Contains release name or release version. Examples: 'stable', 'testing', 'unstable', '4.0', '5.0*'. Release codenames ('etch', 'lenny' etc.) are not allowed now. See also &apt-preferences;.</para></listitem>
+     </varlistentry>
+     
      <varlistentry><term>Ignore-Hold</term>
      <listitem><para>Ignore Held packages; This global option causes the problem resolver to
      ignore held packages in its decision making.</para></listitem>
@@ -158,6 +163,12 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
    and the URI handlers. 
 
    <variablelist>
+     <varlistentry><term>PDiffs</term>
+        <listitem><para>Try do download deltas called <literal>PDiffs</literal> for
+        Packages or Sources files instead of downloading whole ones. True
+        by default.</para></listitem>
+     </varlistentry>
+
      <varlistentry><term>Queue-Mode</term>
      <listitem><para>Queuing mode; <literal>Queue-Mode</literal> can be one of <literal>host</literal> or 
      <literal>access</literal> which determines how  APT parallelizes outgoing 
@@ -214,7 +225,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
      configuration file. This entry specifies the commands to send to tell 
      the proxy server what to connect to. Please see 
      &configureindex; for an example of 
-     how to do this. The subsitution variables available are 
+     how to do this. The substitution variables available are 
      <literal>$(PROXY_USER)</literal> <literal>$(PROXY_PASS)</literal> <literal>$(SITE_USER)</literal>
      <literal>$(SITE_PASS)</literal> <literal>$(SITE)</literal> and <literal>$(SITE_PORT)</literal>
      Each is taken from it's respective URI component.</para>
@@ -235,7 +246,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
      not recommended to use FTP over HTTP due to its low efficiency.</para>
 
      <para>The setting <literal>ForceExtended</literal> controls the use of RFC2428 
-     <literal>EPSV</literal> and <literal>EPRT</literal> commands. The defaut is false, which means
+     <literal>EPSV</literal> and <literal>EPRT</literal> commands. The default is false, which means
      these commands are only used if the control connection is IPv6. Setting this
      to true forces their use even on IPv4 connections. Note that most FTP servers
      do not support RFC2428.</para></listitem>
@@ -276,7 +287,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
    <literal>pkgcache</literal> as well as the location to place downloaded archives, 
    <literal>Dir::Cache::archives</literal>. Generation of caches can be turned off
    by setting their names to be blank. This will slow down startup but
-   save disk space. It is probably prefered to turn off the pkgcache rather
+   save disk space. It is probably preferred to turn off the pkgcache rather
    than the srcpkgcache. Like <literal>Dir::State</literal> the default
    directory is contained in <literal>Dir::Cache</literal></para>
 
@@ -284,7 +295,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
    <literal>sourcelist</literal> gives the location of the sourcelist and 
    <literal>main</literal> is the default configuration file (setting has no effect,
    unless it is done from the config file specified by 
-   <envar>APT_CONFIG</envar>.</para>
+   <envar>APT_CONFIG</envar>).</para>
 
    <para>The <literal>Dir::Parts</literal> setting reads in all the config fragments in 
    lexical order from the directory specified. After this is done then the
@@ -295,6 +306,19 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
    <literal>dpkg</literal>, <literal>apt-get</literal> <literal>dpkg-source</literal> 
    <literal>dpkg-buildpackage</literal> and <literal>apt-cache</literal> specify the location
    of the respective programs.</para>
+
+   <para>
+     The configuration item <literal>RootDir</literal> has a special
+     meaning.  If set, all paths in <literal>Dir::</literal> will be
+     relative to <literal>RootDir</literal>, <emphasis>even paths that
+     are specified absolutely</emphasis>.  So, for instance, if
+     <literal>RootDir</literal> is set to
+     <filename>/tmp/staging</filename> and
+     <literal>Dir::State::status</literal> is set to
+     <filename>/var/lib/dpkg/status</filename>, then the status file
+     will be looked up in
+     <filename>/tmp/staging/var/lib/dpkg/status</filename>.
+   </para>
  </refsect1>
  
  <refsect1><title>APT in DSelect</title>