X-Git-Url: https://git.saurik.com/apt.git/blobdiff_plain/33e46bc7032c2bcab654ab3f6a0a10ad82264ead..c086ac18511ce648a0ed88ab470965470bd422c5:/doc/apt.conf.5.xml
diff --git a/doc/apt.conf.5.xml b/doc/apt.conf.5.xml
index 477507598..ff9942e5f 100644
--- a/doc/apt.conf.5.xml
+++ b/doc/apt.conf.5.xml
@@ -50,7 +50,7 @@
the file specified by the APT_CONFIG
environment variable (if any)
all files in Dir::Etc::Parts in
- alphanumeric ascending order which have no or "conf"
+ alphanumeric ascending order which have either no or "conf"
as filename extension and which only contain alphanumeric,
hyphen (-), underscore (_) and period (.) characters.
Otherwise APT will print a notice that it has ignored a file if the file
@@ -127,14 +127,14 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
All of the APT tools take a -o option which allows an arbitrary configuration
directive to be specified on the command line. The syntax is a full option
name (APT::Get::Assume-Yes for instance) followed by an equals
- sign then the new value of the option. Lists can be appended too by adding
- a trailing :: to the list name. (As you might suspect: The scope syntax can't be used
- on the command line.)
+ sign then the new value of the option. To append a new element to a list, add a
+ trailing :: to the name of the list. (As you might suspect: The scope syntax can't
+ be used on the command line.)
Note that you can use :: only for appending one item per line to a list and
that you should not use it in combination with the scope syntax.
(The scope syntax implicit insert ::) Using both syntaxes together will trigger a bug
- which some users unfortunately relay on: An option with the unusual name "::"
+ which some users unfortunately depend on: An option with the unusual name "::"
which acts like every other option with a name. These introduces many problems
including that a user who writes multiple lines in this wrong syntax in
the hope to append to a list will gain the opposite as only the last assignment for this option
@@ -153,7 +153,17 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
parsing package lists. The internal default is the architecture apt was
compiled for.
-
+
+ Architectures
+ All Architectures the system supports. Processors implementing the
+ amd64 (also called x86-64) instruction set are
+ e.g. also able to execute binaries compiled for the i386
+ (x86) instruction set; This list is use when fetching files and
+ parsing package lists. The internal default is always the native architecture (APT::Architecture)
+ and all foreign architectures it can retrieve by calling dpkg --print-foreign-architectures.
+
+
+
Default-Release
Default release to install packages from if more than one
version available. Contains release name, codename or release version. Examples: 'stable', 'testing',
@@ -208,10 +218,10 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
APT uses since version 0.7.26 a resizable memory mapped cache file to store the 'available'
information. Cache-Start 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.
- Cache-Grow defines in byte with the default of 1048576 (~1 MB) how much
+ 20971520 bytes (~20 MB). Note that this amount of space needs to be available for APT
+ otherwise it will likely fail ungracefully, so for memory restricted devices this value should
+ be lowered while on systems with a lot of configured sources it should be increased.
+ Cache-Grow defines in bytes with the default of 1048576 (~1 MB) how much
the Cache size will be increased in the event the space defined by Cache-Start
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 Cache-Limit.
@@ -259,14 +269,23 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
Max-ValidTime
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 Valid-Until 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
- (Date 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 Date header).
+ If the Release file itself includes a Valid-Until header
+ the earlier date of the two is used as the expiration date.
+ The default value is 0 which stands for "for ever valid".
+ Archive specific settings can be made by appending the label of the archive
+ to the option name.
+
+
+
+ Min-ValidTime
+ Minimum of seconds the Release file should be considered
+ valid after it was created (indicated by the Date header).
+ Use this if you need to use a seldomly updated (local) mirror of a more
+ regular updated archive with a Valid-Until 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.
@@ -276,8 +295,8 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
by default.
Two sub-options to limit the use of PDiffs are also available:
With FileLimit can be specified how many PDiff files
- are downloaded at most to patch a file. SizeLimit
- on the other hand is the maximum precentage of the size of all patches
+ are downloaded at most to update a file. SizeLimit
+ 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.
@@ -323,13 +342,15 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
The option timeout sets the timeout timer used by the method,
this applies to all things including connection timeout and data timeout.
- One setting is provided to control the pipeline depth in cases where the
- remote server is not RFC conforming or buggy (such as Squid 2.0.2).
- Acquire::http::Pipeline-Depth can be a value from 0 to 5
- indicating how many outstanding requests APT should send. A value of
- zero MUST be specified if the remote host does not properly linger
- on TCP connections - otherwise data corruption will occur. Hosts which
- require this are in violation of RFC 2068.
+ The setting Acquire::http::Pipeline-Depth can be used to
+ enabled HTTP pipeling (RFC 2616 section 8.1.2.2) which can be beneficial e.g. on
+ high-latency connections. It specifies how many requests are send in a pipeline.
+ Previous APT versions had a default of 10 for this setting, but the default value
+ is now 0 (= disabled) to avoid problems with the ever-growing amount of webservers
+ and proxies which choose to not conform to the HTTP/1.1 specification.
+
+ Acquire::http::AllowRedirect controls if APT will follow
+ redirects, which is enabled by default.
The used bandwidth can be limited with Acquire::http::Dl-Limit
which accepts integer values in kilobyte. The default value is 0 which deactivates
@@ -441,13 +462,13 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
It is not needed to add bz2 explicit to the list as it will be added automatic.
Note that at run time the Dir::Bin::Methodname 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 Dir::Bin::bzip2 "/bin/bzip2";
+ the bzip2 method (the inbuilt) setting is: Dir::Bin::bzip2 "/bin/bzip2";
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 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.
The special type uncompressed can be used to give uncompressed files a
- preference, but note that most archives doesn't provide uncompressed files so this is mostly only
+ preference, but note that most archives don't provide uncompressed files so this is mostly only
useable for local mirrors.
@@ -477,7 +498,12 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
actually use them if the environment doesn't specify this languages. So the following example configuration will
result in the order "en, de" in an english and in "de, en" in a german localization. Note that "fr" is downloaded,
but not used if APT is not used in a french localization, in such an environment the order would be "fr, de, en".
- Acquire::Languages { "environment"; "de"; "en"; "none"; "fr"; };
+ Acquire::Languages { "environment"; "de"; "en"; "none"; "fr"; };
+ Note: To prevent problems resulting from APT being executed in different environments
+ (e.g. by different users or by other programs) all Translation files which are found in
+ /var/lib/apt/lists/ will be added to the end of the list
+ (after an implicit "none").
+
@@ -489,7 +515,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
The Dir::State section has directories that pertain to local
state information. lists is the directory to place downloaded
package lists in and status is the name of the dpkg status file.
- preferences is the name of the APT preferences file.
+ preferences is the name of the APT preferences file.
Dir::State contains the default directory to prefix on all sub
items if they do not start with / or ./.