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