X-Git-Url: https://git.saurik.com/apt.git/blobdiff_plain/4fc6b7570c3e97b65c118b58cdf6729fa94c9b03..8b21456acba3cbbc28f35eba684d8f21b0c290b4:/doc/apt.conf.5.xml diff --git a/doc/apt.conf.5.xml b/doc/apt.conf.5.xml index efe986ea8..a248b2cfd 100644 --- a/doc/apt.conf.5.xml +++ b/doc/apt.conf.5.xml @@ -19,7 +19,7 @@ &apt-email; &apt-product; - 2012-06-09T00:00:00Z + 2016-07-07T00:00:00Z @@ -54,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. @@ -171,6 +173,29 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; + + + This scope defines which compression formats are supported, how compression + and decompression can be performed if support for this format isn't built + into apt directly and a cost-value indicating how costly it is to compress + something in this format. As an example the following configuration stanza + would allow apt to download and uncompress as well as create and store + files with the low-cost .reversed file extension which + it will pass to the command rev without additional + commandline parameters for compression and uncompression: + +APT::Compressor::rev { + Name "rev"; + Extension ".reversed"; + Binary "rev"; + CompressArg {}; + UncompressArg {}; + Cost "10"; +}; + + + + List of all build profiles enabled for build-dependency resolution, @@ -183,7 +208,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; 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;. @@ -301,6 +326,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. @@ -312,7 +339,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. @@ -324,14 +352,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 @@ -341,6 +372,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 @@ -403,15 +444,20 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; 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. + specify an external command to discover the http proxy to use. The first + and only parameter is an URI denoting the host to be contacted to allow + for host-specific configuration. APT expects the command to output the + proxy on stdout as a single line in the style http://proxy:port/ + or the word DIRECT if no proxy should be used. No output + indicates that the generic proxy settings should be used. + + Note that auto-detection will not be used for a host if a host-specific proxy + configuration is already 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 + uses avahi. + + This option takes precedence over the legacy option name ProxyAutoDetect. @@ -511,25 +557,25 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; List of compression types which are understood by the acquire methods. Files like Packages can be available in various compression formats. - By default the acquire methods can decompress bzip2, lzma - and gzip compressed files; with this setting more formats can be added - on the fly or the used method can be changed. The syntax for this is: + By default the acquire methods can decompress and recompress many common formats like xz and + gzip; with this scope the supported formats can be queried, modified + as well as support for more formats added (see also ). The syntax for this is: Acquire::CompressionTypes::FileExtension "Methodname"; Also, the Order subgroup can be used to define in which order the acquire system will try to download the compressed files. The acquire system will try the first and proceed with the next compression type in this list on error, so to prefer one over the other type - simply add the preferred type first - default types not already added will be implicitly appended + simply add the preferred type first - types not already added will be implicitly appended to the end of the list, so e.g. Acquire::CompressionTypes::Order:: "gz"; can - be used to prefer gzip compressed files over bzip2 and lzma. - If lzma should be preferred over gzip and bzip2 the - configure setting should look like this: Acquire::CompressionTypes::Order { "lzma"; "gz"; }; + be used to prefer gzip compressed files over all other compression formats. + If xz should be preferred over gzip and bzip2 the + configure setting should look like this: Acquire::CompressionTypes::Order { "xz"; "gz"; }; It is not needed to add bz2 to the list explicitly as it will be added automatically. Note that the Dir::Bin::Methodname - will be checked at run time. If this option has been set, 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"; + will be checked at run time. If this option has been set and support for + this format isn't directly built into apt, 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"; 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. @@ -593,34 +639,93 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; + + + 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 update operations to load data files from + repositories without sufficient security information. + The default value is "false". + Concept, implications as well as alternatives are detailed in &apt-secure;. - + - 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. + Allow update operations to load data files from + repositories which provide security information, but these + are deemed no longer cryptographically strong enough. + The default value is "false". + Concept, implications as well as alternatives are detailed in &apt-secure;. + + - Note that apt will still consider packages from this source - untrusted and warn about them if you try to install - them. - + + + Allow that a repository that was previously gpg signed to become + unsigned during an update operation. When there is no valid signature + for a previously 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. + Concept, implications as well as alternatives are detailed in &apt-secure;. + + 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 @@ -659,7 +764,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 @@ -668,6 +773,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. @@ -743,10 +849,35 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; install to the commands, one per line on the requested file descriptor, defaulting to 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 3 adds the architecture and MultiArch - flag to each version being dumped. + 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