]> git.saurik.com Git - apt.git/blame - doc/apt.conf.5.xml
Only run Download-Upgradable and Unattended-Upgrades if the initial
[apt.git] / doc / apt.conf.5.xml
CommitLineData
24f6490f
AL
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
5<!ENTITY % aptent SYSTEM "apt.ent">
6%aptent;
7
8]>
9
10<refentry>
5e80de29
AL
11
12 <refentryinfo>
13 &apt-author.jgunthorpe;
14 &apt-author.team;
be1b8568
EL
15 <author>
16 <firstname>Daniel</firstname>
17 <surname>Burrows</surname>
18 <contrib>Initial documentation of Debug::*.</contrib>
19 <email>dburrows@debian.org</email>
20 </author>
5e80de29
AL
21 &apt-email;
22 &apt-product;
23 <!-- The last update date -->
be1b8568 24 <date>06 December 2008</date>
5e80de29 25 </refentryinfo>
24f6490f
AL
26
27 <refmeta>
28 <refentrytitle>apt.conf</refentrytitle>
29 <manvolnum>5</manvolnum>
30 </refmeta>
31
32 <!-- Man page title -->
33 <refnamediv>
34 <refname>apt.conf</refname>
35 <refpurpose>Configuration file for APT</refpurpose>
36 </refnamediv>
37
38 <refsect1><title>Description</title>
39 <para><filename>apt.conf</filename> is the main configuration file for the APT suite of
40 tools, all tools make use of the configuration file and a common command line
41 parser to provide a uniform environment. When an APT tool starts up it will
42 read the configuration specified by the <envar>APT_CONFIG</envar> environment
43 variable (if any) and then read the files in <literal>Dir::Etc::Parts</literal>
44 then read the main configuration file specified by
45 <literal>Dir::Etc::main</literal> then finally apply the
46 command line options to override the configuration directives, possibly
47 loading even more config files.</para>
48
49 <para>The configuration file is organized in a tree with options organized into
50 functional groups. option specification is given with a double colon
51 notation, for instance <literal>APT::Get::Assume-Yes</literal> is an option within
52 the APT tool group, for the Get tool. options do not inherit from their
53 parent groups.</para>
54
e3a1f08d 55 <para>Syntactically the configuration language is modeled after what the ISC tools
24f6490f
AL
56 such as bind and dhcp use. Lines starting with
57 <literal>//</literal> are treated as comments (ignored).
58 Each line is of the form
59 <literal>APT::Get::Assume-Yes "true";</literal> The trailing
60 semicolon is required and the quotes are optional. A new scope can be
61 opened with curly braces, like:</para>
62
63<informalexample><programlisting>
64APT {
65 Get {
66 Assume-Yes "true";
67 Fix-Broken "true";
68 };
69};
70</programlisting></informalexample>
71
72 <para>with newlines placed to make it more readable. Lists can be created by
73 opening a scope and including a single word enclosed in quotes followed by a
74 semicolon. Multiple entries can be included, each separated by a semicolon.</para>
75
76<informalexample><programlisting>
77DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
78</programlisting></informalexample>
79
80 <para>In general the sample configuration file in
81 <filename>&docdir;examples/apt.conf</filename> &configureindex;
82 is a good guide for how it should look.</para>
83
fb3b7ef0
LB
84 <para>The names of the configuration items are not case-sensitive. So in the previous example
85 you could use <literal>dpkg::pre-install-pkgs</literal>.</para>
86
24f6490f
AL
87 <para>Two specials are allowed, <literal>#include</literal> and <literal>#clear</literal>
88 <literal>#include</literal> will include the given file, unless the filename
89 ends in a slash, then the whole directory is included.
90 <literal>#clear</literal> is used to erase a list of names.</para>
91
92 <para>All of the APT tools take a -o option which allows an arbitrary configuration
93 directive to be specified on the command line. The syntax is a full option
94 name (<literal>APT::Get::Assume-Yes</literal> for instance) followed by an equals
95 sign then the new value of the option. Lists can be appended too by adding
96 a trailing :: to the list name.</para>
97 </refsect1>
98
99 <refsect1><title>The APT Group</title>
100 <para>This group of options controls general APT behavior as well as holding the
101 options for all of the tools.</para>
102
103 <variablelist>
104 <varlistentry><term>Architecture</term>
105 <listitem><para>System Architecture; sets the architecture to use when fetching files and
106 parsing package lists. The internal default is the architecture apt was
107 compiled for.</para></listitem>
108 </varlistentry>
109
60a8f9c0
EL
110 <varlistentry><term>Default-Release</term>
111 <listitem><para>Default release to install packages from if more than one
112 version available. Contains release name or release version. Examples: 'stable', 'testing', 'unstable', '4.0', '5.0*'. Release codenames ('etch', 'lenny' etc.) are not allowed now. See also &apt-preferences;.</para></listitem>
113 </varlistentry>
114
24f6490f
AL
115 <varlistentry><term>Ignore-Hold</term>
116 <listitem><para>Ignore Held packages; This global option causes the problem resolver to
117 ignore held packages in its decision making.</para></listitem>
118 </varlistentry>
119
120 <varlistentry><term>Clean-Installed</term>
121 <listitem><para>Defaults to on. When turned on the autoclean feature will remove any packages
122 which can no longer be downloaded from the cache. If turned off then
123 packages that are locally installed are also excluded from cleaning - but
124 note that APT provides no direct means to reinstall them.</para></listitem>
125 </varlistentry>
126
127 <varlistentry><term>Immediate-Configure</term>
128 <listitem><para>Disable Immediate Configuration; This dangerous option disables some
129 of APT's ordering code to cause it to make fewer dpkg calls. Doing
130 so may be necessary on some extremely slow single user systems but
131 is very dangerous and may cause package install scripts to fail or worse.
132 Use at your own risk.</para></listitem>
133 </varlistentry>
134
135 <varlistentry><term>Force-LoopBreak</term>
136 <listitem><para>Never Enable this option unless you -really- know what you are doing. It
137 permits APT to temporarily remove an essential package to break a
138 Conflicts/Conflicts or Conflicts/Pre-Depend loop between two essential
139 packages. SUCH A LOOP SHOULD NEVER EXIST AND IS A GRAVE BUG. This option
140 will work if the essential packages are not tar, gzip, libc, dpkg, bash or
141 anything that those packages depend on.</para></listitem>
142 </varlistentry>
143
144 <varlistentry><term>Cache-Limit</term>
145 <listitem><para>APT uses a fixed size memory mapped cache file to store the 'available'
a04c23d7 146 information. This sets the size of that cache (in bytes).</para></listitem>
24f6490f
AL
147 </varlistentry>
148
149 <varlistentry><term>Build-Essential</term>
150 <listitem><para>Defines which package(s) are considered essential build dependencies.</para></listitem>
151 </varlistentry>
152
153 <varlistentry><term>Get</term>
154 <listitem><para>The Get subsection controls the &apt-get; tool, please see its
155 documentation for more information about the options here.</para></listitem>
156 </varlistentry>
157
158 <varlistentry><term>Cache</term>
159 <listitem><para>The Cache subsection controls the &apt-cache; tool, please see its
160 documentation for more information about the options here.</para></listitem>
161 </varlistentry>
162
163 <varlistentry><term>CDROM</term>
164 <listitem><para>The CDROM subsection controls the &apt-cdrom; tool, please see its
165 documentation for more information about the options here.</para></listitem>
166 </varlistentry>
167 </variablelist>
168 </refsect1>
169
170 <refsect1><title>The Acquire Group</title>
171 <para>The <literal>Acquire</literal> group of options controls the download of packages
172 and the URI handlers.
173
174 <variablelist>
0d70b055
EL
175 <varlistentry><term>PDiffs</term>
176 <listitem><para>Try do download deltas called <literal>PDiffs</literal> for
177 Packages or Sources files instead of downloading whole ones. True
178 by default.</para></listitem>
179 </varlistentry>
180
24f6490f
AL
181 <varlistentry><term>Queue-Mode</term>
182 <listitem><para>Queuing mode; <literal>Queue-Mode</literal> can be one of <literal>host</literal> or
183 <literal>access</literal> which determines how APT parallelizes outgoing
184 connections. <literal>host</literal> means that one connection per target host
185 will be opened, <literal>access</literal> means that one connection per URI type
186 will be opened.</para></listitem>
187 </varlistentry>
188
189 <varlistentry><term>Retries</term>
190 <listitem><para>Number of retries to perform. If this is non-zero APT will retry failed
191 files the given number of times.</para></listitem>
192 </varlistentry>
193
194 <varlistentry><term>Source-Symlinks</term>
195 <listitem><para>Use symlinks for source archives. If set to true then source archives will
196 be symlinked when possible instead of copying. True is the default.</para></listitem>
197 </varlistentry>
198
199 <varlistentry><term>http</term>
200 <listitem><para>HTTP URIs; http::Proxy is the default http proxy to use. It is in the
201 standard form of <literal>http://[[user][:pass]@]host[:port]/</literal>. Per
202 host proxies can also be specified by using the form
203 <literal>http::Proxy::&lt;host&gt;</literal> with the special keyword <literal>DIRECT</literal>
204 meaning to use no proxies. The <envar>http_proxy</envar> environment variable
205 will override all settings.</para>
206
207 <para>Three settings are provided for cache control with HTTP/1.1 compliant
208 proxy caches. <literal>No-Cache</literal> tells the proxy to not use its cached
209 response under any circumstances, <literal>Max-Age</literal> is sent only for
210 index files and tells the cache to refresh its object if it is older than
211 the given number of seconds. Debian updates its index files daily so the
212 default is 1 day. <literal>No-Store</literal> specifies that the cache should never
213 store this request, it is only set for archive files. This may be useful
214 to prevent polluting a proxy cache with very large .deb files. Note:
215 Squid 2.0.2 does not support any of these options.</para>
216
217 <para>The option <literal>timeout</literal> sets the timeout timer used by the method,
218 this applies to all things including connection timeout and data timeout.</para>
219
220 <para>One setting is provided to control the pipeline depth in cases where the
221 remote server is not RFC conforming or buggy (such as Squid 2.0.2)
222 <literal>Acquire::http::Pipeline-Depth</literal> can be a value from 0 to 5
223 indicating how many outstanding requests APT should send. A value of
224 zero MUST be specified if the remote host does not properly linger
225 on TCP connections - otherwise data corruption will occur. Hosts which
226 require this are in violation of RFC 2068.</para></listitem>
227 </varlistentry>
228
370ad5e1
EL
229 <varlistentry><term>https</term>
230 <listitem><para>HTTPS URIs. Cache-control and proxy options are the same as for
231 <literal>http</literal> method.
232 <literal>Pipeline-Depth</literal> option is not supported yet.</para>
233
234 <para><literal>CaInfo</literal> suboption specifies place of file that
235 holds info about trusted certificates.
236 <literal>&lt;host&gt;::CaInfo</literal> is corresponding per-host option.
237 <literal>Verify-Peer</literal> boolean suboption determines whether verify
238 server's host certificate against trusted certificates or not.
239 <literal>&lt;host&gt;::Verify-Peer</literal> is corresponding per-host option.
240 <literal>Verify-Host</literal> boolean suboption determines whether verify
241 server's hostname or not.
242 <literal>&lt;host&gt;::Verify-Host</literal> is corresponding per-host option.
243 <literal>SslCert</literal> determines what certificate to use for client
244 authentication. <literal>&lt;host&gt;::SslCert</literal> is corresponding per-host option.
245 <literal>SslKey</literal> determines what private key to use for client
246 authentication. <literal>&lt;host&gt;::SslKey</literal> is corresponding per-host option.
247 <literal>SslForceVersion</literal> overrides default SSL version to use.
248 Can contain 'TLSv1' or 'SSLv3' string.
249 <literal>&lt;host&gt;::SslForceVersion</literal> is corresponding per-host option.
250 </para></listitem></varlistentry>
251
24f6490f
AL
252 <varlistentry><term>ftp</term>
253 <listitem><para>FTP URIs; ftp::Proxy is the default proxy server to use. It is in the
254 standard form of <literal>ftp://[[user][:pass]@]host[:port]/</literal> and is
255 overridden by the <envar>ftp_proxy</envar> environment variable. To use a ftp
256 proxy you will have to set the <literal>ftp::ProxyLogin</literal> script in the
257 configuration file. This entry specifies the commands to send to tell
258 the proxy server what to connect to. Please see
259 &configureindex; for an example of
e3a1f08d 260 how to do this. The substitution variables available are
24f6490f
AL
261 <literal>$(PROXY_USER)</literal> <literal>$(PROXY_PASS)</literal> <literal>$(SITE_USER)</literal>
262 <literal>$(SITE_PASS)</literal> <literal>$(SITE)</literal> and <literal>$(SITE_PORT)</literal>
263 Each is taken from it's respective URI component.</para>
264
265 <para>The option <literal>timeout</literal> sets the timeout timer used by the method,
266 this applies to all things including connection timeout and data timeout.</para>
267
268 <para>Several settings are provided to control passive mode. Generally it is
269 safe to leave passive mode on, it works in nearly every environment.
270 However some situations require that passive mode be disabled and port
271 mode ftp used instead. This can be done globally, for connections that
272 go through a proxy or for a specific host (See the sample config file
273 for examples).</para>
274
275 <para>It is possible to proxy FTP over HTTP by setting the <envar>ftp_proxy</envar>
276 environment variable to a http url - see the discussion of the http method
277 above for syntax. You cannot set this in the configuration file and it is
278 not recommended to use FTP over HTTP due to its low efficiency.</para>
279
280 <para>The setting <literal>ForceExtended</literal> controls the use of RFC2428
e3a1f08d 281 <literal>EPSV</literal> and <literal>EPRT</literal> commands. The default is false, which means
24f6490f
AL
282 these commands are only used if the control connection is IPv6. Setting this
283 to true forces their use even on IPv4 connections. Note that most FTP servers
284 do not support RFC2428.</para></listitem>
285 </varlistentry>
286
287 <varlistentry><term>cdrom</term>
288 <listitem><para>CDROM URIs; the only setting for CDROM URIs is the mount point,
289 <literal>cdrom::Mount</literal> which must be the mount point for the CDROM drive
290 as specified in <filename>/etc/fstab</filename>. It is possible to provide
291 alternate mount and unmount commands if your mount point cannot be listed
292 in the fstab (such as an SMB mount and old mount packages). The syntax
293 is to put <literallayout>"/cdrom/"::Mount "foo";</literallayout> within
294 the cdrom block. It is important to have the trailing slash. Unmount
295 commands can be specified using UMount.</para></listitem>
296 </varlistentry>
8a3642bd
MV
297
298 <varlistentry><term>gpgv</term>
299 <listitem><para>GPGV URIs; the only option for GPGV URIs is the option to pass additional parameters to gpgv.
300 <literal>gpgv::Options</literal> Additional options passed to gpgv.
301 </para></listitem>
302 </varlistentry>
303
24f6490f
AL
304 </variablelist>
305 </para>
306 </refsect1>
307
308 <refsect1><title>Directories</title>
309
310 <para>The <literal>Dir::State</literal> section has directories that pertain to local
311 state information. <literal>lists</literal> is the directory to place downloaded
312 package lists in and <literal>status</literal> is the name of the dpkg status file.
313 <literal>preferences</literal> is the name of the APT preferences file.
314 <literal>Dir::State</literal> contains the default directory to prefix on all sub
315 items if they do not start with <filename>/</filename> or <filename>./</filename>.</para>
316
317 <para><literal>Dir::Cache</literal> contains locations pertaining to local cache
318 information, such as the two package caches <literal>srcpkgcache</literal> and
319 <literal>pkgcache</literal> as well as the location to place downloaded archives,
320 <literal>Dir::Cache::archives</literal>. Generation of caches can be turned off
321 by setting their names to be blank. This will slow down startup but
e3a1f08d 322 save disk space. It is probably preferred to turn off the pkgcache rather
24f6490f
AL
323 than the srcpkgcache. Like <literal>Dir::State</literal> the default
324 directory is contained in <literal>Dir::Cache</literal></para>
325
326 <para><literal>Dir::Etc</literal> contains the location of configuration files,
327 <literal>sourcelist</literal> gives the location of the sourcelist and
328 <literal>main</literal> is the default configuration file (setting has no effect,
329 unless it is done from the config file specified by
13e8426f 330 <envar>APT_CONFIG</envar>).</para>
24f6490f
AL
331
332 <para>The <literal>Dir::Parts</literal> setting reads in all the config fragments in
333 lexical order from the directory specified. After this is done then the
334 main config file is loaded.</para>
335
336 <para>Binary programs are pointed to by <literal>Dir::Bin</literal>. <literal>Dir::Bin::Methods</literal>
337 specifies the location of the method handlers and <literal>gzip</literal>,
338 <literal>dpkg</literal>, <literal>apt-get</literal> <literal>dpkg-source</literal>
339 <literal>dpkg-buildpackage</literal> and <literal>apt-cache</literal> specify the location
340 of the respective programs.</para>
db2cca11
OS
341
342 <para>
343 The configuration item <literal>RootDir</literal> has a special
344 meaning. If set, all paths in <literal>Dir::</literal> will be
345 relative to <literal>RootDir</literal>, <emphasis>even paths that
346 are specified absolutely</emphasis>. So, for instance, if
347 <literal>RootDir</literal> is set to
348 <filename>/tmp/staging</filename> and
349 <literal>Dir::State::status</literal> is set to
350 <filename>/var/lib/dpkg/status</filename>, then the status file
351 will be looked up in
352 <filename>/tmp/staging/var/lib/dpkg/status</filename>.
353 </para>
24f6490f
AL
354 </refsect1>
355
356 <refsect1><title>APT in DSelect</title>
357 <para>
358 When APT is used as a &dselect; method several configuration directives
359 control the default behaviour. These are in the <literal>DSelect</literal> section.</para>
360
361 <variablelist>
362 <varlistentry><term>Clean</term>
363 <listitem><para>Cache Clean mode; this value may be one of always, prompt, auto,
364 pre-auto and never. always and prompt will remove all packages from
365 the cache after upgrading, prompt (the default) does so conditionally.
366 auto removes only those packages which are no longer downloadable
367 (replaced with a new version for instance). pre-auto performs this
368 action before downloading new packages.</para></listitem>
369 </varlistentry>
370
371 <varlistentry><term>options</term>
372 <listitem><para>The contents of this variable is passed to &apt-get; as command line
373 options when it is run for the install phase.</para></listitem>
374 </varlistentry>
375
376 <varlistentry><term>Updateoptions</term>
377 <listitem><para>The contents of this variable is passed to &apt-get; as command line
378 options when it is run for the update phase.</para></listitem>
379 </varlistentry>
380
381 <varlistentry><term>PromptAfterUpdate</term>
382 <listitem><para>If true the [U]pdate operation in &dselect; will always prompt to continue.
383 The default is to prompt only on error.</para></listitem>
384 </varlistentry>
385 </variablelist>
386 </refsect1>
387
388 <refsect1><title>How APT calls dpkg</title>
389 <para>Several configuration directives control how APT invokes &dpkg;. These are
390 in the <literal>DPkg</literal> section.</para>
391
392 <variablelist>
393 <varlistentry><term>options</term>
394 <listitem><para>This is a list of options to pass to dpkg. The options must be specified
395 using the list notation and each list item is passed as a single argument
396 to &dpkg;.</para></listitem>
397 </varlistentry>
398
399 <varlistentry><term>Pre-Invoke</term><term>Post-Invoke</term>
400 <listitem><para>This is a list of shell commands to run before/after invoking &dpkg;.
401 Like <literal>options</literal> this must be specified in list notation. The
402 commands are invoked in order using <filename>/bin/sh</filename>, should any
403 fail APT will abort.</para></listitem>
404 </varlistentry>
405
406 <varlistentry><term>Pre-Install-Pkgs</term>
407 <listitem><para>This is a list of shell commands to run before invoking dpkg. Like
408 <literal>options</literal> this must be specified in list notation. The commands
409 are invoked in order using <filename>/bin/sh</filename>, should any fail APT
410 will abort. APT will pass to the commands on standard input the
411 filenames of all .deb files it is going to install, one per line.</para>
412
413 <para>Version 2 of this protocol dumps more information, including the
414 protocol version, the APT configuration space and the packages, files
415 and versions being changed. Version 2 is enabled by setting
416 <literal>DPkg::Tools::options::cmd::Version</literal> to 2. <literal>cmd</literal> is a
417 command given to <literal>Pre-Install-Pkgs</literal>.</para></listitem>
418 </varlistentry>
419
420 <varlistentry><term>Run-Directory</term>
421 <listitem><para>APT chdirs to this directory before invoking dpkg, the default is
422 <filename>/</filename>.</para></listitem>
423 </varlistentry>
424
425 <varlistentry><term>Build-options</term>
426 <listitem><para>These options are passed to &dpkg-buildpackage; when compiling packages,
427 the default is to disable signing and produce all binaries.</para></listitem>
428 </varlistentry>
429 </variablelist>
430 </refsect1>
431
0224daf2
EL
432 <refsect1>
433 <title>Periodic and Archives options</title>
434 <para><literal>APT::Periodic</literal> and <literal>APT::Archives</literal>
435 groups of options configure behavior of apt periodic updates, which is
436 done by <literal>/etc/cron.daily/apt</literal> script. See header of
437 this script for the brief documentation of these options.
438 </para>
439 </refsect1>
440
be1b8568
EL
441 <refsect1>
442 <title>Debug options</title>
443 <para>
444 Enabling options in the <literal>Debug::</literal> section will
445 cause debugging information to be sent to the standard error
446 stream of the program utilizing the <literal>apt</literal>
447 libraries, or enable special program modes that are primarily
448 useful for debugging the behavior of <literal>apt</literal>.
449 Most of these options are not interesting to a normal user, but a
450 few may be:
451
452 <itemizedlist>
453 <listitem>
454 <para>
455 <literal>Debug::pkgProblemResolver</literal> enables output
456 about the decisions made by
457 <literal>dist-upgrade, upgrade, install, remove, purge</literal>.
458 </para>
459 </listitem>
460
461 <listitem>
462 <para>
463 <literal>Debug::NoLocking</literal> disables all file
464 locking. This can be used to run some operations (for
465 instance, <literal>apt-get -s install</literal>) as a
466 non-root user.
467 </para>
468 </listitem>
469
470 <listitem>
471 <para>
472 <literal>Debug::pkgDPkgPM</literal> prints out the actual
473 command line each time that <literal>apt</literal> invokes
474 &dpkg;.
475 </para>
476 </listitem>
477
478 <listitem>
479 <para>
480 <literal>Debug::IdentCdrom</literal> disables the inclusion
481 of statfs data in CDROM IDs. <!-- TODO: provide a
482 motivating example, except I haven't a clue why you'd want
483 to do this. -->
484 </para>
485 </listitem>
486 </itemizedlist>
8a3642bd 487 </para>
be1b8568
EL
488
489 <para>
490 A full list of debugging options to apt follows.
491 </para>
492
493 <variablelist>
494 <varlistentry>
495 <term><literal>Debug::Acquire::cdrom</literal></term>
496
497 <listitem>
498 <para>
499 Print information related to accessing
500 <literal>cdrom://</literal> sources.
501 </para>
502 </listitem>
503 </varlistentry>
504
505 <varlistentry>
506 <term><literal>Debug::Acquire::ftp</literal></term>
507
508 <listitem>
509 <para>
510 Print information related to downloading packages using
511 FTP.
512 </para>
513 </listitem>
514 </varlistentry>
515
516 <varlistentry>
517 <term><literal>Debug::Acquire::http</literal></term>
518
519 <listitem>
520 <para>
521 Print information related to downloading packages using
522 HTTP.
523 </para>
524 </listitem>
525 </varlistentry>
526
527 <varlistentry>
528 <term><literal>Debug::Acquire::https</literal></term>
529
530 <listitem>
531 <para>
532 Print information related to downloading packages using
533 HTTPS.
534 </para>
535 </listitem>
536 </varlistentry>
537
538 <varlistentry>
539 <term><literal>Debug::Acquire::gpgv</literal></term>
540
541 <listitem>
542 <para>
543 Print information related to verifying cryptographic
544 signatures using <literal>gpg</literal>.
545 </para>
546 </listitem>
547 </varlistentry>
548
549 <varlistentry>
550 <term><literal>Debug::aptcdrom</literal></term>
551
552 <listitem>
553 <para>
554 Output information about the process of accessing
555 collections of packages stored on CD-ROMs.
556 </para>
557 </listitem>
558 </varlistentry>
559
560 <varlistentry>
561 <term><literal>Debug::BuildDeps</literal></term>
562 <listitem>
563 <para>
564 Describes the process of resolving build-dependencies in
565 &apt-get;.
566 </para>
567 </listitem>
568 </varlistentry>
569
570 <varlistentry>
571 <term><literal>Debug::Hashes</literal></term>
572 <listitem>
573 <para>
574 Output each cryptographic hash that is generated by the
575 <literal>apt</literal> libraries.
576 </para>
577 </listitem>
578 </varlistentry>
579
580 <varlistentry>
581 <term><literal>Debug::IdentCDROM</literal></term>
582 <listitem>
583 <para>
584 Do not include information from <literal>statfs</literal>,
585 namely the number of used and free blocks on the CD-ROM
586 filesystem, when generating an ID for a CD-ROM.
587 </para>
588 </listitem>
589 </varlistentry>
590
591 <varlistentry>
592 <term><literal>Debug::NoLocking</literal></term>
593 <listitem>
594 <para>
595 Disable all file locking. For instance, this will allow
596 two instances of <quote><literal>apt-get
597 update</literal></quote> to run at the same time.
598 </para>
599 </listitem>
600 </varlistentry>
601
602 <varlistentry>
603 <term><literal>Debug::pkgAcquire</literal></term>
604
605 <listitem>
606 <para>
607 Log when items are added to or removed from the global
608 download queue.
609 </para>
610 </listitem>
611 </varlistentry>
612
613 <varlistentry>
614 <term><literal>Debug::pkgAcquire::Auth</literal></term>
615 <listitem>
616 <para>
617 Output status messages and errors related to verifying
618 checksums and cryptographic signatures of downloaded files.
619 </para>
620 </listitem>
621 </varlistentry>
622
623 <varlistentry>
624 <term><literal>Debug::pkgAcquire::Diffs</literal></term>
625 <listitem>
626 <para>
627 Output information about downloading and applying package
628 index list diffs, and errors relating to package index list
629 diffs.
630 </para>
631 </listitem>
632 </varlistentry>
633
634 <varlistentry>
635 <term><literal>Debug::pkgAcquire::RRed</literal></term>
636
637 <listitem>
638 <para>
639 Output information related to patching apt package lists
640 when downloading index diffs instead of full indices.
641 </para>
642 </listitem>
643 </varlistentry>
644
645 <varlistentry>
646 <term><literal>Debug::pkgAcquire::Worker</literal></term>
647
648 <listitem>
649 <para>
650 Log all interactions with the sub-processes that actually
651 perform downloads.
652 </para>
653 </listitem>
654 </varlistentry>
655
656 <varlistentry>
657 <term><literal>Debug::pkgAutoRemove</literal></term>
658
659 <listitem>
660 <para>
661 Log events related to the automatically-installed status of
662 packages and to the removal of unused packages.
663 </para>
664 </listitem>
665 </varlistentry>
666
667 <varlistentry>
668 <term><literal>Debug::pkgDepCache::AutoInstall</literal></term>
669 <listitem>
670 <para>
671 Generate debug messages describing which packages are being
672 automatically installed to resolve dependencies. This
673 corresponds to the initial auto-install pass performed in,
674 e.g., <literal>apt-get install</literal>, and not to the
675 full <literal>apt</literal> dependency resolver; see
676 <literal>Debug::pkgProblemResolver</literal> for that.
677 </para>
678 </listitem>
679 </varlistentry>
680
681 <!-- Question: why doesn't this do anything? The code says it should. -->
682 <varlistentry>
683 <term><literal>Debug::pkgInitConfig</literal></term>
684 <listitem>
685 <para>
686 Dump the default configuration to standard output on
687 startup.
688 </para>
689 </listitem>
690 </varlistentry>
691
692 <varlistentry>
693 <term><literal>Debug::pkgDPkgPM</literal></term>
694 <listitem>
695 <para>
696 When invoking &dpkg;, output the precise command line with
697 which it is being invoked, with arguments separated by a
698 single space character.
699 </para>
700 </listitem>
701 </varlistentry>
702
703 <varlistentry>
704 <term><literal>Debug::pkgDPkgProgressReporting</literal></term>
705 <listitem>
706 <para>
707 Output all the data received from &dpkg; on the status file
708 descriptor and any errors encountered while parsing it.
709 </para>
710 </listitem>
711 </varlistentry>
712
713 <varlistentry>
714 <term><literal>Debug::pkgOrderList</literal></term>
715
716 <listitem>
717 <para>
718 Generate a trace of the algorithm that decides the order in
719 which <literal>apt</literal> should pass packages to
720 &dpkg;.
721 </para>
722 </listitem>
723 </varlistentry>
724
725 <varlistentry>
726 <term><literal>Debug::pkgPackageManager</literal></term>
727
728 <listitem>
729 <para>
730 Output status messages tracing the steps performed when
731 invoking &dpkg;.
732 </para>
733 </listitem>
734 </varlistentry>
735
736 <varlistentry>
737 <term><literal>Debug::pkgPolicy</literal></term>
738
739 <listitem>
740 <para>
741 Output the priority of each package list on startup.
742 </para>
743 </listitem>
744 </varlistentry>
745
746 <varlistentry>
747 <term><literal>Debug::pkgProblemResolver</literal></term>
748
749 <listitem>
750 <para>
751 Trace the execution of the dependency resolver (this
752 applies only to what happens when a complex dependency
753 problem is encountered).
754 </para>
755 </listitem>
756 </varlistentry>
757
758 <varlistentry>
759 <term><literal>Debug::sourceList</literal></term>
760
761 <listitem>
762 <para>
763 Print information about the vendors read from
764 <filename>/etc/apt/vendors.list</filename>.
765 </para>
766 </listitem>
767 </varlistentry>
768
769 <varlistentry>
770 <term><literal>Debug::Vendor</literal></term>
771
772 <listitem>
773 <para>
774 Print information about each vendor.
775 </para>
776 </listitem>
777 </varlistentry>
778 </variablelist>
24f6490f
AL
779 </refsect1>
780
781 <refsect1><title>Examples</title>
640c5d94
MZ
782 <para>&configureindex; is a
783 configuration file showing example values for all possible
24f6490f
AL
784 options.</para>
785 </refsect1>
786
787 <refsect1><title>Files</title>
788 <para><filename>/etc/apt/apt.conf</filename></para>
789 </refsect1>
790
791 <refsect1><title>See Also</title>
792 <para>&apt-cache;, &apt-config;<!-- ? reading apt.conf -->, &apt-preferences;.</para>
793 </refsect1>
794
795 &manbugs;
24f6490f
AL
796
797</refentry>
798