apt.conf.5.xml 61 KB

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