Commit | Line | Data |
---|---|---|
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> | |
64 | APT { | |
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> | |
77 | DPkg::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::<host></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><host>::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><host>::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><host>::Verify-Host</literal> is corresponding per-host option. | |
243 | <literal>SslCert</literal> determines what certificate to use for client | |
244 | authentication. <literal><host>::SslCert</literal> is corresponding per-host option. | |
245 | <literal>SslKey</literal> determines what private key to use for client | |
246 | authentication. <literal><host>::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><host>::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 | ||
be1b8568 EL |
432 | <refsect1> |
433 | <title>Debug options</title> | |
434 | <para> | |
435 | Enabling options in the <literal>Debug::</literal> section will | |
436 | cause debugging information to be sent to the standard error | |
437 | stream of the program utilizing the <literal>apt</literal> | |
438 | libraries, or enable special program modes that are primarily | |
439 | useful for debugging the behavior of <literal>apt</literal>. | |
440 | Most of these options are not interesting to a normal user, but a | |
441 | few may be: | |
442 | ||
443 | <itemizedlist> | |
444 | <listitem> | |
445 | <para> | |
446 | <literal>Debug::pkgProblemResolver</literal> enables output | |
447 | about the decisions made by | |
448 | <literal>dist-upgrade, upgrade, install, remove, purge</literal>. | |
449 | </para> | |
450 | </listitem> | |
451 | ||
452 | <listitem> | |
453 | <para> | |
454 | <literal>Debug::NoLocking</literal> disables all file | |
455 | locking. This can be used to run some operations (for | |
456 | instance, <literal>apt-get -s install</literal>) as a | |
457 | non-root user. | |
458 | </para> | |
459 | </listitem> | |
460 | ||
461 | <listitem> | |
462 | <para> | |
463 | <literal>Debug::pkgDPkgPM</literal> prints out the actual | |
464 | command line each time that <literal>apt</literal> invokes | |
465 | &dpkg;. | |
466 | </para> | |
467 | </listitem> | |
468 | ||
469 | <listitem> | |
470 | <para> | |
471 | <literal>Debug::IdentCdrom</literal> disables the inclusion | |
472 | of statfs data in CDROM IDs. <!-- TODO: provide a | |
473 | motivating example, except I haven't a clue why you'd want | |
474 | to do this. --> | |
475 | </para> | |
476 | </listitem> | |
477 | </itemizedlist> | |
8a3642bd | 478 | </para> |
be1b8568 EL |
479 | |
480 | <para> | |
481 | A full list of debugging options to apt follows. | |
482 | </para> | |
483 | ||
484 | <variablelist> | |
485 | <varlistentry> | |
486 | <term><literal>Debug::Acquire::cdrom</literal></term> | |
487 | ||
488 | <listitem> | |
489 | <para> | |
490 | Print information related to accessing | |
491 | <literal>cdrom://</literal> sources. | |
492 | </para> | |
493 | </listitem> | |
494 | </varlistentry> | |
495 | ||
496 | <varlistentry> | |
497 | <term><literal>Debug::Acquire::ftp</literal></term> | |
498 | ||
499 | <listitem> | |
500 | <para> | |
501 | Print information related to downloading packages using | |
502 | FTP. | |
503 | </para> | |
504 | </listitem> | |
505 | </varlistentry> | |
506 | ||
507 | <varlistentry> | |
508 | <term><literal>Debug::Acquire::http</literal></term> | |
509 | ||
510 | <listitem> | |
511 | <para> | |
512 | Print information related to downloading packages using | |
513 | HTTP. | |
514 | </para> | |
515 | </listitem> | |
516 | </varlistentry> | |
517 | ||
518 | <varlistentry> | |
519 | <term><literal>Debug::Acquire::https</literal></term> | |
520 | ||
521 | <listitem> | |
522 | <para> | |
523 | Print information related to downloading packages using | |
524 | HTTPS. | |
525 | </para> | |
526 | </listitem> | |
527 | </varlistentry> | |
528 | ||
529 | <varlistentry> | |
530 | <term><literal>Debug::Acquire::gpgv</literal></term> | |
531 | ||
532 | <listitem> | |
533 | <para> | |
534 | Print information related to verifying cryptographic | |
535 | signatures using <literal>gpg</literal>. | |
536 | </para> | |
537 | </listitem> | |
538 | </varlistentry> | |
539 | ||
540 | <varlistentry> | |
541 | <term><literal>Debug::aptcdrom</literal></term> | |
542 | ||
543 | <listitem> | |
544 | <para> | |
545 | Output information about the process of accessing | |
546 | collections of packages stored on CD-ROMs. | |
547 | </para> | |
548 | </listitem> | |
549 | </varlistentry> | |
550 | ||
551 | <varlistentry> | |
552 | <term><literal>Debug::BuildDeps</literal></term> | |
553 | <listitem> | |
554 | <para> | |
555 | Describes the process of resolving build-dependencies in | |
556 | &apt-get;. | |
557 | </para> | |
558 | </listitem> | |
559 | </varlistentry> | |
560 | ||
561 | <varlistentry> | |
562 | <term><literal>Debug::Hashes</literal></term> | |
563 | <listitem> | |
564 | <para> | |
565 | Output each cryptographic hash that is generated by the | |
566 | <literal>apt</literal> libraries. | |
567 | </para> | |
568 | </listitem> | |
569 | </varlistentry> | |
570 | ||
571 | <varlistentry> | |
572 | <term><literal>Debug::IdentCDROM</literal></term> | |
573 | <listitem> | |
574 | <para> | |
575 | Do not include information from <literal>statfs</literal>, | |
576 | namely the number of used and free blocks on the CD-ROM | |
577 | filesystem, when generating an ID for a CD-ROM. | |
578 | </para> | |
579 | </listitem> | |
580 | </varlistentry> | |
581 | ||
582 | <varlistentry> | |
583 | <term><literal>Debug::NoLocking</literal></term> | |
584 | <listitem> | |
585 | <para> | |
586 | Disable all file locking. For instance, this will allow | |
587 | two instances of <quote><literal>apt-get | |
588 | update</literal></quote> to run at the same time. | |
589 | </para> | |
590 | </listitem> | |
591 | </varlistentry> | |
592 | ||
593 | <varlistentry> | |
594 | <term><literal>Debug::pkgAcquire</literal></term> | |
595 | ||
596 | <listitem> | |
597 | <para> | |
598 | Log when items are added to or removed from the global | |
599 | download queue. | |
600 | </para> | |
601 | </listitem> | |
602 | </varlistentry> | |
603 | ||
604 | <varlistentry> | |
605 | <term><literal>Debug::pkgAcquire::Auth</literal></term> | |
606 | <listitem> | |
607 | <para> | |
608 | Output status messages and errors related to verifying | |
609 | checksums and cryptographic signatures of downloaded files. | |
610 | </para> | |
611 | </listitem> | |
612 | </varlistentry> | |
613 | ||
614 | <varlistentry> | |
615 | <term><literal>Debug::pkgAcquire::Diffs</literal></term> | |
616 | <listitem> | |
617 | <para> | |
618 | Output information about downloading and applying package | |
619 | index list diffs, and errors relating to package index list | |
620 | diffs. | |
621 | </para> | |
622 | </listitem> | |
623 | </varlistentry> | |
624 | ||
625 | <varlistentry> | |
626 | <term><literal>Debug::pkgAcquire::RRed</literal></term> | |
627 | ||
628 | <listitem> | |
629 | <para> | |
630 | Output information related to patching apt package lists | |
631 | when downloading index diffs instead of full indices. | |
632 | </para> | |
633 | </listitem> | |
634 | </varlistentry> | |
635 | ||
636 | <varlistentry> | |
637 | <term><literal>Debug::pkgAcquire::Worker</literal></term> | |
638 | ||
639 | <listitem> | |
640 | <para> | |
641 | Log all interactions with the sub-processes that actually | |
642 | perform downloads. | |
643 | </para> | |
644 | </listitem> | |
645 | </varlistentry> | |
646 | ||
647 | <varlistentry> | |
648 | <term><literal>Debug::pkgAutoRemove</literal></term> | |
649 | ||
650 | <listitem> | |
651 | <para> | |
652 | Log events related to the automatically-installed status of | |
653 | packages and to the removal of unused packages. | |
654 | </para> | |
655 | </listitem> | |
656 | </varlistentry> | |
657 | ||
658 | <varlistentry> | |
659 | <term><literal>Debug::pkgDepCache::AutoInstall</literal></term> | |
660 | <listitem> | |
661 | <para> | |
662 | Generate debug messages describing which packages are being | |
663 | automatically installed to resolve dependencies. This | |
664 | corresponds to the initial auto-install pass performed in, | |
665 | e.g., <literal>apt-get install</literal>, and not to the | |
666 | full <literal>apt</literal> dependency resolver; see | |
667 | <literal>Debug::pkgProblemResolver</literal> for that. | |
668 | </para> | |
669 | </listitem> | |
670 | </varlistentry> | |
671 | ||
672 | <!-- Question: why doesn't this do anything? The code says it should. --> | |
673 | <varlistentry> | |
674 | <term><literal>Debug::pkgInitConfig</literal></term> | |
675 | <listitem> | |
676 | <para> | |
677 | Dump the default configuration to standard output on | |
678 | startup. | |
679 | </para> | |
680 | </listitem> | |
681 | </varlistentry> | |
682 | ||
683 | <varlistentry> | |
684 | <term><literal>Debug::pkgDPkgPM</literal></term> | |
685 | <listitem> | |
686 | <para> | |
687 | When invoking &dpkg;, output the precise command line with | |
688 | which it is being invoked, with arguments separated by a | |
689 | single space character. | |
690 | </para> | |
691 | </listitem> | |
692 | </varlistentry> | |
693 | ||
694 | <varlistentry> | |
695 | <term><literal>Debug::pkgDPkgProgressReporting</literal></term> | |
696 | <listitem> | |
697 | <para> | |
698 | Output all the data received from &dpkg; on the status file | |
699 | descriptor and any errors encountered while parsing it. | |
700 | </para> | |
701 | </listitem> | |
702 | </varlistentry> | |
703 | ||
704 | <varlistentry> | |
705 | <term><literal>Debug::pkgOrderList</literal></term> | |
706 | ||
707 | <listitem> | |
708 | <para> | |
709 | Generate a trace of the algorithm that decides the order in | |
710 | which <literal>apt</literal> should pass packages to | |
711 | &dpkg;. | |
712 | </para> | |
713 | </listitem> | |
714 | </varlistentry> | |
715 | ||
716 | <varlistentry> | |
717 | <term><literal>Debug::pkgPackageManager</literal></term> | |
718 | ||
719 | <listitem> | |
720 | <para> | |
721 | Output status messages tracing the steps performed when | |
722 | invoking &dpkg;. | |
723 | </para> | |
724 | </listitem> | |
725 | </varlistentry> | |
726 | ||
727 | <varlistentry> | |
728 | <term><literal>Debug::pkgPolicy</literal></term> | |
729 | ||
730 | <listitem> | |
731 | <para> | |
732 | Output the priority of each package list on startup. | |
733 | </para> | |
734 | </listitem> | |
735 | </varlistentry> | |
736 | ||
737 | <varlistentry> | |
738 | <term><literal>Debug::pkgProblemResolver</literal></term> | |
739 | ||
740 | <listitem> | |
741 | <para> | |
742 | Trace the execution of the dependency resolver (this | |
743 | applies only to what happens when a complex dependency | |
744 | problem is encountered). | |
745 | </para> | |
746 | </listitem> | |
747 | </varlistentry> | |
748 | ||
749 | <varlistentry> | |
750 | <term><literal>Debug::sourceList</literal></term> | |
751 | ||
752 | <listitem> | |
753 | <para> | |
754 | Print information about the vendors read from | |
755 | <filename>/etc/apt/vendors.list</filename>. | |
756 | </para> | |
757 | </listitem> | |
758 | </varlistentry> | |
759 | ||
760 | <varlistentry> | |
761 | <term><literal>Debug::Vendor</literal></term> | |
762 | ||
763 | <listitem> | |
764 | <para> | |
765 | Print information about each vendor. | |
766 | </para> | |
767 | </listitem> | |
768 | </varlistentry> | |
769 | </variablelist> | |
24f6490f AL |
770 | </refsect1> |
771 | ||
772 | <refsect1><title>Examples</title> | |
640c5d94 MZ |
773 | <para>&configureindex; is a |
774 | configuration file showing example values for all possible | |
24f6490f AL |
775 | options.</para> |
776 | </refsect1> | |
777 | ||
778 | <refsect1><title>Files</title> | |
779 | <para><filename>/etc/apt/apt.conf</filename></para> | |
780 | </refsect1> | |
781 | ||
782 | <refsect1><title>See Also</title> | |
783 | <para>&apt-cache;, &apt-config;<!-- ? reading apt.conf -->, &apt-preferences;.</para> | |
784 | </refsect1> | |
785 | ||
786 | &manbugs; | |
24f6490f AL |
787 | |
788 | </refentry> | |
789 |