X-Git-Url: https://git.saurik.com/apt.git/blobdiff_plain/c755c38a8342177f1375a9dab3957fc48cedbb2b..4920c8c7d42f6341758738b1f056dd1f0db47775:/doc/apt.conf.5.xml diff --git a/doc/apt.conf.5.xml b/doc/apt.conf.5.xml index e2db9defb..3de22e098 100644 --- a/doc/apt.conf.5.xml +++ b/doc/apt.conf.5.xml @@ -5,6 +5,9 @@ %aptent; + +%aptverbatiment; + ]> @@ -13,15 +16,14 @@ &apt-author.jgunthorpe; &apt-author.team; - Daniel - Burrows + &apt-name.dburrows; Initial documentation of Debug::*. dburrows@debian.org &apt-email; &apt-product; - 18 September 2009 + 2012-05-21T00:00:00Z @@ -37,16 +39,29 @@ Description - apt.conf is the main configuration file for the APT suite of - tools, all tools make use of the configuration file and a common command line - parser to provide a uniform environment. When an APT tool starts up it will - read the configuration specified by the APT_CONFIG environment - variable (if any) and then read the files in Dir::Etc::Parts - then read the main configuration file specified by - Dir::Etc::main then finally apply the - command line options to override the configuration directives, possibly - loading even more config files. - + apt.conf is the main configuration file for + the APT suite of tools, but by far not the only place changes to options + can be made. All tools therefore share the configuration files and also + use a common command line parser to provide a uniform environment. + + When an APT tool starts up it will read the configuration files + in the following order: + the file specified by the APT_CONFIG + environment variable (if any) + all files in Dir::Etc::Parts in + alphanumeric ascending order which have either no or "conf" + as filename extension and which only contain alphanumeric, + hyphen (-), underscore (_) and period (.) characters. + Otherwise APT will print a notice that it has ignored a file if the file + doesn't match a pattern in the Dir::Ignore-Files-Silently + configuration list - in this case it will be silently ignored. + the main configuration file specified by + Dir::Etc::main + the command line options are applied to override the + configuration directives or to load even more configuration files. + + + Syntax The configuration file is organized in a tree with options organized into functional groups. Option specification is given with a double colon notation, for instance APT::Get::Assume-Yes is an option within @@ -111,14 +126,14 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; 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 name (APT::Get::Assume-Yes for instance) followed by an equals - sign then the new value of the option. Lists can be appended too by adding - a trailing :: to the list name. (As you might suspect: The scope syntax can't be used - on the command line.) + sign then the new value of the option. To append a new element to a list, add a + trailing :: to the name of the list. (As you might suspect: The scope syntax can't + be used on the command line.) Note that you can use :: only for appending one item per line to a list and that you should not use it in combination with the scope syntax. (The scope syntax implicit insert ::) Using both syntaxes together will trigger a bug - which some users unfortunately relay on: An option with the unusual name "::" + which some users unfortunately depend on: An option with the unusual name "::" which acts like every other option with a name. These introduces many problems including that a user who writes multiple lines in this wrong syntax in the hope to append to a list will gain the opposite as only the last assignment for this option @@ -132,30 +147,41 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; options for all of the tools. - Architecture + System Architecture; sets the architecture to use when fetching files and parsing package lists. The internal default is the architecture apt was 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;. + + + All Architectures the system supports. Processors implementing the + amd64 (also called x86-64) instruction set are + e.g. also able to execute binaries compiled for the i386 + (x86) instruction set; This list is use when fetching files and + parsing package lists. The internal default is always the native architecture (APT::Architecture) + and all foreign architectures it can retrieve by calling dpkg --print-foreign-architectures. + - - Ignore-Hold + + + Default release to install packages from if more than one + version available. Contains release name, codename or release version. Examples: 'stable', 'testing', + 'unstable', '&stable-codename;', '&testing-codename;', '4.0', '5.0*'. See also &apt-preferences;. + + + Ignore Held packages; This global option causes the problem resolver to ignore held packages in its decision making. - Clean-Installed + Defaults to on. When turned on the autoclean feature will remove any packages which can no longer be downloaded from the cache. If turned off then packages that are locally installed are also excluded from cleaning - but note that APT provides no direct means to reinstall them. - Immediate-Configure + Defaults to on which will cause APT to install essential and important packages as fast as possible in the install/upgrade operation. This is done to limit the effect of a failing &dpkg; call: If this option is disabled APT does treat an important package in the same way as @@ -166,10 +192,10 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; longer guaranteed to work as their dependency on A is not longer satisfied. The immediate configuration marker is also applied to all dependencies which can generate a problem if the dependencies e.g. form a circle as a dependency with the immediate flag is comparable with a Pre-Dependency. So in theory it is possible - that APT encounters a situation in which it is unable to perform immediate configuration, error out and - refers to this option so the user can deactivate the immediate configuration temporary to be able to perform + that APT encounters a situation in which it is unable to perform immediate configuration, errors out and + refers to this option so the user can deactivate the immediate configuration temporarily to be able to perform an install/upgrade again. Note the use of the word "theory" here as this problem was only encountered by now - in real world a few times in non-stable distribution versions and caused by wrong dependencies of the package + in real world a few times in non-stable distribution versions and was caused by wrong dependencies of the package in question or by a system in an already broken state, so you should not blindly disable this option as the mentioned scenario above is not the only problem immediate configuration can help to prevent in the first place. Before a big operation like dist-upgrade is run with this option disabled it should be tried to @@ -178,7 +204,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; improving or correcting the upgrade process. - Force-LoopBreak + Never Enable this option unless you -really- know what you are doing. It permits APT to temporarily remove an essential package to break a Conflicts/Conflicts or Conflicts/Pre-Depend loop between two essential @@ -187,26 +213,37 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; anything that those packages depend on. - Cache-Limit - APT uses a fixed size memory mapped cache file to store the 'available' - information. This sets the size of that cache (in bytes). + + APT uses since version 0.7.26 a resizable memory mapped cache file to store the 'available' + information. Cache-Start acts as a hint to which size the Cache will grow + and is therefore the amount of memory APT will request at startup. The default value is + 20971520 bytes (~20 MB). Note that this amount of space needs to be available for APT + otherwise it will likely fail ungracefully, so for memory restricted devices this value should + be lowered while on systems with a lot of configured sources it should be increased. + Cache-Grow defines in bytes with the default of 1048576 (~1 MB) how much + the Cache size will be increased in the event the space defined by Cache-Start + is not enough. These value will be applied again and again until either the cache is big + enough to store all information or the size of the cache reaches the Cache-Limit. + The default of Cache-Limit is 0 which stands for no limit. + If Cache-Grow is set to 0 the automatic grow of the cache is disabled. + - Build-Essential + Defines which package(s) are considered essential build dependencies. - Get + The Get subsection controls the &apt-get; tool, please see its documentation for more information about the options here. - Cache + The Cache subsection controls the &apt-cache; tool, please see its documentation for more information about the options here. - CDROM + The CDROM subsection controls the &apt-cdrom; tool, please see its documentation for more information about the options here. @@ -218,13 +255,53 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; and the URI handlers. - PDiffs + + Security related option defaulting to true as an + expiring validation for a Release file prevents longtime replay attacks + and can e.g. also help users to identify no longer updated mirrors - + but the feature depends on the correctness of the time on the user system. + Archive maintainers are encouraged to create Release files with the + Valid-Until header, but if they don't or a stricter value + is volitional the following Max-ValidTime option can be used. + + + + + Seconds the Release file should be considered valid after + it was created (indicated by the Date header). + If the Release file itself includes a Valid-Until header + the earlier date of the two is used as the expiration date. + The default value is 0 which stands for "for ever valid". + Archive specific settings can be made by appending the label of the archive + to the option name. + + + + + Minimum of seconds the Release file should be considered + valid after it was created (indicated by the Date header). + Use this if you need to use a seldomly updated (local) mirror of a more + regular 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. + + + + Try to download deltas called PDiffs for Packages or Sources files instead of downloading whole ones. True - by default. + by default. + Two sub-options to limit the use of PDiffs are also available: + With FileLimit can be specified how many PDiff files + are downloaded at most to update a file. SizeLimit + on the other hand is the maximum percentage of the size of all patches + compared to the size of the targeted file. If one of these limits is + exceeded the complete file is downloaded instead of the patches. + - Queue-Mode + Queuing mode; Queue-Mode can be one of host or access which determines how APT parallelizes outgoing connections. host means that one connection per target host @@ -232,17 +309,17 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; will be opened. - Retries + Number of retries to perform. If this is non-zero APT will retry failed files the given number of times. - Source-Symlinks + Use symlinks for source archives. If set to true then source archives will be symlinked when possible instead of copying. True is the default. - http + HTTP URIs; http::Proxy is the default http proxy to use. It is in the standard form of http://[[user][:pass]@]host[:port]/. Per host proxies can also be specified by using the form @@ -264,24 +341,33 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; The option timeout sets the timeout timer used by the method, this applies to all things including connection timeout and data timeout. - One setting is provided to control the pipeline depth in cases where the - remote server is not RFC conforming or buggy (such as Squid 2.0.2). - Acquire::http::Pipeline-Depth can be a value from 0 to 5 - indicating how many outstanding requests APT should send. A value of - zero MUST be specified if the remote host does not properly linger - on TCP connections - otherwise data corruption will occur. Hosts which - require this are in violation of RFC 2068. + The setting Acquire::http::Pipeline-Depth can be used to + enabled HTTP pipeling (RFC 2616 section 8.1.2.2) which can be beneficial e.g. on + high-latency connections. It specifies how many requests are send 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. + + Acquire::http::AllowRedirect controls if 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 kilobyte. The default value is 0 which deactivates the limit and tries uses as much as possible of the bandwidth (Note that this option implicit - deactivates the download from multiple servers at the same time.) + deactivates the download 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. + - https - HTTPS URIs. Cache-control and proxy options are the same as for - http method. - Pipeline-Depth option is not supported yet. + + HTTPS URIs. Cache-control, Timeout, AllowRedirect, Dl-Limit and + proxy options are the same as for http method and will also + default to the options from the http method if they are not + explicitly set for https. Pipeline-Depth option is not + supported yet. CaInfo suboption specifies place of file that holds info about trusted certificates. @@ -301,7 +387,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; <host>::SslForceVersion is corresponding per-host option. - 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 @@ -340,7 +426,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; do not support RFC2428. - cdrom + CDROM URIs; the only setting for CDROM URIs is the mount point, cdrom::Mount which must be the mount point for the CDROM drive as specified in /etc/fstab. It is possible to provide @@ -351,13 +437,13 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; commands can be specified using UMount. - gpgv + GPGV URIs; the only option for GPGV URIs is the option to pass additional parameters to gpgv. gpgv::Options Additional options passed to gpgv. - CompressionTypes + List of compression types which are understood by the acquire methods. Files like Packages can be available in various compression formats. Per default the acquire methods can decompress bzip2, lzma @@ -375,16 +461,50 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; It is not needed to add bz2 explicit to the list as it will be added automatic. Note that at run time 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 (the inbuilt) setting is Dir::Bin::bzip2 "/bin/bzip2"; + 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 in the configuration files you can set the option direct - not in list style. + over the ones specified in the configuration files you can set the option direct - not in list style. This will not override the defined list, it will only prefix the list with this type. - While it is possible to add an empty compression type to the order list, but APT in its current - version doesn't understand it correctly and will display many warnings about not downloaded files - - these warnings are most of the time false negatives. Future versions will maybe include a way to - really prefer uncompressed files to support the usage of local mirrors. + The special type uncompressed can be used to give uncompressed files a + preference, but note that most archives don't provide uncompressed files so this is mostly only + useable for local mirrors. + + + + When downloading gzip compressed indexes (Packages, Sources, or + Translations), keep them gzip compressed locally instead of unpacking + them. This saves quite a lot of disk space at the expense of more CPU + requirements when building the local package caches. False by default. + + + + + The Languages subsection controls which Translation files are downloaded + and in which order APT tries to display the Description-Translations. APT will try to display the first + available Description in the Language which is listed at first. Languages can be defined with their + short or long Languagecodes. Note that not all archives provide Translation + files for every Language - especially the long Languagecodes are rare, so please + inform you which ones are available before you set here impossible values. + The default list includes "environment" and "en". "environment" has a special meaning here: + It will be replaced at runtime with the languagecodes extracted from the LC_MESSAGES environment variable. + It will also ensure that these codes are not included twice in the list. If LC_MESSAGES + is set to "C" only the Translation-en file (if available) will be used. + To force apt to use no Translation file use the setting Acquire::Languages=none. "none" + is another special meaning code which will stop the search for a fitting Translation file. + This can be used by the system administrator to let APT know that it should download also this files without + actually use them if the environment doesn't specify this languages. So the following example configuration will + result in the order "en, de" in an english and in "de, en" in a german localization. Note that "fr" is downloaded, + but not used if APT is not used in a french localization, in such an environment the order would be "fr, de, en". + Acquire::Languages { "environment"; "de"; "en"; "none"; "fr"; }; + Note: To prevent problems resulting from APT being executed in different environments + (e.g. by different users or by other programs) all Translation files which are found in + /var/lib/apt/lists/ will be added to the end of the list + (after an implicit "none"). + + + @@ -394,7 +514,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; The Dir::State section has directories that pertain to local state information. lists is the directory to place downloaded package lists in and status is the name of the dpkg status file. - preferences is the name of the APT preferences file. + preferences is the name of the APT preferences file. Dir::State contains the default directory to prefix on all sub items if they do not start with / or ./. @@ -436,6 +556,15 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; will be looked up in /tmp/staging/var/lib/dpkg/status. + + + The Ignore-Files-Silently list can be used to specify + which files APT should silently ignore while parsing the files in the + fragment directories. Per default a file which end with .disabled, + ~, .bak or .dpkg-[a-z]+ + is silently ignored. As seen in the last default value these patterns can use regular + expression syntax. + APT in DSelect @@ -444,7 +573,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; control the default behaviour. These are in the DSelect section. - Clean + Cache Clean mode; this value may be one of always, prompt, auto, pre-auto and never. always and prompt will remove all packages from the cache after upgrading, prompt (the default) does so conditionally. @@ -453,17 +582,17 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; action before downloading new packages. - options + The contents of this variable is passed to &apt-get; as command line options when it is run for the install phase. - Updateoptions + The contents of this variable is passed to &apt-get; as command line options when it is run for the update phase. - PromptAfterUpdate + If true the [U]pdate operation in &dselect; will always prompt to continue. The default is to prompt only on error. @@ -475,20 +604,20 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; in the DPkg section. - options + This is a list of options to pass to dpkg. The options must be specified using the list notation and each list item is passed as a single argument to &dpkg;. - Pre-InvokePost-Invoke + This is a list of shell commands to run before/after invoking &dpkg;. Like options this must be specified in list notation. The commands are invoked in order using /bin/sh, should any fail APT will abort. - Pre-Install-Pkgs + This is a list of shell commands to run before invoking dpkg. Like options this must be specified in list notation. The commands are invoked in order using /bin/sh, should any fail APT @@ -502,12 +631,12 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; command given to Pre-Install-Pkgs. - Run-Directory + APT chdirs to this directory before invoking dpkg, the default is /. - Build-options + These options are passed to &dpkg-buildpackage; when compiling packages, the default is to disable signing and produce all binaries. @@ -515,7 +644,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; dpkg trigger usage (and related options) APT can call dpkg in a way so it can make aggressive use of triggers over - multiply calls of dpkg. Without further options dpkg will use triggers only in between his + multiple calls of dpkg. Without further options dpkg will use triggers only in between his own run. Activating these options can therefore decrease the time needed to perform the install / upgrade. Note that it is intended to activate these options per default in the future, but as it changes the way APT calling dpkg drastically it needs a lot more testing. @@ -535,7 +664,7 @@ DPkg::ConfigurePending "true"; DPkg::TriggersPending "true"; - DPkg::NoTriggers + 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. @@ -543,7 +672,7 @@ DPkg::TriggersPending "true"; meaning: Previously these option only append --no-triggers to the configure calls to dpkg - now apt will add these flag also to the unpack and remove calls. - PackageManager::Configure + Valid values are "all", "smart" and "no". "all" is the default value and causes APT to configure all packages explicit. The "smart" way is it to configure only packages which need to be configured before @@ -554,20 +683,20 @@ DPkg::TriggersPending "true"; default as otherwise the system could end in an unconfigured status which could be unbootable! - DPkg::ConfigurePending + If this option is set apt will call dpkg --configure --pending to let dpkg handle all required configurations and triggers. This option is activated automatic per default if the previous option is not set to all, but deactivating 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. - DPkg::TriggersPending + Useful for smart configuration as a package which has pending triggers is not considered as installed and dpkg treats them as unpacked currently which is a dealbreaker for Pre-Dependencies (see debbugs #526774). Note that this will process all triggers, not only the triggers needed to configure this package. - PackageManager::UnpackAll + As the configuration can be deferred to be done at the end by dpkg it can be tried to order the unpack series only by critical needs, e.g. by Pre-Depends. Default is true and therefore the "old" method of ordering in various steps by everything. While both method @@ -575,7 +704,7 @@ DPkg::TriggersPending "true"; this method is very experimental and needs further improvements before becoming really useful. - OrderList::Score::Immediate + Essential packages (and there dependencies) should be configured immediately after unpacking. It will be a good idea to do this quite early in the upgrade process as these these configure calls require currently also DPkg::TriggersPending which @@ -658,7 +787,7 @@ DPkg::TriggersPending "true"; - Debug::Acquire::cdrom + @@ -669,7 +798,7 @@ DPkg::TriggersPending "true"; - Debug::Acquire::ftp + @@ -680,7 +809,7 @@ DPkg::TriggersPending "true"; - Debug::Acquire::http + @@ -691,7 +820,7 @@ DPkg::TriggersPending "true"; - Debug::Acquire::https + @@ -702,7 +831,7 @@ DPkg::TriggersPending "true"; - Debug::Acquire::gpgv + @@ -713,7 +842,7 @@ DPkg::TriggersPending "true"; - Debug::aptcdrom + @@ -724,7 +853,7 @@ DPkg::TriggersPending "true"; - Debug::BuildDeps + Describes the process of resolving build-dependencies in @@ -734,7 +863,7 @@ DPkg::TriggersPending "true"; - Debug::Hashes + Output each cryptographic hash that is generated by the @@ -744,7 +873,7 @@ DPkg::TriggersPending "true"; - Debug::IdentCDROM + Do not include information from statfs, @@ -755,7 +884,7 @@ DPkg::TriggersPending "true"; - Debug::NoLocking + Disable all file locking. For instance, this will allow @@ -766,7 +895,7 @@ DPkg::TriggersPending "true"; - Debug::pkgAcquire + @@ -777,7 +906,7 @@ DPkg::TriggersPending "true"; - Debug::pkgAcquire::Auth + Output status messages and errors related to verifying @@ -787,7 +916,7 @@ DPkg::TriggersPending "true"; - Debug::pkgAcquire::Diffs + Output information about downloading and applying package @@ -798,7 +927,7 @@ DPkg::TriggersPending "true"; - Debug::pkgAcquire::RRed + @@ -809,7 +938,7 @@ DPkg::TriggersPending "true"; - Debug::pkgAcquire::Worker + @@ -820,7 +949,7 @@ DPkg::TriggersPending "true"; - Debug::pkgAutoRemove + @@ -831,7 +960,7 @@ DPkg::TriggersPending "true"; - Debug::pkgDepCache::AutoInstall + Generate debug messages describing which packages are being @@ -845,7 +974,7 @@ DPkg::TriggersPending "true"; - Debug::pkgDepCache::Marker + Generate debug messages describing which package is marked @@ -867,7 +996,7 @@ DPkg::TriggersPending "true"; - Debug::pkgInitConfig + Dump the default configuration to standard error on @@ -877,7 +1006,7 @@ DPkg::TriggersPending "true"; - Debug::pkgDPkgPM + When invoking &dpkg;, output the precise command line with @@ -888,7 +1017,7 @@ DPkg::TriggersPending "true"; - Debug::pkgDPkgProgressReporting + Output all the data received from &dpkg; on the status file @@ -898,7 +1027,7 @@ DPkg::TriggersPending "true"; - Debug::pkgOrderList + @@ -910,7 +1039,7 @@ DPkg::TriggersPending "true"; - Debug::pkgPackageManager + @@ -921,7 +1050,7 @@ DPkg::TriggersPending "true"; - Debug::pkgPolicy + @@ -931,7 +1060,7 @@ DPkg::TriggersPending "true"; - Debug::pkgProblemResolver + @@ -943,7 +1072,7 @@ DPkg::TriggersPending "true"; - Debug::pkgProblemResolver::ShowScores + Display a list of all installed packages with their calculated score @@ -954,7 +1083,7 @@ DPkg::TriggersPending "true"; - Debug::sourceList + @@ -976,6 +1105,7 @@ is commented. --> +