* cmdline/apt-get.cc:

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

diff --git a/doc/apt.conf.5.xml b/doc/apt.conf.5.xml
index fe005e0f174ffd5c9d7f55a1a70247b4dcd02379..f00baacea592b50cca5bc2e8edb8288cd38f401c 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 % aptverbatiment SYSTEM "apt-verbatim.ent">
+%aptverbatiment;
+
 ]>
 
 <refentry>
@@ -199,9 +202,20 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
      anything that those packages depend on.</para></listitem>
      </varlistentry>
 
-     <varlistentry><term>Cache-Limit</term>
-     <listitem><para>APT uses a fixed size memory mapped cache file to store the 'available'
-     information. This sets the size of that cache (in bytes).</para></listitem>
+     <varlistentry><term>Cache-Start, Cache-Grow and Cache-Limit</term>
+     <listitem><para>APT uses since version 0.7.26 a resizable memory mapped cache file to store the 'available'
+     information. <literal>Cache-Start</literal> acts as a hint to which size the Cache will grow
+     and is therefore the amount of memory APT will request at startup. The default value is
+     20971520 bytes (~20 MB). Note that these amount of space need to be available for APT
+     otherwise it will likely fail ungracefully, so for memory restricted devices these value should
+     be lowered while on systems with a lot of configured sources this might be increased.
+     <literal>Cache-Grow</literal> defines in byte with the default of 1048576 (~1 MB) how much
+     the Cache size will be increased in the event the space defined by <literal>Cache-Start</literal>
+     is not enough. These value will be applied again and again until either the cache is big
+     enough to store all information or the size of the cache reaches the <literal>Cache-Limit</literal>.
+     The default of <literal>Cache-Limit</literal> is 0 which stands for no limit.
+     If <literal>Cache-Grow</literal> is set to 0 the automatic grow of the cache is disabled.
+     </para></listitem>
      </varlistentry>
 
      <varlistentry><term>Build-Essential</term>
@@ -230,6 +244,30 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
    and the URI handlers. 
 
    <variablelist>
+     <varlistentry><term>Check-Valid-Until</term>
+        <listitem><para>Security related option defaulting to true as an
+        expiring validation for a Release file prevents longtime replay attacks
+        and can e.g. also help users to identify no longer updated mirrors -
+        but the feature depends on the correctness of the time on the user system.
+        Archive maintainers are encouraged to create Release files with the
+        <literal>Valid-Until</literal> header, but if they don't or a stricter value
+        is volitional the following <literal>Max-ValidTime</literal> option can be used.
+        </para></listitem>
+     </varlistentry>
+
+     <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.
+        </para></listitem>
+     </varlistentry>
+
      <varlistentry><term>PDiffs</term>
         <listitem><para>Try to download deltas called <literal>PDiffs</literal> for
         Packages or Sources files instead of downloading whole ones. True
@@ -412,6 +450,15 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
      really prefer uncompressed files to support the usage of local mirrors.</para></listitem>
      </varlistentry>
 
+     <varlistentry><term>GzipIndexes</term>
+        <listitem><para>
+        When downloading <literal>gzip</literal> compressed indexes (Packages, Sources, or
+        Translations), keep them gzip compressed locally instead of unpacking
+        them. This saves quite a lot of disk space at the expense of more CPU
+        requirements when building the local package caches. False by default.
+        </para></listitem>
+     </varlistentry>
+
      <varlistentry><term>Languages</term>
      <listitem><para>The Languages subsection controls which <filename>Translation</filename> files are downloaded
      and in which order APT tries to display the Description-Translations. APT will try to display the first
@@ -483,6 +530,15 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
      will be looked up in
      <filename>/tmp/staging/var/lib/dpkg/status</filename>.
    </para>
+
+   <para>
+      The <literal>Ignore-Files-Silently</literal> list can be used to specify
+      which files APT should silently ignore while parsing the files in the
+      fragment directories. Per default a file which end with <literal>.disabled</literal>,
+      <literal>~</literal>, <literal>.bak</literal> or <literal>.dpkg-[a-z]+</literal>
+      is silently ignored. As seen in the last default value these patterns can use regular
+      expression syntax.
+   </para>
  </refsect1>
  
  <refsect1><title>APT in DSelect</title>