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