X-Git-Url: https://git.saurik.com/apt.git/blobdiff_plain/29efb9dda712554a2f05eb0475e3cd0a6b8a90fb..317bb39f3cd6626c74f25d7bdf2907f1b235f553:/doc/apt.conf.5.xml?ds=sidebyside diff --git a/doc/apt.conf.5.xml b/doc/apt.conf.5.xml index d5e185757..380371230 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-08-17T00: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;. @@ -334,8 +359,10 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; 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 @@ -345,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 @@ -407,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. @@ -515,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. @@ -597,29 +639,43 @@ 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 @@ -633,11 +689,11 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; 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, expect that package specific data is - replaced with the placeholder CHANGEPATH. The + 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, - expect if the source package name starts with 'lib' in which case it will + 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 ('/') @@ -652,6 +708,24 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; + 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 @@ -788,9 +862,10 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; 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: old version, direction - of version change (< for upgrades, > for downgrades, = for no - change), new version, action. The version fields are "-" for no version + 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 @@ -800,7 +875,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; 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" + 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. @@ -829,91 +904,21 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; These options are passed to &dpkg-buildpackage; when compiling packages; the default is to disable signing and produce all binaries. - - dpkg trigger usage (and related options) - APT can call &dpkg; in such a way as to let it make aggressive use of triggers over - multiple calls of &dpkg;. Without further options &dpkg; will use triggers once each time it runs. - Activating these options can therefore decrease the time needed to perform the - install or upgrade. Note that it is intended to activate these options per default in the - future, but as it drastically changes the way APT calls &dpkg; it needs a lot more testing. - These options are therefore currently experimental and should not be used in - production environments. It also breaks progress reporting such that all front-ends will - currently stay around half (or more) of the time in the 100% state while it actually configures - all packages. - Note that it is not guaranteed that APT will support these options or that these options will - not cause (big) trouble in the future. If you have understand the current risks and problems with - these options, but are brave enough to help testing them, create a new configuration file and test a - combination of options. Please report any bugs, problems and improvements you encounter and make sure - to note which options you have used in your reports. Asking &dpkg; for help could also be useful for - debugging proposes, see e.g. dpkg --audit. A defensive option combination would be -DPkg::NoTriggers "true"; -PackageManager::Configure "smart"; -DPkg::ConfigurePending "true"; -DPkg::TriggersPending "true"; - - - - Add the no triggers flag to all &dpkg; calls (except the ConfigurePending call). - See &dpkg; if you are interested in what this actually means. In short: &dpkg; will not run the - triggers when this flag is present unless it is explicitly called to do so in an extra call. - Note that this option exists (undocumented) also in older APT versions with a slightly different - meaning: Previously these option only append --no-triggers to the configure calls to &dpkg; - - now APT will also add this flag to the unpack and remove calls. - - - Valid values are "all", - "smart" and "no". - The default value is "all", which causes APT to - configure all packages. The "smart" way is to - configure only packages which need to be configured before another - package can be unpacked (Pre-Depends), and let the rest be configured - by &dpkg; with a call generated by the ConfigurePending option (see - below). On the other hand, "no" will not configure - anything, and totally relies on &dpkg; for configuration (which at the - moment will fail if a Pre-Depends is encountered). Setting this option - to any value other than all will implicitly also - activate the next option by default, as otherwise the system could end - in an unconfigured and potentially unbootable state. - - - If this option is set APT will call dpkg --configure --pending - to let &dpkg; handle all required configurations and triggers. This option is activated automatically - per default if the previous option is not set to all, but deactivating it could be useful - if you want to run APT multiple times in a row - e.g. in an installer. In these sceneries you could - deactivate this option in all but the last run. - - - Useful for the smart configuration as a package which has pending - triggers is not considered as installed, and &dpkg; treats them as unpacked - currently which is a showstopper for Pre-Dependencies (see debbugs #526774). Note that this will - process all triggers, not only the triggers needed to configure this package. - - - Essential packages (and their dependencies) should be configured immediately - after unpacking. It is a good idea to do this quite early in the upgrade process as these - configure calls also currently require DPkg::TriggersPending which - will run quite a few triggers (which may not be needed). Essentials get per default a high score - but the immediate flag is relatively low (a package which has a Pre-Depends is rated higher). - These option and the others in the same group can be used to change the scoring. The following - example shows the settings with their default values. - OrderList::Score { - Delete 500; - Essential 200; - Immediate 10; - PreDepends 50; -}; - - - - + + If this option is set APT will call dpkg --configure --pending + to let &dpkg; handle all required configurations and triggers. This option is activated by default, + but deactivating it could be useful if you want to run APT multiple times in a row - e.g. in an installer. + In this scenario you could deactivate this option in all but the last run. + + Periodic and Archives options APT::Periodic and APT::Archives groups of options configure behavior of apt periodic updates, which is - done by the /etc/cron.daily/apt script. See the top of + done by the /usr/lib/apt/apt.systemd.daily script. See the top of this script for the brief documentation of these options.