You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

1058 lines
49 KiB

  1. <?xml version="1.0" encoding="utf-8" standalone="no"?>
  2. <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  3. "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
  4. <!ENTITY % aptent SYSTEM "apt.ent">
  5. %aptent;
  6. ]>
  7. <refentry>
  8. <refentryinfo>
  9. &apt-author.jgunthorpe;
  10. &apt-author.team;
  11. <author>
  12. <firstname>Daniel</firstname>
  13. <surname>Burrows</surname>
  14. <contrib>Initial documentation of Debug::*.</contrib>
  15. <email>dburrows@debian.org</email>
  16. </author>
  17. &apt-email;
  18. &apt-product;
  19. <!-- The last update date -->
  20. <date>16 January 2010</date>
  21. </refentryinfo>
  22. <refmeta>
  23. <refentrytitle>apt.conf</refentrytitle>
  24. <manvolnum>5</manvolnum>
  25. <refmiscinfo class="manual">APT</refmiscinfo>
  26. </refmeta>
  27. <!-- Man page title -->
  28. <refnamediv>
  29. <refname>apt.conf</refname>
  30. <refpurpose>Configuration file for APT</refpurpose>
  31. </refnamediv>
  32. <refsect1><title>Description</title>
  33. <para><filename>apt.conf</filename> is the main configuration file for
  34. the APT suite of tools, but by far not the only place changes to options
  35. can be made. All tools therefore share the configuration files and also
  36. use a common command line parser to provide a uniform environment.</para>
  37. <orderedlist>
  38. <para>When an APT tool starts up it will read the configuration files
  39. in the following order:</para>
  40. <listitem><para>the file specified by the <envar>APT_CONFIG</envar>
  41. environment variable (if any)</para></listitem>
  42. <listitem><para>all files in <literal>Dir::Etc::Parts</literal> in
  43. alphanumeric ascending order which have no or "<literal>conf</literal>"
  44. as filename extension and which only contain alphanumeric,
  45. hyphen (-), underscore (_) and period (.) characters -
  46. otherwise they will be silently ignored.</para></listitem>
  47. <listitem><para>the main configuration file specified by
  48. <literal>Dir::Etc::main</literal></para></listitem>
  49. <listitem><para>the command line options are applied to override the
  50. configuration directives or to load even more configuration files.</para></listitem>
  51. </orderedlist>
  52. </refsect1>
  53. <refsect1><title>Syntax</title>
  54. <para>The configuration file is organized in a tree with options organized into
  55. functional groups. Option specification is given with a double colon
  56. notation, for instance <literal>APT::Get::Assume-Yes</literal> is an option within
  57. the APT tool group, for the Get tool. Options do not inherit from their
  58. parent groups.</para>
  59. <para>Syntactically the configuration language is modeled after what the ISC tools
  60. such as bind and dhcp use. Lines starting with
  61. <literal>//</literal> are treated as comments (ignored), as well as all text
  62. between <literal>/*</literal> and <literal>*/</literal>, just like C/C++ comments.
  63. Each line is of the form
  64. <literal>APT::Get::Assume-Yes "true";</literal>. The trailing
  65. semicolon and the quotes are required. The value must be on one line, and
  66. there is no kind of string concatenation. It must not include inside quotes.
  67. The behavior of the backslash "\" and escaped characters inside a value is
  68. undefined and it should not be used. An option name may include
  69. alphanumerical characters and the "/-:._+" characters. A new scope can
  70. be opened with curly braces, like:</para>
  71. <informalexample><programlisting>
  72. APT {
  73. Get {
  74. Assume-Yes "true";
  75. Fix-Broken "true";
  76. };
  77. };
  78. </programlisting></informalexample>
  79. <para>with newlines placed to make it more readable. Lists can be created by
  80. opening a scope and including a single string enclosed in quotes followed by a
  81. semicolon. Multiple entries can be included, each separated by a semicolon.</para>
  82. <informalexample><programlisting>
  83. DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
  84. </programlisting></informalexample>
  85. <para>In general the sample configuration file in
  86. <filename>&docdir;examples/apt.conf</filename> &configureindex;
  87. is a good guide for how it should look.</para>
  88. <para>The names of the configuration items are not case-sensitive. So in the previous example
  89. you could use <literal>dpkg::pre-install-pkgs</literal>.</para>
  90. <para>Names for the configuration items are optional if a list is defined as it can be see in
  91. the <literal>DPkg::Pre-Install-Pkgs</literal> example above. If you don't specify a name a
  92. new entry will simply add a new option to the list. If you specify a name you can override
  93. the option as every other option by reassigning a new value to the option.</para>
  94. <para>Two specials are allowed, <literal>#include</literal> (which is deprecated
  95. and not supported by alternative implementations) and <literal>#clear</literal>:
  96. <literal>#include</literal> will include the given file, unless the filename
  97. ends in a slash, then the whole directory is included.
  98. <literal>#clear</literal> is used to erase a part of the configuration tree. The
  99. specified element and all its descendants are erased.
  100. (Note that these lines also need to end with a semicolon.)</para>
  101. <para>The #clear command is the only way to delete a list or a complete scope.
  102. Reopening a scope or the ::-style described below will <emphasis>not</emphasis>
  103. override previously written entries. Only options can be overridden by addressing a new
  104. value to it - lists and scopes can't be overridden, only cleared.</para>
  105. <para>All of the APT tools take a -o option which allows an arbitrary configuration
  106. directive to be specified on the command line. The syntax is a full option
  107. name (<literal>APT::Get::Assume-Yes</literal> for instance) followed by an equals
  108. sign then the new value of the option. Lists can be appended too by adding
  109. a trailing :: to the list name. (As you might suspect: The scope syntax can't be used
  110. on the command line.)</para>
  111. <para>Note that you can use :: only for appending one item per line to a list and
  112. that you should not use it in combination with the scope syntax.
  113. (The scope syntax implicit insert ::) Using both syntaxes together will trigger a bug
  114. which some users unfortunately relay on: An option with the unusual name "<literal>::</literal>"
  115. which acts like every other option with a name. These introduces many problems
  116. including that a user who writes multiple lines in this <emphasis>wrong</emphasis> syntax in
  117. the hope to append to a list will gain the opposite as only the last assignment for this option
  118. "<literal>::</literal>" will be used. Upcoming APT versions will raise errors and
  119. will stop working if they encounter this misuse, so please correct such statements now
  120. as long as APT doesn't complain explicit about them.</para>
  121. </refsect1>
  122. <refsect1><title>The APT Group</title>
  123. <para>This group of options controls general APT behavior as well as holding the
  124. options for all of the tools.</para>
  125. <variablelist>
  126. <varlistentry><term>Architecture</term>
  127. <listitem><para>System Architecture; sets the architecture to use when fetching files and
  128. parsing package lists. The internal default is the architecture apt was
  129. compiled for.</para></listitem>
  130. </varlistentry>
  131. <varlistentry><term>Default-Release</term>
  132. <listitem><para>Default release to install packages from if more than one
  133. version available. Contains release name, codename or release version. Examples: 'stable', 'testing', 'unstable', 'lenny', 'squeeze', '4.0', '5.0*'. See also &apt-preferences;.</para></listitem>
  134. </varlistentry>
  135. <varlistentry><term>Ignore-Hold</term>
  136. <listitem><para>Ignore Held packages; This global option causes the problem resolver to
  137. ignore held packages in its decision making.</para></listitem>
  138. </varlistentry>
  139. <varlistentry><term>Clean-Installed</term>
  140. <listitem><para>Defaults to on. When turned on the autoclean feature will remove any packages
  141. which can no longer be downloaded from the cache. If turned off then
  142. packages that are locally installed are also excluded from cleaning - but
  143. note that APT provides no direct means to reinstall them.</para></listitem>
  144. </varlistentry>
  145. <varlistentry><term>Immediate-Configure</term>
  146. <listitem><para>Defaults to on which will cause APT to install essential and important packages
  147. as fast as possible in the install/upgrade operation. This is done to limit the effect of a failing
  148. &dpkg; call: If this option is disabled APT does treat an important package in the same way as
  149. an extra package: Between the unpacking of the important package A and his configuration can then
  150. be many other unpack or configuration calls, e.g. for package B which has no relation to A, but
  151. causes the dpkg call to fail (e.g. because maintainer script of package B generates an error) which results
  152. in a system state in which package A is unpacked but unconfigured - each package depending on A is now no
  153. longer guaranteed to work as their dependency on A is not longer satisfied. The immediate configuration marker
  154. is also applied to all dependencies which can generate a problem if the dependencies e.g. form a circle
  155. as a dependency with the immediate flag is comparable with a Pre-Dependency. So in theory it is possible
  156. that APT encounters a situation in which it is unable to perform immediate configuration, errors out and
  157. refers to this option so the user can deactivate the immediate configuration temporarily to be able to perform
  158. an install/upgrade again. Note the use of the word "theory" here as this problem was only encountered by now
  159. in real world a few times in non-stable distribution versions and was caused by wrong dependencies of the package
  160. in question or by a system in an already broken state, so you should not blindly disable this option as
  161. the mentioned scenario above is not the only problem immediate configuration can help to prevent in the first place.
  162. Before a big operation like <literal>dist-upgrade</literal> is run with this option disabled it should be tried to
  163. explicitly <literal>install</literal> the package APT is unable to configure immediately, but please make sure to
  164. report your problem also to your distribution and to the APT team with the buglink below so they can work on
  165. improving or correcting the upgrade process.</para></listitem>
  166. </varlistentry>
  167. <varlistentry><term>Force-LoopBreak</term>
  168. <listitem><para>Never Enable this option unless you -really- know what you are doing. It
  169. permits APT to temporarily remove an essential package to break a
  170. Conflicts/Conflicts or Conflicts/Pre-Depend loop between two essential
  171. packages. SUCH A LOOP SHOULD NEVER EXIST AND IS A GRAVE BUG. This option
  172. will work if the essential packages are not tar, gzip, libc, dpkg, bash or
  173. anything that those packages depend on.</para></listitem>
  174. </varlistentry>
  175. <varlistentry><term>Cache-Limit</term>
  176. <listitem><para>APT uses a fixed size memory mapped cache file to store the 'available'
  177. information. This sets the size of that cache (in bytes).</para></listitem>
  178. </varlistentry>
  179. <varlistentry><term>Build-Essential</term>
  180. <listitem><para>Defines which package(s) are considered essential build dependencies.</para></listitem>
  181. </varlistentry>
  182. <varlistentry><term>Get</term>
  183. <listitem><para>The Get subsection controls the &apt-get; tool, please see its
  184. documentation for more information about the options here.</para></listitem>
  185. </varlistentry>
  186. <varlistentry><term>Cache</term>
  187. <listitem><para>The Cache subsection controls the &apt-cache; tool, please see its
  188. documentation for more information about the options here.</para></listitem>
  189. </varlistentry>
  190. <varlistentry><term>CDROM</term>
  191. <listitem><para>The CDROM subsection controls the &apt-cdrom; tool, please see its
  192. documentation for more information about the options here.</para></listitem>
  193. </varlistentry>
  194. </variablelist>
  195. </refsect1>
  196. <refsect1><title>The Acquire Group</title>
  197. <para>The <literal>Acquire</literal> group of options controls the download of packages
  198. and the URI handlers.
  199. <variablelist>
  200. <varlistentry><term>PDiffs</term>
  201. <listitem><para>Try to download deltas called <literal>PDiffs</literal> for
  202. Packages or Sources files instead of downloading whole ones. True
  203. by default.</para>
  204. <para>Two sub-options to limit the use of PDiffs are also available:
  205. With <literal>FileLimit</literal> can be specified how many PDiff files
  206. are downloaded at most to patch a file. <literal>SizeLimit</literal>
  207. on the other hand is the maximum precentage of the size of all patches
  208. compared to the size of the targeted file. If one of these limits is
  209. exceeded the complete file is downloaded instead of the patches.
  210. </para></listitem>
  211. </varlistentry>
  212. <varlistentry><term>Queue-Mode</term>
  213. <listitem><para>Queuing mode; <literal>Queue-Mode</literal> can be one of <literal>host</literal> or
  214. <literal>access</literal> which determines how APT parallelizes outgoing
  215. connections. <literal>host</literal> means that one connection per target host
  216. will be opened, <literal>access</literal> means that one connection per URI type
  217. will be opened.</para></listitem>
  218. </varlistentry>
  219. <varlistentry><term>Retries</term>
  220. <listitem><para>Number of retries to perform. If this is non-zero APT will retry failed
  221. files the given number of times.</para></listitem>
  222. </varlistentry>
  223. <varlistentry><term>Source-Symlinks</term>
  224. <listitem><para>Use symlinks for source archives. If set to true then source archives will
  225. be symlinked when possible instead of copying. True is the default.</para></listitem>
  226. </varlistentry>
  227. <varlistentry><term>http</term>
  228. <listitem><para>HTTP URIs; http::Proxy is the default http proxy to use. It is in the
  229. standard form of <literal>http://[[user][:pass]@]host[:port]/</literal>. Per
  230. host proxies can also be specified by using the form
  231. <literal>http::Proxy::&lt;host&gt;</literal> with the special keyword <literal>DIRECT</literal>
  232. meaning to use no proxies. If no one of the above settings is specified,
  233. <envar>http_proxy</envar> environment variable
  234. will be used.</para>
  235. <para>Three settings are provided for cache control with HTTP/1.1 compliant
  236. proxy caches. <literal>No-Cache</literal> tells the proxy to not use its cached
  237. response under any circumstances, <literal>Max-Age</literal> is sent only for
  238. index files and tells the cache to refresh its object if it is older than
  239. the given number of seconds. Debian updates its index files daily so the
  240. default is 1 day. <literal>No-Store</literal> specifies that the cache should never
  241. store this request, it is only set for archive files. This may be useful
  242. to prevent polluting a proxy cache with very large .deb files. Note:
  243. Squid 2.0.2 does not support any of these options.</para>
  244. <para>The option <literal>timeout</literal> sets the timeout timer used by the method,
  245. this applies to all things including connection timeout and data timeout.</para>
  246. <para>One setting is provided to control the pipeline depth in cases where the
  247. remote server is not RFC conforming or buggy (such as Squid 2.0.2).
  248. <literal>Acquire::http::Pipeline-Depth</literal> can be a value from 0 to 5
  249. indicating how many outstanding requests APT should send. A value of
  250. zero MUST be specified if the remote host does not properly linger
  251. on TCP connections - otherwise data corruption will occur. Hosts which
  252. require this are in violation of RFC 2068.</para>
  253. <para>The used bandwidth can be limited with <literal>Acquire::http::Dl-Limit</literal>
  254. which accepts integer values in kilobyte. The default value is 0 which deactivates
  255. the limit and tries uses as much as possible of the bandwidth (Note that this option implicit
  256. deactivates the download from multiple servers at the same time.)</para>
  257. <para><literal>Acquire::http::User-Agent</literal> can be used to set a different
  258. User-Agent for the http download method as some proxies allow access for clients
  259. only if the client uses a known identifier.</para>
  260. </listitem>
  261. </varlistentry>
  262. <varlistentry><term>https</term>
  263. <listitem><para>HTTPS URIs. Cache-control, Timeout, AllowRedirect, Dl-Limit and
  264. proxy options are the same as for <literal>http</literal> method and will also
  265. default to the options from the <literal>http</literal> method if they are not
  266. explicitly set for https. <literal>Pipeline-Depth</literal> option is not
  267. supported yet.</para>
  268. <para><literal>CaInfo</literal> suboption specifies place of file that
  269. holds info about trusted certificates.
  270. <literal>&lt;host&gt;::CaInfo</literal> is corresponding per-host option.
  271. <literal>Verify-Peer</literal> boolean suboption determines whether verify
  272. server's host certificate against trusted certificates or not.
  273. <literal>&lt;host&gt;::Verify-Peer</literal> is corresponding per-host option.
  274. <literal>Verify-Host</literal> boolean suboption determines whether verify
  275. server's hostname or not.
  276. <literal>&lt;host&gt;::Verify-Host</literal> is corresponding per-host option.
  277. <literal>SslCert</literal> determines what certificate to use for client
  278. authentication. <literal>&lt;host&gt;::SslCert</literal> is corresponding per-host option.
  279. <literal>SslKey</literal> determines what private key to use for client
  280. authentication. <literal>&lt;host&gt;::SslKey</literal> is corresponding per-host option.
  281. <literal>SslForceVersion</literal> overrides default SSL version to use.
  282. Can contain 'TLSv1' or 'SSLv3' string.
  283. <literal>&lt;host&gt;::SslForceVersion</literal> is corresponding per-host option.
  284. </para></listitem></varlistentry>
  285. <varlistentry><term>ftp</term>
  286. <listitem><para>FTP URIs; ftp::Proxy is the default ftp proxy to use. It is in the
  287. standard form of <literal>ftp://[[user][:pass]@]host[:port]/</literal>. Per
  288. host proxies can also be specified by using the form
  289. <literal>ftp::Proxy::&lt;host&gt;</literal> with the special keyword <literal>DIRECT</literal>
  290. meaning to use no proxies. If no one of the above settings is specified,
  291. <envar>ftp_proxy</envar> environment variable
  292. will be used. To use a ftp
  293. proxy you will have to set the <literal>ftp::ProxyLogin</literal> script in the
  294. configuration file. This entry specifies the commands to send to tell
  295. the proxy server what to connect to. Please see
  296. &configureindex; for an example of
  297. how to do this. The substitution variables available are
  298. <literal>$(PROXY_USER)</literal> <literal>$(PROXY_PASS)</literal> <literal>$(SITE_USER)</literal>
  299. <literal>$(SITE_PASS)</literal> <literal>$(SITE)</literal> and <literal>$(SITE_PORT)</literal>
  300. Each is taken from it's respective URI component.</para>
  301. <para>The option <literal>timeout</literal> sets the timeout timer used by the method,
  302. this applies to all things including connection timeout and data timeout.</para>
  303. <para>Several settings are provided to control passive mode. Generally it is
  304. safe to leave passive mode on, it works in nearly every environment.
  305. However some situations require that passive mode be disabled and port
  306. mode ftp used instead. This can be done globally, for connections that
  307. go through a proxy or for a specific host (See the sample config file
  308. for examples).</para>
  309. <para>It is possible to proxy FTP over HTTP by setting the <envar>ftp_proxy</envar>
  310. environment variable to a http url - see the discussion of the http method
  311. above for syntax. You cannot set this in the configuration file and it is
  312. not recommended to use FTP over HTTP due to its low efficiency.</para>
  313. <para>The setting <literal>ForceExtended</literal> controls the use of RFC2428
  314. <literal>EPSV</literal> and <literal>EPRT</literal> commands. The default is false, which means
  315. these commands are only used if the control connection is IPv6. Setting this
  316. to true forces their use even on IPv4 connections. Note that most FTP servers
  317. do not support RFC2428.</para></listitem>
  318. </varlistentry>
  319. <varlistentry><term>cdrom</term>
  320. <listitem><para>CDROM URIs; the only setting for CDROM URIs is the mount point,
  321. <literal>cdrom::Mount</literal> which must be the mount point for the CDROM drive
  322. as specified in <filename>/etc/fstab</filename>. It is possible to provide
  323. alternate mount and unmount commands if your mount point cannot be listed
  324. in the fstab (such as an SMB mount and old mount packages). The syntax
  325. is to put <literallayout>/cdrom/::Mount "foo";</literallayout> within
  326. the cdrom block. It is important to have the trailing slash. Unmount
  327. commands can be specified using UMount.</para></listitem>
  328. </varlistentry>
  329. <varlistentry><term>gpgv</term>
  330. <listitem><para>GPGV URIs; the only option for GPGV URIs is the option to pass additional parameters to gpgv.
  331. <literal>gpgv::Options</literal> Additional options passed to gpgv.
  332. </para></listitem>
  333. </varlistentry>
  334. <varlistentry><term>CompressionTypes</term>
  335. <listitem><para>List of compression types which are understood by the acquire methods.
  336. Files like <filename>Packages</filename> can be available in various compression formats.
  337. Per default the acquire methods can decompress <command>bzip2</command>, <command>lzma</command>
  338. and <command>gzip</command> compressed files, with this setting more formats can be added
  339. on the fly or the used method can be changed. The syntax for this is:
  340. <synopsis>Acquire::CompressionTypes::<replaceable>FileExtension</replaceable> "<replaceable>Methodname</replaceable>";</synopsis>
  341. </para><para>Also the <literal>Order</literal> subgroup can be used to define in which order
  342. the acquire system will try to download the compressed files. The acquire system will try the first
  343. and proceed with the next compression type in this list on error, so to prefer one over the other type
  344. simple add the preferred type at first - not already added default types will be added at run time
  345. to the end of the list, so e.g. <synopsis>Acquire::CompressionTypes::Order:: "gz";</synopsis> can
  346. be used to prefer <command>gzip</command> compressed files over <command>bzip2</command> and <command>lzma</command>.
  347. If <command>lzma</command> should be preferred over <command>gzip</command> and <command>bzip2</command> the
  348. configure setting should look like this <synopsis>Acquire::CompressionTypes::Order { "lzma"; "gz"; };</synopsis>
  349. It is not needed to add <literal>bz2</literal> explicit to the list as it will be added automatic.</para>
  350. <para>Note that at run time the <literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will
  351. be checked: If this setting exists the method will only be used if this file exists, e.g. for
  352. the bzip2 method (the inbuilt) setting is <literallayout>Dir::Bin::bzip2 "/bin/bzip2";</literallayout>
  353. Note also that list entries specified on the command line will be added at the end of the list
  354. specified in the configuration files, but before the default entries. To prefer a type in this case
  355. over the ones specified in in the configuration files you can set the option direct - not in list style.
  356. This will not override the defined list, it will only prefix the list with this type.</para>
  357. <para>While it is possible to add an empty compression type to the order list, but APT in its current
  358. version doesn't understand it correctly and will display many warnings about not downloaded files -
  359. these warnings are most of the time false negatives. Future versions will maybe include a way to
  360. really prefer uncompressed files to support the usage of local mirrors.</para></listitem>
  361. </varlistentry>
  362. <varlistentry><term>GzipIndexes</term>
  363. <listitem><para>
  364. When downloading <literal>gzip</literal> compressed indexes (Packages, Sources, or
  365. Translations), keep them gzip compressed locally instead of unpacking
  366. them. This saves quite a lot of disk space at the expense of more CPU
  367. requirements when building the local package caches. False by default.
  368. </para></listitem>
  369. </varlistentry>
  370. <varlistentry><term>Languages</term>
  371. <listitem><para>The Languages subsection controls which <filename>Translation</filename> files are downloaded
  372. and in which order APT tries to display the Description-Translations. APT will try to display the first
  373. available Description in the Language which is listed at first. Languages can be defined with their
  374. short or long Languagecodes. Note that not all archives provide <filename>Translation</filename>
  375. files for every Language - especially the long Languagecodes are rare, so please
  376. inform you which ones are available before you set here impossible values.</para>
  377. <para>The default list includes "environment" and "en". "<literal>environment</literal>" has a special meaning here:
  378. It will be replaced at runtime with the languagecodes extracted from the <literal>LC_MESSAGES</literal> environment variable.
  379. It will also ensure that these codes are not included twice in the list. If <literal>LC_MESSAGES</literal>
  380. is set to "C" only the <filename>Translation-en</filename> file (if available) will be used.
  381. To force apt to use no Translation file use the setting <literal>Acquire::Languages=none</literal>. "<literal>none</literal>"
  382. is another special meaning code which will stop the search for a fitting <filename>Translation</filename> file.
  383. This can be used by the system administrator to let APT know that it should download also this files without
  384. actually use them if the environment doesn't specify this languages. So the following example configuration will
  385. result in the order "en, de" in an english and in "de, en" in a german localization. Note that "fr" is downloaded,
  386. but not used if APT is not used in a french localization, in such an environment the order would be "fr, de, en".
  387. <programlisting>Acquire::Languages { "environment"; "de"; "en"; "none"; "fr"; };</programlisting></para></listitem>
  388. </varlistentry>
  389. </variablelist>
  390. </para>
  391. </refsect1>
  392. <refsect1><title>Directories</title>
  393. <para>The <literal>Dir::State</literal> section has directories that pertain to local
  394. state information. <literal>lists</literal> is the directory to place downloaded
  395. package lists in and <literal>status</literal> is the name of the dpkg status file.
  396. <literal>preferences</literal> is the name of the APT preferences file.
  397. <literal>Dir::State</literal> contains the default directory to prefix on all sub
  398. items if they do not start with <filename>/</filename> or <filename>./</filename>.</para>
  399. <para><literal>Dir::Cache</literal> contains locations pertaining to local cache
  400. information, such as the two package caches <literal>srcpkgcache</literal> and
  401. <literal>pkgcache</literal> as well as the location to place downloaded archives,
  402. <literal>Dir::Cache::archives</literal>. Generation of caches can be turned off
  403. by setting their names to be blank. This will slow down startup but
  404. save disk space. It is probably preferred to turn off the pkgcache rather
  405. than the srcpkgcache. Like <literal>Dir::State</literal> the default
  406. directory is contained in <literal>Dir::Cache</literal></para>
  407. <para><literal>Dir::Etc</literal> contains the location of configuration files,
  408. <literal>sourcelist</literal> gives the location of the sourcelist and
  409. <literal>main</literal> is the default configuration file (setting has no effect,
  410. unless it is done from the config file specified by
  411. <envar>APT_CONFIG</envar>).</para>
  412. <para>The <literal>Dir::Parts</literal> setting reads in all the config fragments in
  413. lexical order from the directory specified. After this is done then the
  414. main config file is loaded.</para>
  415. <para>Binary programs are pointed to by <literal>Dir::Bin</literal>. <literal>Dir::Bin::Methods</literal>
  416. specifies the location of the method handlers and <literal>gzip</literal>,
  417. <literal>bzip2</literal>, <literal>lzma</literal>,
  418. <literal>dpkg</literal>, <literal>apt-get</literal> <literal>dpkg-source</literal>
  419. <literal>dpkg-buildpackage</literal> and <literal>apt-cache</literal> specify the location
  420. of the respective programs.</para>
  421. <para>
  422. The configuration item <literal>RootDir</literal> has a special
  423. meaning. If set, all paths in <literal>Dir::</literal> will be
  424. relative to <literal>RootDir</literal>, <emphasis>even paths that
  425. are specified absolutely</emphasis>. So, for instance, if
  426. <literal>RootDir</literal> is set to
  427. <filename>/tmp/staging</filename> and
  428. <literal>Dir::State::status</literal> is set to
  429. <filename>/var/lib/dpkg/status</filename>, then the status file
  430. will be looked up in
  431. <filename>/tmp/staging/var/lib/dpkg/status</filename>.
  432. </para>
  433. </refsect1>
  434. <refsect1><title>APT in DSelect</title>
  435. <para>
  436. When APT is used as a &dselect; method several configuration directives
  437. control the default behaviour. These are in the <literal>DSelect</literal> section.</para>
  438. <variablelist>
  439. <varlistentry><term>Clean</term>
  440. <listitem><para>Cache Clean mode; this value may be one of always, prompt, auto,
  441. pre-auto and never. always and prompt will remove all packages from
  442. the cache after upgrading, prompt (the default) does so conditionally.
  443. auto removes only those packages which are no longer downloadable
  444. (replaced with a new version for instance). pre-auto performs this
  445. action before downloading new packages.</para></listitem>
  446. </varlistentry>
  447. <varlistentry><term>options</term>
  448. <listitem><para>The contents of this variable is passed to &apt-get; as command line
  449. options when it is run for the install phase.</para></listitem>
  450. </varlistentry>
  451. <varlistentry><term>Updateoptions</term>
  452. <listitem><para>The contents of this variable is passed to &apt-get; as command line
  453. options when it is run for the update phase.</para></listitem>
  454. </varlistentry>
  455. <varlistentry><term>PromptAfterUpdate</term>
  456. <listitem><para>If true the [U]pdate operation in &dselect; will always prompt to continue.
  457. The default is to prompt only on error.</para></listitem>
  458. </varlistentry>
  459. </variablelist>
  460. </refsect1>
  461. <refsect1><title>How APT calls dpkg</title>
  462. <para>Several configuration directives control how APT invokes &dpkg;. These are
  463. in the <literal>DPkg</literal> section.</para>
  464. <variablelist>
  465. <varlistentry><term>options</term>
  466. <listitem><para>This is a list of options to pass to dpkg. The options must be specified
  467. using the list notation and each list item is passed as a single argument
  468. to &dpkg;.</para></listitem>
  469. </varlistentry>
  470. <varlistentry><term>Pre-Invoke</term><term>Post-Invoke</term>
  471. <listitem><para>This is a list of shell commands to run before/after invoking &dpkg;.
  472. Like <literal>options</literal> this must be specified in list notation. The
  473. commands are invoked in order using <filename>/bin/sh</filename>, should any
  474. fail APT will abort.</para></listitem>
  475. </varlistentry>
  476. <varlistentry><term>Pre-Install-Pkgs</term>
  477. <listitem><para>This is a list of shell commands to run before invoking dpkg. Like
  478. <literal>options</literal> this must be specified in list notation. The commands
  479. are invoked in order using <filename>/bin/sh</filename>, should any fail APT
  480. will abort. APT will pass to the commands on standard input the
  481. filenames of all .deb files it is going to install, one per line.</para>
  482. <para>Version 2 of this protocol dumps more information, including the
  483. protocol version, the APT configuration space and the packages, files
  484. and versions being changed. Version 2 is enabled by setting
  485. <literal>DPkg::Tools::options::cmd::Version</literal> to 2. <literal>cmd</literal> is a
  486. command given to <literal>Pre-Install-Pkgs</literal>.</para></listitem>
  487. </varlistentry>
  488. <varlistentry><term>Run-Directory</term>
  489. <listitem><para>APT chdirs to this directory before invoking dpkg, the default is
  490. <filename>/</filename>.</para></listitem>
  491. </varlistentry>
  492. <varlistentry><term>Build-options</term>
  493. <listitem><para>These options are passed to &dpkg-buildpackage; when compiling packages,
  494. the default is to disable signing and produce all binaries.</para></listitem>
  495. </varlistentry>
  496. </variablelist>
  497. <refsect2><title>dpkg trigger usage (and related options)</title>
  498. <para>APT can call dpkg in a way so it can make aggressive use of triggers over
  499. multiply calls of dpkg. Without further options dpkg will use triggers only in between his
  500. own run. Activating these options can therefore decrease the time needed to perform the
  501. install / upgrade. Note that it is intended to activate these options per default in the
  502. future, but as it changes the way APT calling dpkg drastically it needs a lot more testing.
  503. <emphasis>These options are therefore currently experimental and should not be used in
  504. productive environments.</emphasis> Also it breaks the progress reporting so all frontends will
  505. currently stay around half (or more) of the time in the 100% state while it actually configures
  506. all packages.</para>
  507. <para>Note that it is not guaranteed that APT will support these options or that these options will
  508. not cause (big) trouble in the future. If you have understand the current risks and problems with
  509. these options, but are brave enough to help testing them create a new configuration file and test a
  510. combination of options. Please report any bugs, problems and improvements you encounter and make sure
  511. to note which options you have used in your reports. Asking dpkg for help could also be useful for
  512. debugging proposes, see e.g. <command>dpkg --audit</command>. A defensive option combination would be
  513. <literallayout>DPkg::NoTriggers "true";
  514. PackageManager::Configure "smart";
  515. DPkg::ConfigurePending "true";
  516. DPkg::TriggersPending "true";</literallayout></para>
  517. <variablelist>
  518. <varlistentry><term>DPkg::NoTriggers</term>
  519. <listitem><para>Add the no triggers flag to all dpkg calls (except the ConfigurePending call).
  520. See &dpkg; if you are interested in what this actually means. In short: dpkg will not run the
  521. triggers when this flag is present unless it is explicitly called to do so in an extra call.
  522. Note that this option exists (undocumented) also in older apt versions with a slightly different
  523. meaning: Previously these option only append --no-triggers to the configure calls to dpkg -
  524. now apt will add these flag also to the unpack and remove calls.</para></listitem>
  525. </varlistentry>
  526. <varlistentry><term>PackageManager::Configure</term>
  527. <listitem><para>Valid values are "<literal>all</literal>", "<literal>smart</literal>" and "<literal>no</literal>".
  528. "<literal>all</literal>" is the default value and causes APT to configure all packages explicit.
  529. The "<literal>smart</literal>" way is it to configure only packages which need to be configured before
  530. another package can be unpacked (Pre-Depends) and let the rest configure by dpkg with a call generated
  531. by the next option. "<literal>no</literal>" on the other hand will not configure anything and totally
  532. rely on dpkg for configuration (which will at the moment fail if a Pre-Depends is encountered).
  533. Setting this option to another than the all value will implicitly activate also the next option per
  534. default as otherwise the system could end in an unconfigured status which could be unbootable!
  535. </para></listitem>
  536. </varlistentry>
  537. <varlistentry><term>DPkg::ConfigurePending</term>
  538. <listitem><para>If this option is set apt will call <command>dpkg --configure --pending</command>
  539. to let dpkg handle all required configurations and triggers. This option is activated automatic
  540. per default if the previous option is not set to <literal>all</literal>, but deactivating could be useful
  541. if you want to run APT multiple times in a row - e.g. in an installer. In these sceneries you could
  542. deactivate this option in all but the last run.</para></listitem>
  543. </varlistentry>
  544. <varlistentry><term>DPkg::TriggersPending</term>
  545. <listitem><para>Useful for <literal>smart</literal> configuration as a package which has pending
  546. triggers is not considered as <literal>installed</literal> and dpkg treats them as <literal>unpacked</literal>
  547. currently which is a dealbreaker for Pre-Dependencies (see debbugs #526774). Note that this will
  548. process all triggers, not only the triggers needed to configure this package.</para></listitem>
  549. </varlistentry>
  550. <varlistentry><term>PackageManager::UnpackAll</term>
  551. <listitem><para>As the configuration can be deferred to be done at the end by dpkg it can be
  552. tried to order the unpack series only by critical needs, e.g. by Pre-Depends. Default is true
  553. and therefore the "old" method of ordering in various steps by everything. While both method
  554. were present in earlier APT versions the <literal>OrderCritical</literal> method was unused, so
  555. this method is very experimental and needs further improvements before becoming really useful.
  556. </para></listitem>
  557. </varlistentry>
  558. <varlistentry><term>OrderList::Score::Immediate</term>
  559. <listitem><para>Essential packages (and there dependencies) should be configured immediately
  560. after unpacking. It will be a good idea to do this quite early in the upgrade process as these
  561. these configure calls require currently also <literal>DPkg::TriggersPending</literal> which
  562. will run quite a few triggers (which maybe not needed). Essentials get per default a high score
  563. but the immediate flag is relatively low (a package which has a Pre-Depends is higher rated).
  564. These option and the others in the same group can be used to change the scoring. The following
  565. example shows the settings with there default values.
  566. <literallayout>OrderList::Score {
  567. Delete 500;
  568. Essential 200;
  569. Immediate 10;
  570. PreDepends 50;
  571. };</literallayout>
  572. </para></listitem>
  573. </varlistentry>
  574. </variablelist>
  575. </refsect2>
  576. </refsect1>
  577. <refsect1>
  578. <title>Periodic and Archives options</title>
  579. <para><literal>APT::Periodic</literal> and <literal>APT::Archives</literal>
  580. groups of options configure behavior of apt periodic updates, which is
  581. done by <literal>/etc/cron.daily/apt</literal> script. See header of
  582. this script for the brief documentation of these options.
  583. </para>
  584. </refsect1>
  585. <refsect1>
  586. <title>Debug options</title>
  587. <para>
  588. Enabling options in the <literal>Debug::</literal> section will
  589. cause debugging information to be sent to the standard error
  590. stream of the program utilizing the <literal>apt</literal>
  591. libraries, or enable special program modes that are primarily
  592. useful for debugging the behavior of <literal>apt</literal>.
  593. Most of these options are not interesting to a normal user, but a
  594. few may be:
  595. <itemizedlist>
  596. <listitem>
  597. <para>
  598. <literal>Debug::pkgProblemResolver</literal> enables output
  599. about the decisions made by
  600. <literal>dist-upgrade, upgrade, install, remove, purge</literal>.
  601. </para>
  602. </listitem>
  603. <listitem>
  604. <para>
  605. <literal>Debug::NoLocking</literal> disables all file
  606. locking. This can be used to run some operations (for
  607. instance, <literal>apt-get -s install</literal>) as a
  608. non-root user.
  609. </para>
  610. </listitem>
  611. <listitem>
  612. <para>
  613. <literal>Debug::pkgDPkgPM</literal> prints out the actual
  614. command line each time that <literal>apt</literal> invokes
  615. &dpkg;.
  616. </para>
  617. </listitem>
  618. <listitem>
  619. <para>
  620. <literal>Debug::IdentCdrom</literal> disables the inclusion
  621. of statfs data in CDROM IDs. <!-- TODO: provide a
  622. motivating example, except I haven't a clue why you'd want
  623. to do this. -->
  624. </para>
  625. </listitem>
  626. </itemizedlist>
  627. </para>
  628. <para>
  629. A full list of debugging options to apt follows.
  630. </para>
  631. <variablelist>
  632. <varlistentry>
  633. <term><literal>Debug::Acquire::cdrom</literal></term>
  634. <listitem>
  635. <para>
  636. Print information related to accessing
  637. <literal>cdrom://</literal> sources.
  638. </para>
  639. </listitem>
  640. </varlistentry>
  641. <varlistentry>
  642. <term><literal>Debug::Acquire::ftp</literal></term>
  643. <listitem>
  644. <para>
  645. Print information related to downloading packages using
  646. FTP.
  647. </para>
  648. </listitem>
  649. </varlistentry>
  650. <varlistentry>
  651. <term><literal>Debug::Acquire::http</literal></term>
  652. <listitem>
  653. <para>
  654. Print information related to downloading packages using
  655. HTTP.
  656. </para>
  657. </listitem>
  658. </varlistentry>
  659. <varlistentry>
  660. <term><literal>Debug::Acquire::https</literal></term>
  661. <listitem>
  662. <para>
  663. Print information related to downloading packages using
  664. HTTPS.
  665. </para>
  666. </listitem>
  667. </varlistentry>
  668. <varlistentry>
  669. <term><literal>Debug::Acquire::gpgv</literal></term>
  670. <listitem>
  671. <para>
  672. Print information related to verifying cryptographic
  673. signatures using <literal>gpg</literal>.
  674. </para>
  675. </listitem>
  676. </varlistentry>
  677. <varlistentry>
  678. <term><literal>Debug::aptcdrom</literal></term>
  679. <listitem>
  680. <para>
  681. Output information about the process of accessing
  682. collections of packages stored on CD-ROMs.
  683. </para>
  684. </listitem>
  685. </varlistentry>
  686. <varlistentry>
  687. <term><literal>Debug::BuildDeps</literal></term>
  688. <listitem>
  689. <para>
  690. Describes the process of resolving build-dependencies in
  691. &apt-get;.
  692. </para>
  693. </listitem>
  694. </varlistentry>
  695. <varlistentry>
  696. <term><literal>Debug::Hashes</literal></term>
  697. <listitem>
  698. <para>
  699. Output each cryptographic hash that is generated by the
  700. <literal>apt</literal> libraries.
  701. </para>
  702. </listitem>
  703. </varlistentry>
  704. <varlistentry>
  705. <term><literal>Debug::IdentCDROM</literal></term>
  706. <listitem>
  707. <para>
  708. Do not include information from <literal>statfs</literal>,
  709. namely the number of used and free blocks on the CD-ROM
  710. filesystem, when generating an ID for a CD-ROM.
  711. </para>
  712. </listitem>
  713. </varlistentry>
  714. <varlistentry>
  715. <term><literal>Debug::NoLocking</literal></term>
  716. <listitem>
  717. <para>
  718. Disable all file locking. For instance, this will allow
  719. two instances of <quote><literal>apt-get
  720. update</literal></quote> to run at the same time.
  721. </para>
  722. </listitem>
  723. </varlistentry>
  724. <varlistentry>
  725. <term><literal>Debug::pkgAcquire</literal></term>
  726. <listitem>
  727. <para>
  728. Log when items are added to or removed from the global
  729. download queue.
  730. </para>
  731. </listitem>
  732. </varlistentry>
  733. <varlistentry>
  734. <term><literal>Debug::pkgAcquire::Auth</literal></term>
  735. <listitem>
  736. <para>
  737. Output status messages and errors related to verifying
  738. checksums and cryptographic signatures of downloaded files.
  739. </para>
  740. </listitem>
  741. </varlistentry>
  742. <varlistentry>
  743. <term><literal>Debug::pkgAcquire::Diffs</literal></term>
  744. <listitem>
  745. <para>
  746. Output information about downloading and applying package
  747. index list diffs, and errors relating to package index list
  748. diffs.
  749. </para>
  750. </listitem>
  751. </varlistentry>
  752. <varlistentry>
  753. <term><literal>Debug::pkgAcquire::RRed</literal></term>
  754. <listitem>
  755. <para>
  756. Output information related to patching apt package lists
  757. when downloading index diffs instead of full indices.
  758. </para>
  759. </listitem>
  760. </varlistentry>
  761. <varlistentry>
  762. <term><literal>Debug::pkgAcquire::Worker</literal></term>
  763. <listitem>
  764. <para>
  765. Log all interactions with the sub-processes that actually
  766. perform downloads.
  767. </para>
  768. </listitem>
  769. </varlistentry>
  770. <varlistentry>
  771. <term><literal>Debug::pkgAutoRemove</literal></term>
  772. <listitem>
  773. <para>
  774. Log events related to the automatically-installed status of
  775. packages and to the removal of unused packages.
  776. </para>
  777. </listitem>
  778. </varlistentry>
  779. <varlistentry>
  780. <term><literal>Debug::pkgDepCache::AutoInstall</literal></term>
  781. <listitem>
  782. <para>
  783. Generate debug messages describing which packages are being
  784. automatically installed to resolve dependencies. This
  785. corresponds to the initial auto-install pass performed in,
  786. e.g., <literal>apt-get install</literal>, and not to the
  787. full <literal>apt</literal> dependency resolver; see
  788. <literal>Debug::pkgProblemResolver</literal> for that.
  789. </para>
  790. </listitem>
  791. </varlistentry>
  792. <varlistentry>
  793. <term><literal>Debug::pkgDepCache::Marker</literal></term>
  794. <listitem>
  795. <para>
  796. Generate debug messages describing which package is marked
  797. as keep/install/remove while the ProblemResolver does his work.
  798. Each addition or deletion may trigger additional actions;
  799. they are shown indented two additional space under the original entry.
  800. The format for each line is <literal>MarkKeep</literal>,
  801. <literal>MarkDelete</literal> or <literal>MarkInstall</literal> followed by
  802. <literal>package-name &lt;a.b.c -&gt; d.e.f | x.y.z&gt; (section)</literal>
  803. where <literal>a.b.c</literal> is the current version of the package,
  804. <literal>d.e.f</literal> is the version considered for installation and
  805. <literal>x.y.z</literal> is a newer version, but not considered for installation
  806. (because of a low pin score). The later two can be omitted if there is none or if
  807. it is the same version as the installed.
  808. <literal>section</literal> is the name of the section the package appears in.
  809. </para>
  810. </listitem>
  811. </varlistentry>
  812. <!-- Question: why doesn't this do anything? The code says it should. -->
  813. <varlistentry>
  814. <term><literal>Debug::pkgInitConfig</literal></term>
  815. <listitem>
  816. <para>
  817. Dump the default configuration to standard error on
  818. startup.
  819. </para>
  820. </listitem>
  821. </varlistentry>
  822. <varlistentry>
  823. <term><literal>Debug::pkgDPkgPM</literal></term>
  824. <listitem>
  825. <para>
  826. When invoking &dpkg;, output the precise command line with
  827. which it is being invoked, with arguments separated by a
  828. single space character.
  829. </para>
  830. </listitem>
  831. </varlistentry>
  832. <varlistentry>
  833. <term><literal>Debug::pkgDPkgProgressReporting</literal></term>
  834. <listitem>
  835. <para>
  836. Output all the data received from &dpkg; on the status file
  837. descriptor and any errors encountered while parsing it.
  838. </para>
  839. </listitem>
  840. </varlistentry>
  841. <varlistentry>
  842. <term><literal>Debug::pkgOrderList</literal></term>
  843. <listitem>
  844. <para>
  845. Generate a trace of the algorithm that decides the order in
  846. which <literal>apt</literal> should pass packages to
  847. &dpkg;.
  848. </para>
  849. </listitem>
  850. </varlistentry>
  851. <varlistentry>
  852. <term><literal>Debug::pkgPackageManager</literal></term>
  853. <listitem>
  854. <para>
  855. Output status messages tracing the steps performed when
  856. invoking &dpkg;.
  857. </para>
  858. </listitem>
  859. </varlistentry>
  860. <varlistentry>
  861. <term><literal>Debug::pkgPolicy</literal></term>
  862. <listitem>
  863. <para>
  864. Output the priority of each package list on startup.
  865. </para>
  866. </listitem>
  867. </varlistentry>
  868. <varlistentry>
  869. <term><literal>Debug::pkgProblemResolver</literal></term>
  870. <listitem>
  871. <para>
  872. Trace the execution of the dependency resolver (this
  873. applies only to what happens when a complex dependency
  874. problem is encountered).
  875. </para>
  876. </listitem>
  877. </varlistentry>
  878. <varlistentry>
  879. <term><literal>Debug::pkgProblemResolver::ShowScores</literal></term>
  880. <listitem>
  881. <para>
  882. Display a list of all installed packages with their calculated score
  883. used by the pkgProblemResolver. The description of the package
  884. is the same as described in <literal>Debug::pkgDepCache::Marker</literal>
  885. </para>
  886. </listitem>
  887. </varlistentry>
  888. <varlistentry>
  889. <term><literal>Debug::sourceList</literal></term>
  890. <listitem>
  891. <para>
  892. Print information about the vendors read from
  893. <filename>/etc/apt/vendors.list</filename>.
  894. </para>
  895. </listitem>
  896. </varlistentry>
  897. <!-- 2009/07/11 Currently used nowhere. The corresponding code
  898. is commented.
  899. <varlistentry>
  900. <term><literal>Debug::Vendor</literal></term>
  901. <listitem>
  902. <para>
  903. Print information about each vendor.
  904. </para>
  905. </listitem>
  906. </varlistentry>
  907. -->
  908. </variablelist>
  909. </refsect1>
  910. <refsect1><title>Examples</title>
  911. <para>&configureindex; is a
  912. configuration file showing example values for all possible
  913. options.</para>
  914. </refsect1>
  915. <refsect1><title>Files</title>
  916. <variablelist>
  917. &file-aptconf;
  918. </variablelist>
  919. </refsect1>
  920. <refsect1><title>See Also</title>
  921. <para>&apt-cache;, &apt-config;<!-- ? reading apt.conf -->, &apt-preferences;.</para>
  922. </refsect1>
  923. &manbugs;
  924. </refentry>