merged r1970 lp:~vorlon/apt/lp.968828

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

diff --git a/doc/apt.conf.5.xml b/doc/apt.conf.5.xml
index e37456d73d9d37883ed66e83d60825be4b4122fa..c2220b1bf166ed30759c56c068e4d0e5717a55f4 100644 (file)
--- a/doc/apt.conf.5.xml
+++ b/doc/apt.conf.5.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>


@@ -47,10 +50,12 @@
       <listitem><para>the file specified by the <envar>APT_CONFIG</envar>
         environment variable (if any)</para></listitem>
       <listitem><para>all files in <literal>Dir::Etc::Parts</literal> in
       <listitem><para>the file specified by the <envar>APT_CONFIG</envar>
         environment variable (if any)</para></listitem>
       <listitem><para>all files in <literal>Dir::Etc::Parts</literal> in

-        alphanumeric ascending order which have no or "<literal>conf</literal>"
+        alphanumeric ascending order which have either no or "<literal>conf</literal>"

         as filename extension and which only contain alphanumeric,
         as filename extension and which only contain alphanumeric,

-        hyphen (-), underscore (_) and period (.) characters -
-        otherwise they will be silently ignored.</para></listitem>
+        hyphen (-), underscore (_) and period (.) characters.
+        Otherwise APT will print a notice that it has ignored a file if the file
+        doesn't match a pattern in the <literal>Dir::Ignore-Files-Silently</literal>
+        configuration list - in this case it will be silently ignored.</para></listitem>

       <listitem><para>the main configuration file specified by
         <literal>Dir::Etc::main</literal></para></listitem>
       <listitem><para>the command line options are applied to override the
       <listitem><para>the main configuration file specified by
         <literal>Dir::Etc::main</literal></para></listitem>
       <listitem><para>the command line options are applied to override the


@@ -148,7 +153,15 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
      parsing package lists. The internal default is the architecture apt was 
      compiled for.</para></listitem>
      </varlistentry>
      parsing package lists. The internal default is the architecture apt was 
      compiled for.</para></listitem>
      </varlistentry>

-     
+
+     <varlistentry><term>Architectures</term>
+     <listitem><para>All Architectures the system supports. Processors implementing the <literal>amd64</literal>
+     are e.g. also able to execute binaries compiled for <literal>i386</literal>; This list is use when fetching files and
+     parsing package lists. The internal default is always the native architecture (<literal>APT::Architecture</literal>)
+     and all foreign architectures it can retrieve by calling <command>dpkg --print-foreign-architectures</command>.
+     </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, codename or release version. Examples: 'stable', 'testing',
      <varlistentry><term>Default-Release</term>
      <listitem><para>Default release to install packages from if more than one
      version available. Contains release name, codename or release version. Examples: 'stable', 'testing',


@@ -254,14 +267,23 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
 
      <varlistentry><term>Max-ValidTime</term>
         <listitem><para>Seconds the Release file should be considered valid after
 
      <varlistentry><term>Max-ValidTime</term>
         <listitem><para>Seconds the Release file should be considered valid after

-        it was created. The default is "for ever" (0) if the Release file of the
-        archive doesn't include a <literal>Valid-Until</literal> header.
-        If it does then this date is the default. The date from the Release file or
-        the date specified by the creation time of the Release file
-        (<literal>Date</literal> header) plus the seconds specified with this
-        options are used to check if the validation of a file has expired by using
-        the earlier date of the two. Archive specific settings can be made by
-        appending the label of the archive to the option name.
+        it was created (indicated by the <literal>Date</literal> header).
+        If the Release file itself includes a <literal>Valid-Until</literal> header
+        the earlier date of the two is used as the expiration date.
+        The default value is <literal>0</literal> which stands for "for ever".
+        Archive specific settings can be made by appending the label of the archive
+        to the option name.
+        </para></listitem>
+     </varlistentry>
+
+     <varlistentry><term>Min-ValidTime</term>
+        <listitem><para>Minimum of seconds the Release file should be considered
+        valid after it was created (indicated by the <literal>Date</literal> header).
+        Use this if you need to use a seldomly updated (local) mirror of a more
+        regular updated archive with a <literal>Valid-Until</literal> header
+        instead of completely disabling the expiration date checking.
+        Archive specific settings can and should be used by appending the label of
+        the archive to the option name.

         </para></listitem>
      </varlistentry>
 
         </para></listitem>
      </varlistentry>
 


@@ -272,7 +294,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
         <para>Two sub-options to limit the use of PDiffs are also available:
         With <literal>FileLimit</literal> can be specified how many PDiff files
         are downloaded at most to patch a file. <literal>SizeLimit</literal>
         <para>Two sub-options to limit the use of PDiffs are also available:
         With <literal>FileLimit</literal> can be specified how many PDiff files
         are downloaded at most to patch a file. <literal>SizeLimit</literal>

-        on the other hand is the maximum precentage of the size of all patches
+        on the other hand is the maximum percentage of the size of all patches

         compared to the size of the targeted file. If one of these limits is
         exceeded the complete file is downloaded instead of the patches.
         </para></listitem>
         compared to the size of the targeted file. If one of these limits is
         exceeded the complete file is downloaded instead of the patches.
         </para></listitem>


@@ -436,15 +458,14 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
      It is not needed to add <literal>bz2</literal> explicit to the list as it will be added automatic.</para>
      <para>Note that at run time the <literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will
      be checked: If this setting exists the method will only be used if this file exists, e.g. for
      It is not needed to add <literal>bz2</literal> explicit to the list as it will be added automatic.</para>
      <para>Note that at run time the <literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will
      be checked: If this setting exists the method will only be used if this file exists, e.g. for

-     the bzip2 method (the inbuilt) setting is <literallayout>Dir::Bin::bzip2 "/bin/bzip2";</literallayout>
+     the bzip2 method (the inbuilt) setting is: <literallayout>Dir::Bin::bzip2 "/bin/bzip2";</literallayout>

      Note also that list entries specified on the command line will be added at the end of the list
      specified in the configuration files, but before the default entries. To prefer a type in this case
      Note also that list entries specified on the command line will be added at the end of the list
      specified in the configuration files, but before the default entries. To prefer a type in this case

-     over the ones specified in in the configuration files you can set the option direct - not in list style.
+     over the ones specified in the configuration files you can set the option direct - not in list style.

      This will not override the defined list, it will only prefix the list with this type.</para>
      This will not override the defined list, it will only prefix the list with this type.</para>

-     <para>While it is possible to add an empty compression type to the order list, but APT in its current
-     version doesn't understand it correctly and will display many warnings about not downloaded files -
-     these warnings are most of the time false negatives. Future versions will maybe include a way to
-     really prefer uncompressed files to support the usage of local mirrors.</para></listitem>
+     <para>The special type <literal>uncompressed</literal> can be used to give uncompressed files a
+     preference, but note that most archives don't provide uncompressed files so this is mostly only
+     useable for local mirrors.</para></listitem>

      </varlistentry>
 
      <varlistentry><term>GzipIndexes</term>
      </varlistentry>
 
      <varlistentry><term>GzipIndexes</term>


@@ -615,7 +636,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
 
    <refsect2><title>dpkg trigger usage (and related options)</title>
      <para>APT can call dpkg in a way so it can make aggressive use of triggers over
 
    <refsect2><title>dpkg trigger usage (and related options)</title>
      <para>APT can call dpkg in a way so it can make aggressive use of triggers over

-     multiply calls of dpkg. Without further options dpkg will use triggers only in between his
+     multiple calls of dpkg. Without further options dpkg will use triggers only in between his

      own run. Activating these options can therefore decrease the time needed to perform the
      install / upgrade. Note that it is intended to activate these options per default in the
      future, but as it changes the way APT calling dpkg drastically it needs a lot more testing.
      own run. Activating these options can therefore decrease the time needed to perform the
      install / upgrade. Note that it is intended to activate these options per default in the
      future, but as it changes the way APT calling dpkg drastically it needs a lot more testing.