X-Git-Url: https://git.saurik.com/apt.git/blobdiff_plain/7810fc042d4d3dda6b2c721d09d3eb7eadc12e2d..97c17a01c7722f08e0cebf938c12a010b96220b7:/doc/apt.conf.5.xml
diff --git a/doc/apt.conf.5.xml b/doc/apt.conf.5.xml
index 64724f211..c0c247ae9 100644
--- a/doc/apt.conf.5.xml
+++ b/doc/apt.conf.5.xml
@@ -12,10 +12,16 @@
&apt-author.jgunthorpe;
&apt-author.team;
+
+ Daniel
+ Burrows
+ Initial documentation of Debug::*.
+ dburrows@debian.org
+
&apt-email;
&apt-product;
- 29 February 2004
+ 10 December 2008
@@ -47,8 +53,9 @@
parent groups.
Syntactically the configuration language is modeled after what the ISC tools
- such as bind and dhcp use. Lines starting with
- // are treated as comments (ignored).
+ such as bind and dhcp use. Lines starting with
+ // are treated as comments (ignored), as well as all text
+ between /* and */, just like C/C++ comments.
Each line is of the form
APT::Get::Assume-Yes "true"; The trailing
semicolon is required and the quotes are optional. A new scope can be
@@ -64,7 +71,7 @@ APT {
with newlines placed to make it more readable. Lists can be created by
- opening a scope and including a single word enclosed in quotes followed by a
+ opening a scope and including a single string enclosed in quotes followed by a
semicolon. Multiple entries can be included, each separated by a semicolon.
@@ -75,10 +82,14 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
&docdir;examples/apt.conf &configureindex;
is a good guide for how it should look.
+ The names of the configuration items are not case-sensitive. So in the previous example
+ you could use dpkg::pre-install-pkgs.
+
Two specials are allowed, #include and #clear
#include will include the given file, unless the filename
ends in a slash, then the whole directory is included.
- #clear is used to erase a list of names.
+ #clear is used to erase a part of the configuration tree. The
+ specified element and all its descendents are erased.
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
@@ -98,6 +109,11 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
compiled for.
+ Default-Release
+ Default release to install packages from if more than one
+ version available. Contains release name, codename or release version. Examples: 'stable', 'testing', 'unstable', 'lenny', 'squeeze', '4.0', '5.0*'. See also &apt-preferences;.
+
+
Ignore-Hold
Ignore Held packages; This global option causes the problem resolver to
ignore held packages in its decision making.
@@ -158,6 +174,12 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
and the URI handlers.
+ PDiffs
+ Try to download deltas called PDiffs for
+ Packages or Sources files instead of downloading whole ones. True
+ by default.
+
+
Queue-Mode
Queuing mode; Queue-Mode can be one of host or
access which determines how APT parallelizes outgoing
@@ -181,8 +203,9 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
standard form of http://[[user][:pass]@]host[:port]/. Per
host proxies can also be specified by using the form
http::Proxy::<host> with the special keyword DIRECT
- meaning to use no proxies. The http_proxy environment variable
- will override all settings.
+ meaning to use no proxies. If no one of the above settings is specified,
+ http_proxy environment variable
+ will be used.
Three settings are provided for cache control with HTTP/1.1 compliant
proxy caches. No-Cache tells the proxy to not use its cached
@@ -206,10 +229,37 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
require this are in violation of RFC 2068.
+ https
+ HTTPS URIs. Cache-control and proxy options are the same as for
+ http method.
+ Pipeline-Depth option is not supported yet.
+
+ CaInfo suboption specifies place of file that
+ holds info about trusted certificates.
+ <host>::CaInfo is corresponding per-host option.
+ Verify-Peer boolean suboption determines whether verify
+ server's host certificate against trusted certificates or not.
+ <host>::Verify-Peer is corresponding per-host option.
+ Verify-Host boolean suboption determines whether verify
+ server's hostname or not.
+ <host>::Verify-Host is corresponding per-host option.
+ SslCert determines what certificate to use for client
+ authentication. <host>::SslCert is corresponding per-host option.
+ SslKey determines what private key to use for client
+ authentication. <host>::SslKey is corresponding per-host option.
+ SslForceVersion overrides default SSL version to use.
+ Can contain 'TLSv1' or 'SSLv3' string.
+ <host>::SslForceVersion is corresponding per-host option.
+
+
ftp
- FTP URIs; ftp::Proxy is the default proxy server to use. It is in the
- standard form of ftp://[[user][:pass]@]host[:port]/ and is
- overridden by the ftp_proxy environment variable. To use a ftp
+ FTP URIs; ftp::Proxy is the default ftp proxy to use. It is in the
+ standard form of ftp://[[user][:pass]@]host[:port]/. Per
+ host proxies can also be specified by using the form
+ ftp::Proxy::<host> with the special keyword DIRECT
+ meaning to use no proxies. If no one of the above settings is specified,
+ ftp_proxy environment variable
+ will be used. To use a ftp
proxy you will have to set the ftp::ProxyLogin script in the
configuration file. This entry specifies the commands to send to tell
the proxy server what to connect to. Please see
@@ -258,6 +308,20 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
+ CompressionTypes
+ List of compression types which are understood by the acquire methods.
+ Files like Packages can be available in various compression formats.
+ This list defines in which order the acquire methods will try to download these files.
+ Per default bzip2 compressed files will be prefered over
+ lzma, gzip and uncompressed files. The syntax for
+ the configuration fileentry is
+ Acquire::CompressionTypes::FileExtension "Methodname";
+ e.g. Acquire::CompressionTypes::bz2 "bzip2";
+ Note that at runtime 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 above (the inbuilt) setting is Dir::Bin::bzip2 "/bin/bzip2";
+
+
@@ -292,6 +356,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
Binary programs are pointed to by Dir::Bin. Dir::Bin::Methods
specifies the location of the method handlers and gzip,
+ bzip2, lzma,
dpkg, apt-get dpkg-source
dpkg-buildpackage and apt-cache specify the location
of the respective programs.
@@ -386,17 +451,389 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
- Debug options
- Most of the options in the debug section are not interesting to
- the normal user, however Debug::pkgProblemResolver shows
- interesting output about the decisions dist-upgrade makes.
- Debug::NoLocking disables file locking so APT can do some
- operations as non-root and Debug::pkgDPkgPM will print out the
- command line for each dpkg invokation. Debug::IdentCdrom will
- disable the inclusion of statfs data in CDROM IDs.
- Debug::Acquire::gpgv Debugging of the gpgv method.
+
+ Periodic and Archives options
+ APT::Periodic and APT::Archives
+ groups of options configure behavior of apt periodic updates, which is
+ done by /etc/cron.daily/apt script. See header of
+ this script for the brief documentation of these options.
+
+
+ Debug options
+
+ Enabling options in the Debug:: section will
+ cause debugging information to be sent to the standard error
+ stream of the program utilizing the apt
+ libraries, or enable special program modes that are primarily
+ useful for debugging the behavior of apt.
+ Most of these options are not interesting to a normal user, but a
+ few may be:
+
+
+
+
+ Debug::pkgProblemResolver enables output
+ about the decisions made by
+ dist-upgrade, upgrade, install, remove, purge.
+
+
+
+
+
+ Debug::NoLocking disables all file
+ locking. This can be used to run some operations (for
+ instance, apt-get -s install) as a
+ non-root user.
+
+
+
+
+
+ Debug::pkgDPkgPM prints out the actual
+ command line each time that apt invokes
+ &dpkg;.
+
+
+
+
+
+ Debug::IdentCdrom disables the inclusion
+ of statfs data in CDROM IDs.
+
+
+
+
+
+
+ A full list of debugging options to apt follows.
+
+
+
+
+ Debug::Acquire::cdrom
+
+
+
+ Print information related to accessing
+ cdrom:// sources.
+
+
+
+
+
+ Debug::Acquire::ftp
+
+
+
+ Print information related to downloading packages using
+ FTP.
+
+
+
+
+
+ Debug::Acquire::http
+
+
+
+ Print information related to downloading packages using
+ HTTP.
+
+
+
+
+
+ Debug::Acquire::https
+
+
+
+ Print information related to downloading packages using
+ HTTPS.
+
+
+
+
+
+ Debug::Acquire::gpgv
+
+
+
+ Print information related to verifying cryptographic
+ signatures using gpg.
+
+
+
+
+
+ Debug::aptcdrom
+
+
+
+ Output information about the process of accessing
+ collections of packages stored on CD-ROMs.
+
+
+
+
+
+ Debug::BuildDeps
+
+
+ Describes the process of resolving build-dependencies in
+ &apt-get;.
+
+
+
+
+
+ Debug::Hashes
+
+
+ Output each cryptographic hash that is generated by the
+ apt libraries.
+
+
+
+
+
+ Debug::IdentCDROM
+
+
+ Do not include information from statfs,
+ namely the number of used and free blocks on the CD-ROM
+ filesystem, when generating an ID for a CD-ROM.
+
+
+
+
+
+ Debug::NoLocking
+
+
+ Disable all file locking. For instance, this will allow
+ two instances of apt-get
+ update
to run at the same time.
+
+
+
+
+
+ Debug::pkgAcquire
+
+
+
+ Log when items are added to or removed from the global
+ download queue.
+
+
+
+
+
+ Debug::pkgAcquire::Auth
+
+
+ Output status messages and errors related to verifying
+ checksums and cryptographic signatures of downloaded files.
+
+
+
+
+
+ Debug::pkgAcquire::Diffs
+
+
+ Output information about downloading and applying package
+ index list diffs, and errors relating to package index list
+ diffs.
+
+
+
+
+
+ Debug::pkgAcquire::RRed
+
+
+
+ Output information related to patching apt package lists
+ when downloading index diffs instead of full indices.
+
+
+
+
+
+ Debug::pkgAcquire::Worker
+
+
+
+ Log all interactions with the sub-processes that actually
+ perform downloads.
+
+
+
+
+
+ Debug::pkgAutoRemove
+
+
+
+ Log events related to the automatically-installed status of
+ packages and to the removal of unused packages.
+
+
+
+
+
+ Debug::pkgDepCache::AutoInstall
+
+
+ Generate debug messages describing which packages are being
+ automatically installed to resolve dependencies. This
+ corresponds to the initial auto-install pass performed in,
+ e.g., apt-get install, and not to the
+ full apt dependency resolver; see
+ Debug::pkgProblemResolver for that.
+
+
+
+
+
+ Debug::pkgDepCache::Marker
+
+
+ Generate debug messages describing which package is marked
+ as keep/install/remove while the ProblemResolver does his work.
+ Each addition or deletion may trigger additional actions;
+ they are shown indented two additional space under the original entry.
+ The format for each line is MarkKeep,
+ MarkDelete or MarkInstall followed by
+ package-name <a.b.c -> d.e.f | x.y.z> (section)
+ where a.b.c is the current version of the package,
+ d.e.f is the version considered for installation and
+ x.y.z is a newer version, but not considered for installation
+ (because of a low pin score). The later two can be omitted if there is none or if
+ it is the same version as the installed.
+ section is the name of the section the package appears in.
+
+
+
+
+
+
+ Debug::pkgInitConfig
+
+
+ Dump the default configuration to standard error on
+ startup.
+
+
+
+
+
+ Debug::pkgDPkgPM
+
+
+ When invoking &dpkg;, output the precise command line with
+ which it is being invoked, with arguments separated by a
+ single space character.
+
+
+
+
+
+ Debug::pkgDPkgProgressReporting
+
+
+ Output all the data received from &dpkg; on the status file
+ descriptor and any errors encountered while parsing it.
+
+
+
+
+
+ Debug::pkgOrderList
+
+
+
+ Generate a trace of the algorithm that decides the order in
+ which apt should pass packages to
+ &dpkg;.
+
+
+
+
+
+ Debug::pkgPackageManager
+
+
+
+ Output status messages tracing the steps performed when
+ invoking &dpkg;.
+
+
+
+
+
+ Debug::pkgPolicy
+
+
+
+ Output the priority of each package list on startup.
+
+
+
+
+
+ Debug::pkgProblemResolver
+
+
+
+ Trace the execution of the dependency resolver (this
+ applies only to what happens when a complex dependency
+ problem is encountered).
+
+
+
+
+
+ Debug::pkgProblemResolver::ShowScores
+
+
+ Display a list of all installed packages with their calculated score
+ used by the pkgProblemResolver. The description of the package
+ is the same as described in Debug::pkgDepCache::Marker
+
+
+
+
+
+ Debug::sourceList
+
+
+
+ Print information about the vendors read from
+ /etc/apt/vendors.list.
+
+
+
+
+
+
+
Examples
&configureindex; is a
@@ -405,7 +842,17 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
Files
- /etc/apt/apt.conf
+
+ /etc/apt/apt.conf
+ APT configuration file.
+ Configuration Item: Dir::Etc::Main.
+
+
+ /etc/apt/apt.conf.d/
+ APT configuration file fragments.
+ Configuration Item: Dir::Etc::Parts.
+
+
See Also