]> git.saurik.com Git - apt.git/blob - doc/apt.conf.5.xml
po/fr.po: Remove the unbreakable space before ! in the confirm string
[apt.git] / doc / apt.conf.5.xml
1 <?xml version="1.0" encoding="utf-8" standalone="no"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
5 <!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
6 <!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
7 ]>
8
9 <refentry>
10
11 <refentryinfo>
12 &apt-author.jgunthorpe;
13 &apt-author.team;
14 <author>
15 &apt-name.dburrows;
16 <contrib>Initial documentation of Debug::*.</contrib>
17 <email>dburrows@debian.org</email>
18 </author>
19 &apt-email;
20 &apt-product;
21 <!-- The last update date -->
22 <date>2012-06-09T00:00:00Z</date>
23 </refentryinfo>
24
25 <refmeta>
26 <refentrytitle>apt.conf</refentrytitle>
27 <manvolnum>5</manvolnum>
28 <refmiscinfo class="manual">APT</refmiscinfo>
29 </refmeta>
30
31 <!-- Man page title -->
32 <refnamediv>
33 <refname>apt.conf</refname>
34 <refpurpose>Configuration file for APT</refpurpose>
35 </refnamediv>
36
37 <refsect1><title>Description</title>
38 <para><filename>/etc/apt/apt.conf</filename> is the main configuration
39 file shared by all the tools in the APT suite of tools, though it is by
40 no means the only place options can be set. The suite also shares a common
41 command line parser to provide a uniform environment.</para>
42
43 <orderedlist>
44 <para>When an APT tool starts up it will read the configuration files
45 in the following order:</para>
46 <listitem><para>the file specified by the <envar>APT_CONFIG</envar>
47 environment variable (if any)</para></listitem>
48 <listitem><para>all files in <literal>Dir::Etc::Parts</literal> in
49 alphanumeric ascending order which have either no or "<literal>conf</literal>"
50 as filename extension and which only contain alphanumeric,
51 hyphen (-), underscore (_) and period (.) characters.
52 Otherwise APT will print a notice that it has ignored a file, unless that
53 file matches a pattern in the <literal>Dir::Ignore-Files-Silently</literal>
54 configuration list - in which case it will be silently ignored.</para></listitem>
55 <listitem><para>the main configuration file specified by
56 <literal>Dir::Etc::main</literal></para></listitem>
57 <listitem><para>the command line options are applied to override the
58 configuration directives or to load even more configuration files.</para></listitem>
59 </orderedlist>
60 </refsect1>
61 <refsect1><title>Syntax</title>
62 <para>The configuration file is organized in a tree with options organized into
63 functional groups. Option specification is given with a double colon
64 notation; for instance <literal>APT::Get::Assume-Yes</literal> is an option within
65 the APT tool group, for the Get tool. Options do not inherit from their
66 parent groups.</para>
67
68 <para>Syntactically the configuration language is modeled after what the ISC tools
69 such as bind and dhcp use. Lines starting with
70 <literal>//</literal> are treated as comments (ignored), as well as all text
71 between <literal>/*</literal> and <literal>*/</literal>, just like C/C++ comments.
72 Each line is of the form
73 <literal>APT::Get::Assume-Yes "true";</literal>.
74 The quotation marks and trailing semicolon are required.
75 The value must be on one line, and there is no kind of string concatenation.
76 Values must not include backslashes or extra quotation marks.
77 Option names are made up of alphanumeric characters and the characters "/-:._+".
78 A new scope can be opened with curly braces, like this:</para>
79
80 <informalexample><programlisting>
81 APT {
82 Get {
83 Assume-Yes "true";
84 Fix-Broken "true";
85 };
86 };
87 </programlisting></informalexample>
88
89 <para>with newlines placed to make it more readable. Lists can be created by
90 opening a scope and including a single string enclosed in quotes followed by a
91 semicolon. Multiple entries can be included, separated by a semicolon.</para>
92
93 <informalexample><programlisting>
94 DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
95 </programlisting></informalexample>
96
97 <para>In general the sample configuration file &configureindex;
98 is a good guide for how it should look.</para>
99
100 <para>Case is not significant in names of configuration items, so in the
101 previous example you could use <literal>dpkg::pre-install-pkgs</literal>.</para>
102
103 <para>Names for the configuration items are optional if a list is defined as can be seen in
104 the <literal>DPkg::Pre-Install-Pkgs</literal> example above. If you don't specify a name a
105 new entry will simply add a new option to the list. If you specify a name you can override
106 the option in the same way as any other option by reassigning a new value to the option.</para>
107
108 <para>Two special commands are defined: <literal>#include</literal> (which is
109 deprecated and not supported by alternative implementations) and
110 <literal>#clear</literal>. <literal>#include</literal> will include the
111 given file, unless the filename ends in a slash, in which case the whole
112 directory is included.
113 <literal>#clear</literal> is used to erase a part of the configuration tree. The
114 specified element and all its descendants are erased.
115 (Note that these lines also need to end with a semicolon.)</para>
116
117 <para>
118 The <literal>#clear</literal> command is the only way to delete a list or
119 a complete scope. Reopening a scope (or using the syntax described below
120 with an appended <literal>::</literal>) will <emphasis>not</emphasis>
121 override previously written entries. Options can only be overridden by
122 addressing a new value to them - lists and scopes can't be overridden,
123 only cleared.
124 </para>
125
126 <para>All of the APT tools take an -o option which allows an arbitrary configuration
127 directive to be specified on the command line. The syntax is a full option
128 name (<literal>APT::Get::Assume-Yes</literal> for instance) followed by an equals
129 sign then the new value of the option. To append a new element to a list, add a
130 trailing <literal>::</literal> to the name of the list.
131 (As you might suspect, the scope syntax can't be used on the command line.)</para>
132
133 <para>
134 Note that appending items to a list using <literal>::</literal> only works
135 for one item per line, and that you should not use it in combination with
136 the scope syntax (which adds <literal>::</literal> implicitly). Using both
137 syntaxes together will trigger a bug which some users unfortunately depend
138 on: an option with the unusual name "<literal>::</literal>" which acts
139 like every other option with a name. This introduces many problems; for
140 one thing, users who write multiple lines in this
141 <emphasis>wrong</emphasis> syntax in the hope of appending to a list will
142 achieve the opposite, as only the last assignment for this option
143 "<literal>::</literal>" will be used. Future versions of APT will raise
144 errors and stop working if they encounter this misuse, so please correct
145 such statements now while APT doesn't explicitly complain about them.
146 </para>
147 </refsect1>
148
149 <refsect1><title>The APT Group</title>
150 <para>This group of options controls general APT behavior as well as holding the
151 options for all of the tools.</para>
152
153 <variablelist>
154 <varlistentry><term><option>Architecture</option></term>
155 <listitem><para>System Architecture; sets the architecture to use when fetching files and
156 parsing package lists. The internal default is the architecture apt was
157 compiled for.</para></listitem>
158 </varlistentry>
159
160 <varlistentry><term><option>Architectures</option></term>
161 <listitem><para>
162 All Architectures the system supports. For instance, CPUs implementing
163 the <literal>amd64</literal> (also called <literal>x86-64</literal>)
164 instruction set are also able to execute binaries compiled for the
165 <literal>i386</literal> (<literal>x86</literal>) instruction set. This
166 list is used when fetching files and parsing package lists. The
167 initial default is always the system's native architecture
168 (<literal>APT::Architecture</literal>), and foreign architectures are
169 added to the default list when they are registered via
170 <command>dpkg --add-architecture</command>.
171 </para></listitem>
172 </varlistentry>
173
174 <varlistentry><term><option>Build-Profiles</option></term>
175 <listitem><para>
176 List of all build profiles enabled for build-dependency resolution,
177 without the "<literal>profile.</literal>" namespace prefix.
178 By default this list is empty. The <envar>DEB_BUILD_PROFILES</envar>
179 as used by &dpkg-buildpackage; overrides the list notation.
180 </para></listitem>
181 </varlistentry>
182
183 <varlistentry><term><option>Default-Release</option></term>
184 <listitem><para>Default release to install packages from if more than one
185 version is available. Contains release name, codename or release version. Examples: 'stable', 'testing',
186 'unstable', '&stable-codename;', '&testing-codename;', '4.0', '5.0*'. See also &apt-preferences;.</para></listitem>
187 </varlistentry>
188
189 <varlistentry><term><option>Ignore-Hold</option></term>
190 <listitem><para>Ignore held packages; this global option causes the problem resolver to
191 ignore held packages in its decision making.</para></listitem>
192 </varlistentry>
193
194 <varlistentry><term><option>Clean-Installed</option></term>
195 <listitem><para>Defaults to on. When turned on the autoclean feature will remove any packages
196 which can no longer be downloaded from the cache. If turned off then
197 packages that are locally installed are also excluded from cleaning - but
198 note that APT provides no direct means to reinstall them.</para></listitem>
199 </varlistentry>
200
201 <varlistentry><term><option>Immediate-Configure</option></term>
202 <listitem><para>
203 Defaults to on, which will cause APT to install essential and important
204 packages as soon as possible in an install/upgrade operation, in order
205 to limit the effect of a failing &dpkg; call. If this option is
206 disabled, APT treats an important package in the same way as an extra
207 package: between the unpacking of the package A and its configuration
208 there can be many other unpack or configuration calls for other
209 unrelated packages B, C etc. If these cause the &dpkg; call to fail
210 (e.g. because package B's maintainer scripts generate an error), this
211 results in a system state in which package A is unpacked but
212 unconfigured - so any package depending on A is now no longer
213 guaranteed to work, as its dependency on A is no longer satisfied.
214 </para><para>
215 The immediate configuration marker is also applied in the potentially
216 problematic case of circular dependencies, since a dependency with the
217 immediate flag is equivalent to a Pre-Dependency. In theory this allows
218 APT to recognise a situation in which it is unable to perform immediate
219 configuration, abort, and suggest to the user that the option should be
220 temporarily deactivated in order to allow the operation to proceed.
221 Note the use of the word "theory" here; in the real world this problem
222 has rarely been encountered, in non-stable distribution versions, and
223 was caused by wrong dependencies of the package in question or by a
224 system in an already broken state; so you should not blindly disable
225 this option, as the scenario mentioned above is not the only problem it
226 can help to prevent in the first place.
227 </para><para>
228 Before a big operation like <literal>dist-upgrade</literal> is run
229 with this option disabled you should try to explicitly
230 <literal>install</literal> the package APT is unable to configure
231 immediately; but please make sure you also report your problem to your
232 distribution and to the APT team with the buglink below, so they can
233 work on improving or correcting the upgrade process.
234 </para></listitem>
235 </varlistentry>
236
237 <varlistentry><term><option>Force-LoopBreak</option></term>
238 <listitem><para>
239 Never enable this option unless you <emphasis>really</emphasis> know
240 what you are doing. It permits APT to temporarily remove an essential
241 package to break a Conflicts/Conflicts or Conflicts/Pre-Depends loop
242 between two essential packages. <emphasis>Such a loop should never exist
243 and is a grave bug</emphasis>. This option will work if the essential
244 packages are not <command>tar</command>, <command>gzip</command>,
245 <command>libc</command>, <command>dpkg</command>, <command>dash</command>
246 or anything that those packages depend on.
247 </para></listitem>
248 </varlistentry>
249
250 <varlistentry><term><option>Cache-Start</option></term><term><option>Cache-Grow</option></term><term><option>Cache-Limit</option></term>
251 <listitem><para>APT uses since version 0.7.26 a resizable memory mapped cache file to store the available
252 information. <literal>Cache-Start</literal> acts as a hint of the size the cache will grow to,
253 and is therefore the amount of memory APT will request at startup. The default value is
254 20971520 bytes (~20 MB). Note that this amount of space needs to be available for APT;
255 otherwise it will likely fail ungracefully, so for memory restricted devices this value should
256 be lowered while on systems with a lot of configured sources it should be increased.
257 <literal>Cache-Grow</literal> defines in bytes with the default of 1048576 (~1 MB) how much
258 the cache size will be increased in the event the space defined by <literal>Cache-Start</literal>
259 is not enough. This value will be applied again and again until either the cache is big
260 enough to store all information or the size of the cache reaches the <literal>Cache-Limit</literal>.
261 The default of <literal>Cache-Limit</literal> is 0 which stands for no limit.
262 If <literal>Cache-Grow</literal> is set to 0 the automatic growth of the cache is disabled.
263 </para></listitem>
264 </varlistentry>
265
266 <varlistentry><term><option>Build-Essential</option></term>
267 <listitem><para>Defines which packages are considered essential build dependencies.</para></listitem>
268 </varlistentry>
269
270 <varlistentry><term><option>Get</option></term>
271 <listitem><para>The Get subsection controls the &apt-get; tool; please see its
272 documentation for more information about the options here.</para></listitem>
273 </varlistentry>
274
275 <varlistentry><term><option>Cache</option></term>
276 <listitem><para>The Cache subsection controls the &apt-cache; tool; please see its
277 documentation for more information about the options here.</para></listitem>
278 </varlistentry>
279
280 <varlistentry><term><option>CDROM</option></term>
281 <listitem><para>The CDROM subsection controls the &apt-cdrom; tool; please see its
282 documentation for more information about the options here.</para></listitem>
283 </varlistentry>
284 </variablelist>
285 </refsect1>
286
287 <refsect1><title>The Acquire Group</title>
288 <para>The <literal>Acquire</literal> group of options controls the
289 download of packages as well as the various "acquire methods" responsible
290 for the download itself (see also &sources-list;).</para>
291
292 <variablelist>
293 <varlistentry><term><option>Check-Valid-Until</option></term>
294 <listitem><para>
295 Security related option defaulting to true, as giving a Release file's
296 validation an expiration date prevents replay attacks over a long
297 timescale, and can also for example help users to identify mirrors
298 that are no longer updated - but the feature depends on the
299 correctness of the clock on the user system. Archive maintainers are
300 encouraged to create Release files with the
301 <literal>Valid-Until</literal> header, but if they don't or a
302 stricter value is desired the <literal>Max-ValidTime</literal>
303 option below can be used.
304 The <option>Check-Valid-Until</option> option of &sources-list; entries should be
305 preferred to disable the check selectively instead of using this global override.
306 </para></listitem>
307 </varlistentry>
308
309 <varlistentry><term><option>Max-ValidTime</option></term>
310 <listitem><para>Maximum time (in seconds) after its creation (as indicated
311 by the <literal>Date</literal> header) that the <filename>Release</filename>
312 file should be considered valid.
313 If the Release file itself includes a <literal>Valid-Until</literal> header
314 the earlier date of the two is used as the expiration date.
315 The default value is <literal>0</literal> which stands for "valid forever".
316 Archive specific settings can be made by appending the label of the archive
317 to the option name. Preferably, the same can be achieved for specific
318 &sources-list; entries by using the <option>Valid-Until-Max</option> option there.
319 </para></listitem>
320 </varlistentry>
321
322 <varlistentry><term><option>Min-ValidTime</option></term>
323 <listitem><para>Minimum time (in seconds) after its creation (as indicated
324 by the <literal>Date</literal> header) that the <filename>Release</filename>
325 file should be considered valid.
326 Use this if you need to use a seldom updated (local) mirror of a more
327 frequently updated archive with a <literal>Valid-Until</literal> header
328 instead of completely disabling the expiration date checking.
329 Archive specific settings can and should be used by appending the label of
330 the archive to the option name. Preferably, the same can be achieved for specific
331 &sources-list; entries by using the <option>Valid-Until-Min</option> option there.
332 </para></listitem>
333 </varlistentry>
334
335 <varlistentry><term><option>PDiffs</option></term>
336 <listitem><para>Try to download deltas called <literal>PDiffs</literal> for
337 indexes (like <filename>Packages</filename> files) instead of downloading
338 whole ones. True by default.</para>
339 <para>Two sub-options to limit the use of PDiffs are also available:
340 <literal>FileLimit</literal> can be used to specify a maximum number of
341 PDiff files should be downloaded to update a file. <literal>SizeLimit</literal>
342 on the other hand is the maximum percentage of the size of all patches
343 compared to the size of the targeted file. If one of these limits is
344 exceeded the complete file is downloaded instead of the patches.
345 </para></listitem>
346 </varlistentry>
347
348 <varlistentry><term><option>Queue-Mode</option></term>
349 <listitem><para>Queuing mode; <literal>Queue-Mode</literal> can be one of <literal>host</literal> or
350 <literal>access</literal> which determines how APT parallelizes outgoing
351 connections. <literal>host</literal> means that one connection per target host
352 will be opened, <literal>access</literal> means that one connection per URI type
353 will be opened.</para></listitem>
354 </varlistentry>
355
356 <varlistentry><term><option>Retries</option></term>
357 <listitem><para>Number of retries to perform. If this is non-zero APT will retry failed
358 files the given number of times.</para></listitem>
359 </varlistentry>
360
361 <varlistentry><term><option>Source-Symlinks</option></term>
362 <listitem><para>Use symlinks for source archives. If set to true then source archives will
363 be symlinked when possible instead of copying. True is the default.</para></listitem>
364 </varlistentry>
365
366 <varlistentry><term><option>http</option></term>
367 <listitem><para><literal>http::Proxy</literal> sets the default proxy to use for HTTP
368 URIs. It is in the standard form of <literal>http://[[user][:pass]@]host[:port]/</literal>.
369 Per host proxies can also be specified by using the form
370 <literal>http::Proxy::&lt;host&gt;</literal> with the special keyword <literal>DIRECT</literal>
371 meaning to use no proxies. If no one of the above settings is specified,
372 <envar>http_proxy</envar> environment variable
373 will be used.</para>
374
375 <para>Three settings are provided for cache control with HTTP/1.1 compliant
376 proxy caches.
377 <literal>No-Cache</literal> tells the proxy not to use its cached
378 response under any circumstances.
379 <literal>Max-Age</literal> sets the allowed maximum age (in seconds) of
380 an index file in the cache of the proxy.
381 <literal>No-Store</literal> specifies that the proxy should not store
382 the requested archive files in its cache, which can be used to prevent
383 the proxy from polluting its cache with (big) .deb files.</para>
384
385 <para>The option <literal>timeout</literal> sets the timeout timer used by the method;
386 this value applies to the connection as well as the data timeout.</para>
387
388 <para>The setting <literal>Acquire::http::Pipeline-Depth</literal> can be used to
389 enable HTTP pipelining (RFC 2616 section 8.1.2.2) which can be beneficial e.g. on
390 high-latency connections. It specifies how many requests are sent in a pipeline.
391 APT tries to detect and workaround misbehaving webservers and proxies at runtime, but
392 if you know that yours does not conform to the HTTP/1.1 specification pipelining can
393 be disabled by setting the value to 0. It is enabled by default with the value 10.</para>
394
395 <para><literal>Acquire::http::AllowRedirect</literal> controls whether APT will follow
396 redirects, which is enabled by default.</para>
397
398 <para>The used bandwidth can be limited with
399 <literal>Acquire::http::Dl-Limit</literal> which accepts integer
400 values in kilobytes per second. The default value is 0 which
401 deactivates the limit and tries to use all available bandwidth.
402 Note that this option implicitly disables downloading from
403 multiple servers at the same time.</para>
404
405 <para><literal>Acquire::http::User-Agent</literal> can be used to set a different
406 User-Agent for the http download method as some proxies allow access for clients
407 only if the client uses a known identifier.</para>
408
409 <para><literal>Acquire::http::Proxy-Auto-Detect</literal> can be used to
410 specify an external command to discover the http proxy to use. Apt expects
411 the command to output the proxy on stdout in the style
412 <literal>http://proxy:port/</literal>. This will override the
413 generic <literal>Acquire::http::Proxy</literal> but not any specific
414 host proxy configuration set via
415 <literal>Acquire::http::Proxy::$HOST</literal>.
416
417 See the &squid-deb-proxy-client; package for an example implementation that
418 uses avahi. This option takes precedence over the legacy option name
419 <literal>ProxyAutoDetect</literal>.
420 </para>
421
422 </listitem>
423 </varlistentry>
424
425 <varlistentry><term><option>https</option></term>
426 <listitem><para>
427 The <literal>Cache-control</literal>, <literal>Timeout</literal>,
428 <literal>AllowRedirect</literal>, <literal>Dl-Limit</literal> and
429 <literal>proxy</literal> options work for HTTPS URIs in the same way
430 as for the <literal>http</literal> method, and default to the same
431 values if they are not explicitly set. The
432 <literal>Pipeline-Depth</literal> option is not yet supported.
433 </para>
434
435 <para><literal>CaInfo</literal> suboption specifies place of file that
436 holds info about trusted certificates.
437 <literal>&lt;host&gt;::CaInfo</literal> is the corresponding per-host option.
438 <literal>Verify-Peer</literal> boolean suboption determines whether or not the
439 server's host certificate should be verified against trusted certificates.
440 <literal>&lt;host&gt;::Verify-Peer</literal> is the corresponding per-host option.
441 <literal>Verify-Host</literal> boolean suboption determines whether or not the
442 server's hostname should be verified.
443 <literal>&lt;host&gt;::Verify-Host</literal> is the corresponding per-host option.
444 <literal>SslCert</literal> determines what certificate to use for client
445 authentication. <literal>&lt;host&gt;::SslCert</literal> is the corresponding per-host option.
446 <literal>SslKey</literal> determines what private key to use for client
447 authentication. <literal>&lt;host&gt;::SslKey</literal> is the corresponding per-host option.
448 <literal>SslForceVersion</literal> overrides default SSL version to use.
449 It can contain either of the strings '<literal>TLSv1</literal>' or
450 '<literal>SSLv3</literal>'.
451 <literal>&lt;host&gt;::SslForceVersion</literal> is the corresponding per-host option.
452 </para></listitem></varlistentry>
453
454 <varlistentry><term><option>ftp</option></term>
455 <listitem><para>
456 <literal>ftp::Proxy</literal> sets the default proxy to use for FTP URIs.
457 It is in the standard form of <literal>ftp://[[user][:pass]@]host[:port]/</literal>.
458 Per host proxies can also be specified by using the form
459 <literal>ftp::Proxy::&lt;host&gt;</literal> with the special keyword <literal>DIRECT</literal>
460 meaning to use no proxies. If no one of the above settings is specified,
461 <envar>ftp_proxy</envar> environment variable
462 will be used. To use an FTP
463 proxy you will have to set the <literal>ftp::ProxyLogin</literal> script in the
464 configuration file. This entry specifies the commands to send to tell
465 the proxy server what to connect to. Please see
466 &configureindex; for an example of
467 how to do this. The substitution variables representing the corresponding
468 URI component are <literal>$(PROXY_USER)</literal>,
469 <literal>$(PROXY_PASS)</literal>, <literal>$(SITE_USER)</literal>,
470 <literal>$(SITE_PASS)</literal>, <literal>$(SITE)</literal> and
471 <literal>$(SITE_PORT)</literal>.</para>
472
473 <para>The option <literal>timeout</literal> sets the timeout timer used by the method;
474 this value applies to the connection as well as the data timeout.</para>
475
476 <para>Several settings are provided to control passive mode. Generally it is
477 safe to leave passive mode on; it works in nearly every environment.
478 However, some situations require that passive mode be disabled and port
479 mode FTP used instead. This can be done globally or for connections that
480 go through a proxy or for a specific host (see the sample config file
481 for examples).</para>
482
483 <para>It is possible to proxy FTP over HTTP by setting the <envar>ftp_proxy</envar>
484 environment variable to an HTTP URL - see the discussion of the http method
485 above for syntax. You cannot set this in the configuration file and it is
486 not recommended to use FTP over HTTP due to its low efficiency.</para>
487
488 <para>The setting <literal>ForceExtended</literal> controls the use of RFC2428
489 <literal>EPSV</literal> and <literal>EPRT</literal> commands. The default is false, which means
490 these commands are only used if the control connection is IPv6. Setting this
491 to true forces their use even on IPv4 connections. Note that most FTP servers
492 do not support RFC2428.</para></listitem>
493 </varlistentry>
494
495 <varlistentry><term><option>cdrom</option></term>
496 <listitem><para>
497 For URIs using the <literal>cdrom</literal> method, the only configurable
498 option is the mount point, <literal>cdrom::Mount</literal>, which must be
499 the mount point for the CD-ROM (or DVD, or whatever) drive as specified in
500 <filename>/etc/fstab</filename>. It is possible to provide alternate mount
501 and unmount commands if your mount point cannot be listed in the fstab.
502 The syntax is to put <literallayout>/cdrom/::Mount "foo";</literallayout> within
503 the <literal>cdrom</literal> block. It is important to have the trailing slash.
504 Unmount commands can be specified using UMount.
505 </para></listitem>
506 </varlistentry>
507
508 <varlistentry><term><option>gpgv</option></term>
509 <listitem><para>
510 For GPGV URIs the only configurable option is <literal>gpgv::Options</literal>,
511 which passes additional parameters to gpgv.
512 </para></listitem>
513 </varlistentry>
514
515 <varlistentry><term><option>CompressionTypes</option></term>
516 <listitem><para>List of compression types which are understood by the acquire methods.
517 Files like <filename>Packages</filename> can be available in various compression formats.
518 By default the acquire methods can decompress <command>bzip2</command>, <command>lzma</command>
519 and <command>gzip</command> compressed files; with this setting more formats can be added
520 on the fly or the used method can be changed. The syntax for this is:
521 <synopsis>Acquire::CompressionTypes::<replaceable>FileExtension</replaceable> "<replaceable>Methodname</replaceable>";</synopsis>
522 </para><para>Also, the <literal>Order</literal> subgroup can be used to define in which order
523 the acquire system will try to download the compressed files. The acquire system will try the first
524 and proceed with the next compression type in this list on error, so to prefer one over the other type
525 simply add the preferred type first - default types not already added will be implicitly appended
526 to the end of the list, so e.g. <synopsis>Acquire::CompressionTypes::Order:: "gz";</synopsis> can
527 be used to prefer <command>gzip</command> compressed files over <command>bzip2</command> and <command>lzma</command>.
528 If <command>lzma</command> should be preferred over <command>gzip</command> and <command>bzip2</command> the
529 configure setting should look like this: <synopsis>Acquire::CompressionTypes::Order { "lzma"; "gz"; };</synopsis>
530 It is not needed to add <literal>bz2</literal> to the list explicitly as it will be added automatically.</para>
531 <para>Note that the
532 <literal>Dir::Bin::<replaceable>Methodname</replaceable></literal>
533 will be checked at run time. If this option has been set, the
534 method will only be used if this file exists; e.g. for the
535 <literal>bzip2</literal> method (the inbuilt) setting is:
536 <literallayout>Dir::Bin::bzip2 "/bin/bzip2";</literallayout>
537 Note also that list entries specified on the command line will be added at the end of the list
538 specified in the configuration files, but before the default entries. To prefer a type in this case
539 over the ones specified in the configuration files you can set the option direct - not in list style.
540 This will not override the defined list; it will only prefix the list with this type.</para>
541 <para>The special type <literal>uncompressed</literal> can be used to give uncompressed files a
542 preference, but note that most archives don't provide uncompressed files so this is mostly only
543 useable for local mirrors.</para></listitem>
544 </varlistentry>
545
546 <varlistentry><term><option>GzipIndexes</option></term>
547 <listitem><para>
548 When downloading <literal>gzip</literal> compressed indexes (Packages, Sources, or
549 Translations), keep them gzip compressed locally instead of unpacking
550 them. This saves quite a lot of disk space at the expense of more CPU
551 requirements when building the local package caches. False by default.
552 </para></listitem>
553 </varlistentry>
554
555 <varlistentry><term><option>Languages</option></term>
556 <listitem><para>The Languages subsection controls which <filename>Translation</filename> files are downloaded
557 and in which order APT tries to display the description-translations. APT will try to display the first
558 available description in the language which is listed first. Languages can be defined with their
559 short or long language codes. Note that not all archives provide <filename>Translation</filename>
560 files for every language - the long language codes are especially rare.</para>
561 <para>The default list includes "environment" and "en". "<literal>environment</literal>" has a special meaning here:
562 it will be replaced at runtime with the language codes extracted from the <literal>LC_MESSAGES</literal> environment variable.
563 It will also ensure that these codes are not included twice in the list. If <literal>LC_MESSAGES</literal>
564 is set to "C" only the <filename>Translation-en</filename> file (if available) will be used.
565 To force APT to use no Translation file use the setting <literal>Acquire::Languages=none</literal>. "<literal>none</literal>"
566 is another special meaning code which will stop the search for a suitable <filename>Translation</filename> file.
567 This tells APT to download these translations too, without actually
568 using them unless the environment specifies the languages. So the
569 following example configuration will result in the order "en, de" in an
570 English locale or "de, en" in a German one. Note that "fr" is
571 downloaded, but not used unless APT is used in a French locale (where
572 the order would be "fr, de, en").
573 <programlisting>Acquire::Languages { "environment"; "de"; "en"; "none"; "fr"; };</programlisting></para>
574 <para>Note: To prevent problems resulting from APT being executed in different environments
575 (e.g. by different users or by other programs) all Translation files which are found in
576 <filename>/var/lib/apt/lists/</filename> will be added to the end of the list
577 (after an implicit "<literal>none</literal>").</para>
578 </listitem>
579 </varlistentry>
580
581 <varlistentry><term><option>ForceIPv4</option></term>
582 <listitem><para>
583 When downloading, force to use only the IPv4 protocol.
584 </para></listitem>
585 </varlistentry>
586
587 <varlistentry><term><option>ForceIPv6</option></term>
588 <listitem><para>
589 When downloading, force to use only the IPv6 protocol.
590 </para></listitem>
591 </varlistentry>
592
593 <varlistentry><term><option>MaxReleaseFileSize</option></term>
594 <listitem><para>
595 The maximum file size of Release/Release.gpg/InRelease files.
596 The default is 10MB.
597 </para></listitem>
598 </varlistentry>
599
600 <varlistentry><term><option>AllowInsecureRepositories</option></term>
601 <listitem><para>
602 Allow the update operation to load data files from
603 a repository without a trusted signature. If enabled this
604 option no data files will be loaded and the update
605 operation fails with a error for this source. The default
606 is false for backward compatibility. This will be changed
607 in the future.
608 </para></listitem>
609 </varlistentry>
610
611 <varlistentry><term><option>AllowDowngradeToInsecureRepositories</option></term>
612 <listitem><para>
613 Allow that a repository that was previously gpg signed to become
614 unsigned durign a update operation. When there is no valid signature
615 of a perviously trusted repository apt will refuse the update. This
616 option can be used to override this protection. You almost certainly
617 never want to enable this. The default is false.
618
619 Note that apt will still consider packages from this source
620 untrusted and warn about them if you try to install
621 them.
622 </para></listitem>
623 </varlistentry>
624
625 <varlistentry><term><option>Changelogs::URI</option> scope</term>
626 <listitem><para>
627 Acquiring changelogs can only be done if an URI is known from where to get them.
628 Preferable the Release file indicates this in a 'Changelogs' field. If this isn't
629 available the Label/Origin field of the Release file is used to check if a
630 <literal>Acquire::Changelogs::URI::Label::<replaceable>LABEL</replaceable></literal> or
631 <literal>Acquire::Changelogs::URI::Origin::<replaceable>ORIGIN</replaceable></literal> option
632 exists and if so this value is taken. The value in the Release file can be overridden
633 with <literal>Acquire::Changelogs::URI::Override::Label::<replaceable>LABEL</replaceable></literal>
634 or <literal>Acquire::Changelogs::URI::Override::Origin::<replaceable>ORIGIN</replaceable></literal>.
635
636 The value should be a normal URI to a text file, expect that package specific data is
637 replaced with the placeholder <literal>CHANGEPATH</literal>. The
638 value for it is: 1. if the package is from a component (e.g. <literal>main</literal>)
639 this is the first part otherwise it is omitted, 2. the first letter of source package name,
640 expect if the source package name starts with '<literal>lib</literal>' in which case it will
641 be the first four letters. 3. The complete source package name. 4. the complete name again and
642 5. the source version.
643 The first (if present), second, third and fourth part are separated by a slash ('<literal>/</literal>')
644 and between the fourth and fifth part is an underscore ('<literal>_</literal>').
645
646 The special value '<literal>no</literal>' is available for this option indicating that
647 this source can't be used to acquire changelog files from. Another source will be tried
648 if available in this case.
649 </para></listitem>
650 </varlistentry>
651
652 </variablelist>
653 </refsect1>
654
655 <refsect1><title>Directories</title>
656
657 <para>The <literal>Dir::State</literal> section has directories that pertain to local
658 state information. <literal>lists</literal> is the directory to place downloaded
659 package lists in and <literal>status</literal> is the name of the &dpkg; status file.
660 <literal>preferences</literal> is the name of the APT <filename>preferences</filename> file.
661 <literal>Dir::State</literal> contains the default directory to prefix on all
662 sub-items if they do not start with <filename>/</filename> or <filename>./</filename>.</para>
663
664 <para><literal>Dir::Cache</literal> contains locations pertaining to local cache
665 information, such as the two package caches <literal>srcpkgcache</literal> and
666 <literal>pkgcache</literal> as well as the location to place downloaded archives,
667 <literal>Dir::Cache::archives</literal>. Generation of caches can be turned off
668 by setting <literal>pkgcache</literal> or <literal>srcpkgcache</literal> to
669 <literal>""</literal>. This will slow down startup but save disk space. It
670 is probably preferable to turn off the pkgcache rather than the srcpkgcache.
671 Like <literal>Dir::State</literal> the default directory is contained in
672 <literal>Dir::Cache</literal></para>
673
674 <para><literal>Dir::Etc</literal> contains the location of configuration files,
675 <literal>sourcelist</literal> gives the location of the sourcelist and
676 <literal>main</literal> is the default configuration file (setting has no effect,
677 unless it is done from the config file specified by
678 <envar>APT_CONFIG</envar>).</para>
679
680 <para>The <literal>Dir::Parts</literal> setting reads in all the config fragments in
681 lexical order from the directory specified. After this is done then the
682 main config file is loaded.</para>
683
684 <para>Binary programs are pointed to by <literal>Dir::Bin</literal>. <literal>Dir::Bin::Methods</literal>
685 specifies the location of the method handlers and <literal>gzip</literal>,
686 <literal>bzip2</literal>, <literal>lzma</literal>,
687 <literal>dpkg</literal>, <literal>apt-get</literal> <literal>dpkg-source</literal>
688 <literal>dpkg-buildpackage</literal> and <literal>apt-cache</literal> specify the location
689 of the respective programs.</para>
690
691 <para>
692 The configuration item <literal>RootDir</literal> has a special
693 meaning. If set, all paths in <literal>Dir::</literal> will be
694 relative to <literal>RootDir</literal>, <emphasis>even paths that
695 are specified absolutely</emphasis>. So, for instance, if
696 <literal>RootDir</literal> is set to
697 <filename>/tmp/staging</filename> and
698 <literal>Dir::State::status</literal> is set to
699 <filename>/var/lib/dpkg/status</filename>, then the status file
700 will be looked up in
701 <filename>/tmp/staging/var/lib/dpkg/status</filename>.
702 </para>
703
704 <para>
705 The <literal>Ignore-Files-Silently</literal> list can be used to specify
706 which files APT should silently ignore while parsing the files in the
707 fragment directories. Per default a file which end with <literal>.disabled</literal>,
708 <literal>~</literal>, <literal>.bak</literal> or <literal>.dpkg-[a-z]+</literal>
709 is silently ignored. As seen in the last default value these patterns can use regular
710 expression syntax.
711 </para>
712 </refsect1>
713
714 <refsect1><title>APT in DSelect</title>
715 <para>
716 When APT is used as a &dselect; method several configuration directives
717 control the default behavior. These are in the <literal>DSelect</literal> section.</para>
718
719 <variablelist>
720 <varlistentry><term><option>Clean</option></term>
721 <listitem><para>Cache Clean mode; this value may be one of
722 <literal>always</literal>, <literal>prompt</literal>,
723 <literal>auto</literal>, <literal>pre-auto</literal> and
724 <literal>never</literal>.
725 <literal>always</literal> and <literal>prompt</literal> will remove
726 all packages from the cache after upgrading, <literal>prompt</literal>
727 (the default) does so conditionally.
728 <literal>auto</literal> removes only those packages which are no longer
729 downloadable (replaced with a new version for instance).
730 <literal>pre-auto</literal> performs this action before downloading
731 new packages.</para></listitem>
732 </varlistentry>
733
734 <varlistentry><term><option>options</option></term>
735 <listitem><para>The contents of this variable are passed to &apt-get; as command line
736 options when it is run for the install phase.</para></listitem>
737 </varlistentry>
738
739 <varlistentry><term><option>Updateoptions</option></term>
740 <listitem><para>The contents of this variable are passed to &apt-get; as command line
741 options when it is run for the update phase.</para></listitem>
742 </varlistentry>
743
744 <varlistentry><term><option>PromptAfterUpdate</option></term>
745 <listitem><para>If true the [U]pdate operation in &dselect; will always prompt to continue.
746 The default is to prompt only on error.</para></listitem>
747 </varlistentry>
748 </variablelist>
749 </refsect1>
750
751 <refsect1><title>How APT calls &dpkg;</title>
752 <para>Several configuration directives control how APT invokes &dpkg;. These are
753 in the <literal>DPkg</literal> section.</para>
754
755 <variablelist>
756 <varlistentry><term><option>options</option></term>
757 <listitem><para>This is a list of options to pass to &dpkg;. The options must be specified
758 using the list notation and each list item is passed as a single argument
759 to &dpkg;.</para></listitem>
760 </varlistentry>
761
762 <varlistentry><term><option>Pre-Invoke</option></term><term><option>Post-Invoke</option></term>
763 <listitem><para>This is a list of shell commands to run before/after invoking &dpkg;.
764 Like <literal>options</literal> this must be specified in list notation. The
765 commands are invoked in order using <filename>/bin/sh</filename>; should any
766 fail APT will abort.</para></listitem>
767 </varlistentry>
768
769 <varlistentry><term><option>Pre-Install-Pkgs</option></term>
770 <listitem><para>This is a list of shell commands to run before invoking &dpkg;. Like
771 <literal>options</literal> this must be specified in list notation. The commands
772 are invoked in order using <filename>/bin/sh</filename>; should any fail APT
773 will abort. APT will pass the filenames of all .deb files it is going to
774 install to the commands, one per line on the requested file descriptor, defaulting
775 to standard input.</para>
776
777 <para>Version 2 of this protocol dumps more information, including the
778 protocol version, the APT configuration space and the packages, files
779 and versions being changed. Version 3 adds the architecture and <literal>MultiArch</literal>
780 flag to each version being dumped.</para>
781
782 <para>The version of the protocol to be used for the command
783 <literal><replaceable>cmd</replaceable></literal> can be chosen by setting
784 <literal>DPkg::Tools::options::<replaceable>cmd</replaceable>::Version</literal>
785 accordingly, the default being version 1. If APT isn't supporting the requested
786 version it will send the information in the highest version it has support for instead.
787 </para>
788
789 <para>The file descriptor to be used to send the information can be requested with
790 <literal>DPkg::Tools::options::<replaceable>cmd</replaceable>::InfoFD</literal>
791 which defaults to <literal>0</literal> for standard input and is available since
792 version 0.9.11. Support for the option can be detected by looking for the environment
793 variable <envar>APT_HOOK_INFO_FD</envar> which contains the number of the used
794 file descriptor as a confirmation.</para>
795 </listitem>
796 </varlistentry>
797
798 <varlistentry><term><option>Run-Directory</option></term>
799 <listitem><para>APT chdirs to this directory before invoking &dpkg;, the default is
800 <filename>/</filename>.</para></listitem>
801 </varlistentry>
802
803 <varlistentry><term><option>Build-options</option></term>
804 <listitem><para>These options are passed to &dpkg-buildpackage; when compiling packages;
805 the default is to disable signing and produce all binaries.</para></listitem>
806 </varlistentry>
807 </variablelist>
808
809 <refsect2><title>dpkg trigger usage (and related options)</title>
810 <para>APT can call &dpkg; in such a way as to let it make aggressive use of triggers over
811 multiple calls of &dpkg;. Without further options &dpkg; will use triggers once each time it runs.
812 Activating these options can therefore decrease the time needed to perform the
813 install or upgrade. Note that it is intended to activate these options per default in the
814 future, but as it drastically changes the way APT calls &dpkg; it needs a lot more testing.
815 <emphasis>These options are therefore currently experimental and should not be used in
816 production environments.</emphasis> It also breaks progress reporting such that all front-ends will
817 currently stay around half (or more) of the time in the 100% state while it actually configures
818 all packages.</para>
819 <para>Note that it is not guaranteed that APT will support these options or that these options will
820 not cause (big) trouble in the future. If you have understand the current risks and problems with
821 these options, but are brave enough to help testing them, create a new configuration file and test a
822 combination of options. Please report any bugs, problems and improvements you encounter and make sure
823 to note which options you have used in your reports. Asking &dpkg; for help could also be useful for
824 debugging proposes, see e.g. <command>dpkg --audit</command>. A defensive option combination would be
825 <literallayout>DPkg::NoTriggers "true";
826 PackageManager::Configure "smart";
827 DPkg::ConfigurePending "true";
828 DPkg::TriggersPending "true";</literallayout></para>
829
830 <variablelist>
831 <varlistentry><term><option>DPkg::NoTriggers</option></term>
832 <listitem><para>Add the no triggers flag to all &dpkg; calls (except the ConfigurePending call).
833 See &dpkg; if you are interested in what this actually means. In short: &dpkg; will not run the
834 triggers when this flag is present unless it is explicitly called to do so in an extra call.
835 Note that this option exists (undocumented) also in older APT versions with a slightly different
836 meaning: Previously these option only append --no-triggers to the configure calls to &dpkg; -
837 now APT will also add this flag to the unpack and remove calls.</para></listitem>
838 </varlistentry>
839 <varlistentry><term><option>PackageManager::Configure</option></term>
840 <listitem><para>Valid values are "<literal>all</literal>",
841 "<literal>smart</literal>" and "<literal>no</literal>".
842 The default value is "<literal>all</literal>", which causes APT to
843 configure all packages. The "<literal>smart</literal>" way is to
844 configure only packages which need to be configured before another
845 package can be unpacked (Pre-Depends), and let the rest be configured
846 by &dpkg; with a call generated by the ConfigurePending option (see
847 below). On the other hand, "<literal>no</literal>" will not configure
848 anything, and totally relies on &dpkg; for configuration (which at the
849 moment will fail if a Pre-Depends is encountered). Setting this option
850 to any value other than <literal>all</literal> will implicitly also
851 activate the next option by default, as otherwise the system could end
852 in an unconfigured and potentially unbootable state.</para></listitem>
853 </varlistentry>
854 <varlistentry><term><option>DPkg::ConfigurePending</option></term>
855 <listitem><para>If this option is set APT will call <command>dpkg --configure --pending</command>
856 to let &dpkg; handle all required configurations and triggers. This option is activated automatically
857 per default if the previous option is not set to <literal>all</literal>, but deactivating it could be useful
858 if you want to run APT multiple times in a row - e.g. in an installer. In these sceneries you could
859 deactivate this option in all but the last run.</para></listitem>
860 </varlistentry>
861 <varlistentry><term><option>DPkg::TriggersPending</option></term>
862 <listitem><para>Useful for the <literal>smart</literal> configuration as a package which has pending
863 triggers is not considered as <literal>installed</literal>, and &dpkg; treats them as <literal>unpacked</literal>
864 currently which is a showstopper for Pre-Dependencies (see debbugs #526774). Note that this will
865 process all triggers, not only the triggers needed to configure this package.</para></listitem>
866 </varlistentry>
867 <varlistentry><term><option>OrderList::Score::Immediate</option></term>
868 <listitem><para>Essential packages (and their dependencies) should be configured immediately
869 after unpacking. It is a good idea to do this quite early in the upgrade process as these
870 configure calls also currently require <literal>DPkg::TriggersPending</literal> which
871 will run quite a few triggers (which may not be needed). Essentials get per default a high score
872 but the immediate flag is relatively low (a package which has a Pre-Depends is rated higher).
873 These option and the others in the same group can be used to change the scoring. The following
874 example shows the settings with their default values.
875 <literallayout>OrderList::Score {
876 Delete 500;
877 Essential 200;
878 Immediate 10;
879 PreDepends 50;
880 };</literallayout>
881 </para></listitem>
882 </varlistentry>
883 </variablelist>
884 </refsect2>
885 </refsect1>
886
887 <refsect1>
888 <title>Periodic and Archives options</title>
889 <para><literal>APT::Periodic</literal> and <literal>APT::Archives</literal>
890 groups of options configure behavior of apt periodic updates, which is
891 done by the <literal>/etc/cron.daily/apt</literal> script. See the top of
892 this script for the brief documentation of these options.
893 </para>
894 </refsect1>
895
896 <refsect1>
897 <title>Debug options</title>
898 <para>
899 Enabling options in the <literal>Debug::</literal> section will
900 cause debugging information to be sent to the standard error
901 stream of the program utilizing the <literal>apt</literal>
902 libraries, or enable special program modes that are primarily
903 useful for debugging the behavior of <literal>apt</literal>.
904 Most of these options are not interesting to a normal user, but a
905 few may be:
906
907 <itemizedlist>
908 <listitem>
909 <para>
910 <literal>Debug::pkgProblemResolver</literal> enables output
911 about the decisions made by
912 <literal>dist-upgrade, upgrade, install, remove, purge</literal>.
913 </para>
914 </listitem>
915
916 <listitem>
917 <para>
918 <literal>Debug::NoLocking</literal> disables all file
919 locking. This can be used to run some operations (for
920 instance, <literal>apt-get -s install</literal>) as a
921 non-root user.
922 </para>
923 </listitem>
924
925 <listitem>
926 <para>
927 <literal>Debug::pkgDPkgPM</literal> prints out the actual
928 command line each time that <literal>apt</literal> invokes
929 &dpkg;.
930 </para>
931 </listitem>
932
933 <listitem>
934 <para>
935 <literal>Debug::IdentCdrom</literal> disables the inclusion
936 of statfs data in CD-ROM IDs. <!-- TODO: provide a
937 motivating example, except I haven't a clue why you'd want
938 to do this. -->
939 </para>
940 </listitem>
941 </itemizedlist>
942 </para>
943
944 <para>
945 A full list of debugging options to apt follows.
946 </para>
947
948 <variablelist>
949 <varlistentry>
950 <term><option>Debug::Acquire::cdrom</option></term>
951
952 <listitem>
953 <para>
954 Print information related to accessing
955 <literal>cdrom://</literal> sources.
956 </para>
957 </listitem>
958 </varlistentry>
959
960 <varlistentry>
961 <term><option>Debug::Acquire::ftp</option></term>
962
963 <listitem>
964 <para>
965 Print information related to downloading packages using
966 FTP.
967 </para>
968 </listitem>
969 </varlistentry>
970
971 <varlistentry>
972 <term><option>Debug::Acquire::http</option></term>
973
974 <listitem>
975 <para>
976 Print information related to downloading packages using
977 HTTP.
978 </para>
979 </listitem>
980 </varlistentry>
981
982 <varlistentry>
983 <term><option>Debug::Acquire::https</option></term>
984
985 <listitem>
986 <para>
987 Print information related to downloading packages using
988 HTTPS.
989 </para>
990 </listitem>
991 </varlistentry>
992
993 <varlistentry>
994 <term><option>Debug::Acquire::gpgv</option></term>
995
996 <listitem>
997 <para>
998 Print information related to verifying cryptographic
999 signatures using <literal>gpg</literal>.
1000 </para>
1001 </listitem>
1002 </varlistentry>
1003
1004 <varlistentry>
1005 <term><option>Debug::aptcdrom</option></term>
1006
1007 <listitem>
1008 <para>
1009 Output information about the process of accessing
1010 collections of packages stored on CD-ROMs.
1011 </para>
1012 </listitem>
1013 </varlistentry>
1014
1015 <varlistentry>
1016 <term><option>Debug::BuildDeps</option></term>
1017 <listitem>
1018 <para>
1019 Describes the process of resolving build-dependencies in
1020 &apt-get;.
1021 </para>
1022 </listitem>
1023 </varlistentry>
1024
1025 <varlistentry>
1026 <term><option>Debug::Hashes</option></term>
1027 <listitem>
1028 <para>
1029 Output each cryptographic hash that is generated by the
1030 <literal>apt</literal> libraries.
1031 </para>
1032 </listitem>
1033 </varlistentry>
1034
1035 <varlistentry>
1036 <term><option>Debug::IdentCDROM</option></term>
1037 <listitem>
1038 <para>
1039 Do not include information from <literal>statfs</literal>,
1040 namely the number of used and free blocks on the CD-ROM
1041 filesystem, when generating an ID for a CD-ROM.
1042 </para>
1043 </listitem>
1044 </varlistentry>
1045
1046 <varlistentry>
1047 <term><option>Debug::NoLocking</option></term>
1048 <listitem>
1049 <para>
1050 Disable all file locking. For instance, this will allow
1051 two instances of <quote><literal>apt-get
1052 update</literal></quote> to run at the same time.
1053 </para>
1054 </listitem>
1055 </varlistentry>
1056
1057 <varlistentry>
1058 <term><option>Debug::pkgAcquire</option></term>
1059
1060 <listitem>
1061 <para>
1062 Log when items are added to or removed from the global
1063 download queue.
1064 </para>
1065 </listitem>
1066 </varlistentry>
1067
1068 <varlistentry>
1069 <term><option>Debug::pkgAcquire::Auth</option></term>
1070 <listitem>
1071 <para>
1072 Output status messages and errors related to verifying
1073 checksums and cryptographic signatures of downloaded files.
1074 </para>
1075 </listitem>
1076 </varlistentry>
1077
1078 <varlistentry>
1079 <term><option>Debug::pkgAcquire::Diffs</option></term>
1080 <listitem>
1081 <para>
1082 Output information about downloading and applying package
1083 index list diffs, and errors relating to package index list
1084 diffs.
1085 </para>
1086 </listitem>
1087 </varlistentry>
1088
1089 <varlistentry>
1090 <term><option>Debug::pkgAcquire::RRed</option></term>
1091
1092 <listitem>
1093 <para>
1094 Output information related to patching apt package lists
1095 when downloading index diffs instead of full indices.
1096 </para>
1097 </listitem>
1098 </varlistentry>
1099
1100 <varlistentry>
1101 <term><option>Debug::pkgAcquire::Worker</option></term>
1102
1103 <listitem>
1104 <para>
1105 Log all interactions with the sub-processes that actually
1106 perform downloads.
1107 </para>
1108 </listitem>
1109 </varlistentry>
1110
1111 <varlistentry>
1112 <term><option>Debug::pkgAutoRemove</option></term>
1113
1114 <listitem>
1115 <para>
1116 Log events related to the automatically-installed status of
1117 packages and to the removal of unused packages.
1118 </para>
1119 </listitem>
1120 </varlistentry>
1121
1122 <varlistentry>
1123 <term><option>Debug::pkgDepCache::AutoInstall</option></term>
1124 <listitem>
1125 <para>
1126 Generate debug messages describing which packages are being
1127 automatically installed to resolve dependencies. This
1128 corresponds to the initial auto-install pass performed in,
1129 e.g., <literal>apt-get install</literal>, and not to the
1130 full <literal>apt</literal> dependency resolver; see
1131 <literal>Debug::pkgProblemResolver</literal> for that.
1132 </para>
1133 </listitem>
1134 </varlistentry>
1135
1136 <varlistentry>
1137 <term><option>Debug::pkgDepCache::Marker</option></term>
1138 <listitem>
1139 <para>
1140 Generate debug messages describing which packages are marked
1141 as keep/install/remove while the ProblemResolver does his work.
1142 Each addition or deletion may trigger additional actions;
1143 they are shown indented two additional spaces under the original entry.
1144 The format for each line is <literal>MarkKeep</literal>,
1145 <literal>MarkDelete</literal> or <literal>MarkInstall</literal> followed by
1146 <literal>package-name &lt;a.b.c -&gt; d.e.f | x.y.z&gt; (section)</literal>
1147 where <literal>a.b.c</literal> is the current version of the package,
1148 <literal>d.e.f</literal> is the version considered for installation and
1149 <literal>x.y.z</literal> is a newer version, but not considered for installation
1150 (because of a low pin score). The later two can be omitted if there is none or if
1151 it is the same as the installed version.
1152 <literal>section</literal> is the name of the section the package appears in.
1153 </para>
1154 </listitem>
1155 </varlistentry>
1156
1157 <varlistentry>
1158 <term><option>Debug::pkgDPkgPM</option></term>
1159 <listitem>
1160 <para>
1161 When invoking &dpkg;, output the precise command line with
1162 which it is being invoked, with arguments separated by a
1163 single space character.
1164 </para>
1165 </listitem>
1166 </varlistentry>
1167
1168 <varlistentry>
1169 <term><option>Debug::pkgDPkgProgressReporting</option></term>
1170 <listitem>
1171 <para>
1172 Output all the data received from &dpkg; on the status file
1173 descriptor and any errors encountered while parsing it.
1174 </para>
1175 </listitem>
1176 </varlistentry>
1177
1178 <varlistentry>
1179 <term><option>Debug::pkgOrderList</option></term>
1180
1181 <listitem>
1182 <para>
1183 Generate a trace of the algorithm that decides the order in
1184 which <literal>apt</literal> should pass packages to
1185 &dpkg;.
1186 </para>
1187 </listitem>
1188 </varlistentry>
1189
1190 <varlistentry>
1191 <term><option>Debug::pkgPackageManager</option></term>
1192
1193 <listitem>
1194 <para>
1195 Output status messages tracing the steps performed when
1196 invoking &dpkg;.
1197 </para>
1198 </listitem>
1199 </varlistentry>
1200
1201 <varlistentry>
1202 <term><option>Debug::pkgPolicy</option></term>
1203
1204 <listitem>
1205 <para>
1206 Output the priority of each package list on startup.
1207 </para>
1208 </listitem>
1209 </varlistentry>
1210
1211 <varlistentry>
1212 <term><option>Debug::pkgProblemResolver</option></term>
1213
1214 <listitem>
1215 <para>
1216 Trace the execution of the dependency resolver (this
1217 applies only to what happens when a complex dependency
1218 problem is encountered).
1219 </para>
1220 </listitem>
1221 </varlistentry>
1222
1223 <varlistentry>
1224 <term><option>Debug::pkgProblemResolver::ShowScores</option></term>
1225 <listitem>
1226 <para>
1227 Display a list of all installed packages with their calculated score
1228 used by the pkgProblemResolver. The description of the package
1229 is the same as described in <literal>Debug::pkgDepCache::Marker</literal>
1230 </para>
1231 </listitem>
1232 </varlistentry>
1233
1234 <varlistentry>
1235 <term><option>Debug::sourceList</option></term>
1236
1237 <listitem>
1238 <para>
1239 Print information about the vendors read from
1240 <filename>/etc/apt/vendors.list</filename>.
1241 </para>
1242 </listitem>
1243 </varlistentry>
1244
1245 <varlistentry>
1246 <term><option>Debug::RunScripts</option></term>
1247 <listitem>
1248 <para>
1249 Display the external commands that are called by apt hooks.
1250 This includes e.g. the config options
1251 <literal>DPkg::{Pre,Post}-Invoke</literal> or
1252 <literal>APT::Update::{Pre,Post}-Invoke</literal>.
1253 </para>
1254 </listitem>
1255 </varlistentry>
1256
1257 <!-- 2009/07/11 Currently used nowhere. The corresponding code
1258 is commented.
1259 <varlistentry>
1260 <term><literal>Debug::Vendor</literal></term>
1261
1262 <listitem>
1263 <para>
1264 Print information about each vendor.
1265 </para>
1266 </listitem>
1267 </varlistentry>
1268 -->
1269
1270 </variablelist>
1271 </refsect1>
1272
1273 <refsect1><title>Examples</title>
1274 <para>&configureindex; is a
1275 configuration file showing example values for all possible
1276 options.</para>
1277 </refsect1>
1278
1279 <refsect1><title>Files</title>
1280 <variablelist>
1281 &file-aptconf;
1282 </variablelist>
1283 </refsect1>
1284
1285 <refsect1><title>See Also</title>
1286 <para>&apt-cache;, &apt-config;<!-- ? reading apt.conf -->, &apt-preferences;.</para>
1287 </refsect1>
1288
1289 &manbugs;
1290
1291 </refentry>
1292