X-Git-Url: https://git.saurik.com/apt.git/blobdiff_plain/bb4fc0a9e4e105a13b3a032b28802a84523fc506..e321be5664c981d2e31e14b278b8fbcdcf10849d:/doc/apt.conf.5.xml
diff --git a/doc/apt.conf.5.xml b/doc/apt.conf.5.xml
index 43f33681f..eece75d28 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
@@ -46,9 +52,10 @@
the APT tool group, for the Get tool. options do not inherit from their
parent groups.
- Syntacticly the configuration language is modeled after what the ISC tools
- such as bind and dhcp use. Lines starting with
- // are treated as comments (ignored).
+ 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), 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
@@ -75,6 +82,9 @@ 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.
@@ -98,6 +108,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 +173,12 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
and the URI handlers.
+ PDiffs
+ Try do 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
@@ -206,6 +227,29 @@ 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
@@ -214,7 +258,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
$(PROXY_USER) $(PROXY_PASS) $(SITE_USER)
$(SITE_PASS) $(SITE) and $(SITE_PORT)
Each is taken from it's respective URI component.
@@ -235,7 +279,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
not recommended to use FTP over HTTP due to its low efficiency.
The setting ForceExtended controls the use of RFC2428
- EPSV and EPRT commands. The defaut is false, which means
+ EPSV and EPRT 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.
@@ -276,7 +320,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
pkgcache as well as the location to place downloaded archives,
Dir::Cache::archives. 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 Dir::State the default
directory is contained in Dir::Cache
@@ -295,6 +339,19 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
dpkg, apt-get dpkg-source
dpkg-buildpackage and apt-cache specify the location
of the respective programs.
+
+
+ The configuration item RootDir has a special
+ meaning. If set, all paths in Dir:: will be
+ relative to RootDir, even paths that
+ are specified absolutely. So, for instance, if
+ RootDir is set to
+ /tmp/staging and
+ Dir::State::status is set to
+ /var/lib/dpkg/status, then the status file
+ will be looked up in
+ /tmp/staging/var/lib/dpkg/status.
+
APT in DSelect
@@ -373,16 +430,385 @@ 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 output 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.
+
+
+
+
+
+ Debug::Vendor
+
+
+
+ Print information about each vendor.
+
+
+
+
Examples