X-Git-Url: https://git.saurik.com/apt.git/blobdiff_plain/ad2d0cef574ff0143ee27cdbd058cba179368dbd..1eba782fc3c55528a4da14d79e114874b9299453:/doc/apt.conf.5.xml diff --git a/doc/apt.conf.5.xml b/doc/apt.conf.5.xml index 6a61acd2d..5c4dcd1aa 100644 --- a/doc/apt.conf.5.xml +++ b/doc/apt.conf.5.xml @@ -1,13 +1,9 @@ -%aptent; - - -%aptverbatiment; - + %aptent; + %aptverbatiment; + %aptvendor; ]> @@ -23,7 +19,7 @@ &apt-email; &apt-product; - 2012-06-09T00:00:00Z + 2015-12-14T00:00:00Z @@ -58,6 +54,8 @@ configuration list - in which case it will be silently ignored. the main configuration file specified by Dir::Etc::main + all options set in the binary specific configuration + subtree are moved into the root of the tree. the command line options are applied to override the configuration directives or to load even more configuration files. @@ -98,8 +96,7 @@ APT { DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; - In general the sample configuration file in - &docdir;examples/apt.conf &configureindex; + In general the sample configuration file &configureindex; is a good guide for how it should look. Case is not significant in names of configuration items, so in the @@ -176,10 +173,19 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; + + + List of all build profiles enabled for build-dependency resolution, + without the "profile." namespace prefix. + By default this list is empty. The DEB_BUILD_PROFILES + as used by &dpkg-buildpackage; overrides the list notation. + + + Default release to install packages from if more than one version is available. Contains release name, codename or release version. Examples: 'stable', 'testing', - 'unstable', '&stable-codename;', '&testing-codename;', '4.0', '5.0*'. See also &apt-preferences;. + 'unstable', '&debian-stable-codename;', '&debian-testing-codename;', '4.0', '5.0*'. See also &apt-preferences;. @@ -297,6 +303,8 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; Valid-Until header, but if they don't or a stricter value is desired the Max-ValidTime option below can be used. + The option of &sources-list; entries should be + preferred to disable the check selectively instead of using this global override. @@ -308,7 +316,8 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; the earlier date of the two is used as the expiration date. The default value is 0 which stands for "valid forever". Archive specific settings can be made by appending the label of the archive - to the option name. + to the option name. Preferably, the same can be achieved for specific + &sources-list; entries by using the option there. @@ -320,14 +329,17 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; frequently 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. + the archive to the option name. Preferably, the same can be achieved for specific + &sources-list; entries by using the option there. Try to download deltas called PDiffs for - indexes (like Packages files) instead of downloading - whole ones. True by default. + indexes (like Packages files) instead of + downloading whole ones. True by default. Preferably, this can be set + for specific &sources-list; entries or index files by using the + option there. Two sub-options to limit the use of PDiffs are also available: FileLimit can be used to specify a maximum number of PDiff files should be downloaded to update a file. SizeLimit @@ -337,6 +349,16 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; + + Try to download indexes via an URI constructed from a + hashsum of the expected file rather than downloaded via a well-known + stable filename. True by default, but automatically disabled if the + source indicates no support for it. Usage can be forced with the special + value "force". Preferably, this can be set for specific &sources-list; entries + or index files by using the option there. + + + Queuing mode; Queue-Mode can be one of host or access which determines how APT parallelizes outgoing @@ -380,21 +402,37 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; The setting Acquire::http::Pipeline-Depth can be used to enable HTTP pipelining (RFC 2616 section 8.1.2.2) which can be beneficial e.g. on high-latency connections. It specifies how many requests are sent 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. + APT tries to detect and workaround misbehaving webservers and proxies at runtime, but + if you know that yours does not conform to the HTTP/1.1 specification pipelining can + be disabled by setting the value to 0. It is enabled by default with the value 10. Acquire::http::AllowRedirect controls whether 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 kilobytes. The default value is 0 which deactivates - the limit and tries to use all available bandwidth (note that this option implicitly - disables downloading from multiple servers at the same time.) + The used bandwidth can be limited with + Acquire::http::Dl-Limit which accepts integer + values in kilobytes per second. The default value is 0 which + deactivates the limit and tries to use all available bandwidth. + Note that this option implicitly disables downloading from + multiple servers at the same time. Acquire::http::User-Agent can be used to set a different User-Agent for the http download method as some proxies allow access for clients only if the client uses a known identifier. + + Acquire::http::Proxy-Auto-Detect can be used to + specify an external command to discover the http proxy to use. Apt expects + the command to output the proxy on stdout in the style + http://proxy:port/. This will override the + generic Acquire::http::Proxy but not any specific + host proxy configuration set via + Acquire::http::Proxy::$HOST. + + See the &squid-deb-proxy-client; package for an example implementation that + uses avahi. This option takes precedence over the legacy option name + ProxyAutoDetect. + + @@ -554,9 +592,107 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; + + + When downloading, force to use only the IPv4 protocol. + + + + + + When downloading, force to use only the IPv6 protocol. + + + + + + The maximum file size of Release/Release.gpg/InRelease files. + The default is 10MB. + + + + + + This option controls if apt will use the DNS SRV server record + as specified in RFC 2782 to select an alternative server to + connect to. + The default is "true". + + + + + + Allow the update operation to load data files from + a repository without a trusted signature. If enabled this + option no data files will be loaded and the update + operation fails with a error for this source. The default + is false for backward compatibility. This will be changed + in the future. + + + + + + Allow that a repository that was previously gpg signed to become + unsigned durign a update operation. When there is no valid signature + of a perviously trusted repository apt will refuse the update. This + option can be used to override this protection. You almost certainly + never want to enable this. The default is false. + + Note that apt will still consider packages from this source + untrusted and warn about them if you try to install + them. + + + + scope + + Acquiring changelogs can only be done if an URI is known from where to get them. + Preferable the Release file indicates this in a 'Changelogs' field. If this isn't + available the Label/Origin field of the Release file is used to check if a + Acquire::Changelogs::URI::Label::LABEL or + Acquire::Changelogs::URI::Origin::ORIGIN option + exists and if so this value is taken. The value in the Release file can be overridden + with Acquire::Changelogs::URI::Override::Label::LABEL + or Acquire::Changelogs::URI::Override::Origin::ORIGIN. + + The value should be a normal URI to a text file, except that package specific data is + replaced with the placeholder @CHANGEPATH@. The + value for it is: 1. if the package is from a component (e.g. main) + this is the first part otherwise it is omitted, 2. the first letter of source package name, + except if the source package name starts with 'lib' in which case it will + be the first four letters. 3. The complete source package name. 4. the complete name again and + 5. the source version. + The first (if present), second, third and fourth part are separated by a slash ('/') + and between the fourth and fifth part is an underscore ('_'). + + The special value 'no' is available for this option indicating that + this source can't be used to acquire changelog files from. Another source will be tried + if available in this case. + + + + Binary specific configuration + Especially with the introduction of the apt binary + it can be useful to set certain options only for a specific binary as + even options which look like they would effect only a certain binary like + effect + apt-get as well as apt. + + Setting an option for a specific binary only can be achieved by + setting the option inside the + + scope. Setting the option for + the apt only can e.g. by done by setting + instead. + Note that as seen in the DESCRIPTION section further above you can't + set binary-specific options on the commandline itself nor in + configuration files loaded via the commandline. + + Directories The Dir::State section has directories that pertain to local @@ -570,10 +706,11 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; information, such as the two package caches srcpkgcache and 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 the empty string. This will slow down startup but - save disk space. It is probably preferable to turn off the pkgcache rather - than the srcpkgcache. Like Dir::State the default - directory is contained in Dir::Cache + by setting pkgcache or srcpkgcache to + "". This will slow down startup but save disk space. It + is probably preferable to turn off the pkgcache rather than the srcpkgcache. + Like Dir::State the default directory is contained in + Dir::Cache Dir::Etc contains the location of configuration files, sourcelist gives the location of the sourcelist and @@ -594,7 +731,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; The configuration item RootDir has a special - meaning. If set, all paths in Dir:: will be + meaning. If set, all paths will be relative to RootDir, even paths that are specified absolutely. So, for instance, if RootDir is set to @@ -603,6 +740,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; /var/lib/dpkg/status, then the status file will be looked up in /tmp/staging/var/lib/dpkg/status. + If you want to prefix only relative paths, set Dir instead. @@ -675,13 +813,53 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; options this must be specified in list notation. The commands are invoked in order using /bin/sh; should any fail APT will abort. APT will pass the filenames of all .deb files it is going to - install to the commands, one per line on standard input. - - Version 2 of this protocol dumps more information, including the - protocol version, the APT configuration space and the packages, files - and versions being changed. Version 2 is enabled by setting - DPkg::Tools::options::cmd::Version to 2. cmd is a - command given to Pre-Install-Pkgs. + install to the commands, one per line on the requested file descriptor, defaulting + to standard input. + + Version 2 of this protocol sends more information through the requested + file descriptor: a line with the text VERSION 2, + the APT configuration space, and a list of package actions with filename + and version information. + + Each configuration directive line has the form + key=value. Special characters (equal signs, newlines, + nonprintable characters, quotation marks, and percent signs in + key and newlines, nonprintable characters, and percent + signs in value) are %-encoded. Lists are represented + by multiple key::=value lines with the same key. The + configuration section ends with a blank line. + + Package action lines consist of five fields in Version 2: package + name (without architecture qualification even if foreign), old version, + direction of version change (< for upgrades, > for downgrades, = for + no change), new version, action. The version fields are "-" for no version + at all (for example when installing a package for the first time; no + version is treated as earlier than any real version, so that is an + upgrade, indicated as - < 1.23.4). The action field + is "**CONFIGURE**" if the package is being configured, "**REMOVE**" if it + is being removed, or the filename of a .deb file if it is being + unpacked. + + In Version 3 after each version field follows the architecture + of this version, which is "-" if there is no version, and a field showing + the MultiArch type "same", "foreign", "allowed" or "none". Note that "none" + is an incorrect typename which is just kept to remain compatible, it + should be read as "no" and users are encouraged to support both. + + The version of the protocol to be used for the command + cmd can be chosen by setting + DPkg::Tools::options::cmd::Version + accordingly, the default being version 1. If APT isn't supporting the requested + version it will send the information in the highest version it has support for instead. + + + The file descriptor to be used to send the information can be requested with + DPkg::Tools::options::cmd::InfoFD + which defaults to 0 for standard input and is available since + version 0.9.11. Support for the option can be detected by looking for the environment + variable APT_HOOK_INFO_FD which contains the number of the used + file descriptor as a confirmation. + @@ -1131,6 +1309,18 @@ DPkg::TriggersPending "true"; + + + + + Display the external commands that are called by apt hooks. + This includes e.g. the config options + DPkg::{Pre,Post}-Invoke or + APT::Update::{Pre,Post}-Invoke. + + + +