apt.conf.5.xml 57 KB

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