- merge repomd branch
[apt.git] / doc / apt.conf.5.sgml
1 <!-- -*- mode: sgml; mode: fold -*- -->
2 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
3
4 <!ENTITY % aptent SYSTEM "apt.ent">
5 %aptent;
6
7 ]>
8
9 <refentry>
10  &apt-docinfo;
11  
12  <refmeta>
13    <refentrytitle>apt.conf</>
14    <manvolnum>5</>
15  </refmeta>
16  
17  <!-- Man page title -->
18  <refnamediv>
19     <refname>apt.conf</>
20     <refpurpose>Configuration file for APT</>
21  </refnamediv>
22  
23  <RefSect1><Title>Description</>
24    <para>
25    <filename/apt.conf/ is the main configuration file for the APT suite of
26    tools, all tools make use of the configuration file and a common command line
27    parser to provide a uniform environment. When an APT tool starts up it will
28    read the configuration specified by the <envar/APT_CONFIG/ environment 
29    variable (if any) and then read the files in <literal/Dir::Etc::Parts/ 
30    then read the main configuration file specified by 
31    <literal/Dir::Etc::main/ then finally apply the
32    command line options to override the configuration directives, possibly 
33    loading even more config files.
34    </para><para>
35    The configuration file is organized in a tree with options organized into
36    functional groups. Option specification is given with a double colon
37    notation, for instance <literal/APT::Get::Assume-Yes/ is an option within 
38    the APT tool group, for the Get tool. Options do not inherit from their 
39    parent groups.
40    </para><para>
41    Syntacticly the configuration language is modeled after what the ISC tools
42    such as bind and dhcp use.  Lines starting with
43    <literal>//</literal> are treated as comments (ignored).  Each line is of the form
44    <literallayout>APT::Get::Assume-Yes "true";</literallayout> The trailing 
45    semicolon is required and the quotes are optional. A new scope can be
46    opened with curly braces, like:
47 <informalexample><programlisting>   
48 APT {
49   Get {
50     Assume-Yes "true";
51     Fix-Broken "true";
52   };
53 };
54 </programlisting></informalexample>
55    with newlines placed to make it more readable. Lists can be created by 
56    opening a scope and including a single word enclosed in quotes followed by a 
57    semicolon. Multiple entries can be included, each separated by a semicolon.
58 <informalexample><programlisting>   
59 DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
60 </programlisting></informalexample>
61    </para><para>
62    In general the sample configuration file in 
63    <filename>&docdir;examples/apt.conf</> &configureindex;
64    is a good guide for how it should look.
65    </para><para>
66    Two specials are allowed, <literal/#include/ and <literal/#clear/. 
67    <literal/#include/ will include the given file, unless the filename
68    ends in a slash, then the whole directory is included.  
69    <literal/#clear/ is used to erase a list of names.
70    </para><para>
71    All of the APT tools take a -o option which allows an arbitrary configuration 
72    directive to be specified on the command line. The syntax is a full option
73    name (<literal/APT::Get::Assume-Yes/ for instance) followed by an equals
74    sign then the new value of the option. Lists can be appended too by adding 
75    a trailing :: to the list name.   
76    </para>
77  </RefSect1>
78
79  <RefSect1><Title>The APT Group</>
80    <para>   
81    This group of options controls general APT behavior as well as holding the
82    options for all of the tools.
83
84    <VariableList>
85      <VarListEntry><Term>Architecture</Term>
86      <ListItem><Para>
87      System Architecture; sets the architecture to use when fetching files and
88      parsing package lists. The internal default is the architecture apt was 
89      compiled for.
90      </Para></ListItem>
91      </VarListEntry>
92      
93      <VarListEntry><Term>Ignore-Hold</Term>
94      <ListItem><Para>
95      Ignore Held packages; This global option causes the problem resolver to
96      ignore held packages in its decision making. 
97      </Para></ListItem>
98      </VarListEntry>
99
100      <VarListEntry><Term>Clean-Installed</Term>
101      <ListItem><Para>
102      Defaults to on. When turned on the autoclean feature will remove any packages
103      which can no longer be downloaded from the cache. If turned off then
104      packages that are locally installed are also excluded from cleaning - but
105      note that APT provides no direct means to reinstall them.
106      </Para></ListItem>
107      </VarListEntry>
108
109      <VarListEntry><Term>Immediate-Configure</Term>
110      <ListItem><Para>
111      Disable Immediate Configuration; This dangerous option disables some
112      of APT's ordering code to cause it to make fewer dpkg calls. Doing
113      so may be necessary on some extremely slow single user systems but 
114      is very dangerous and may cause package install scripts to fail or worse.
115      Use at your own risk.
116      </Para></ListItem>
117      </VarListEntry>
118
119      <VarListEntry><Term>Force-LoopBreak</Term>
120      <ListItem><Para>
121      Never Enable this option unless you -really- know what you are doing. It
122      permits APT to temporarily remove an essential package to break a
123      Conflicts/Conflicts or Conflicts/Pre-Depend loop between two essential
124      packages. SUCH A LOOP SHOULD NEVER EXIST AND IS A GRAVE BUG. This option 
125      will work if the essential packages are not tar, gzip, libc, dpkg, bash or
126      anything that those packages depend on.
127      </Para></ListItem>
128      </VarListEntry>
129
130      <VarListEntry><Term>Cache-Limit</Term>
131      <ListItem><Para>
132      APT uses a fixed size memory mapped cache file to store the 'available'
133      information. This sets the size of that cache.
134      </Para></ListItem>
135      </VarListEntry>
136
137      <VarListEntry><Term>Build-Essential</Term>
138      <ListItem><Para>
139      Defines which package(s) are considered essential build dependencies.
140      </Para></ListItem>
141      </VarListEntry>
142
143      <VarListEntry><Term>Get</Term>
144      <ListItem><Para>
145      The Get subsection controls the &apt-get; tool, please see its
146      documentation for more information about the options here.
147      </Para></ListItem>
148      </VarListEntry>
149
150      <VarListEntry><Term>Cache</Term>
151      <ListItem><Para>
152      The Cache subsection controls the &apt-cache; tool, please see its
153      documentation for more information about the options here.
154      </Para></ListItem>
155      </VarListEntry>
156
157      <VarListEntry><Term>CDROM</Term>
158      <ListItem><Para>
159      The CDROM subsection controls the &apt-cdrom; tool, please see its
160      documentation for more information about the options here.
161      </Para></ListItem>
162      </VarListEntry>
163    </VariableList>
164    </para>
165  </RefSect1>
166
167  <RefSect1><Title>The Acquire Group</>
168    <para>   
169    The <literal/Acquire/ group of options controls the download of packages 
170    and the URI handlers. 
171
172    <VariableList>
173      <VarListEntry><Term>Queue-Mode</Term>
174      <ListItem><Para>
175      Queuing mode; <literal/Queue-Mode/ can be one of <literal/host/ or 
176      <literal/access/ which determines how  APT parallelizes outgoing 
177      connections. <literal/host/ means that one connection per target host 
178      will be opened, <literal/access/ means that one connection per URI type 
179      will be opened.
180      </Para></ListItem>
181      </VarListEntry>
182
183      <VarListEntry><Term>Retries</Term>
184      <ListItem><Para>
185      Number of retries to perform. If this is non-zero APT will retry failed 
186      files the given number of times.
187      </Para></ListItem>
188      </VarListEntry>
189
190      <VarListEntry><Term>Source-Symlinks</Term>
191      <ListItem><Para>
192      Use symlinks for source archives. If set to true then source archives will
193      be symlinked when possible instead of copying. True is the default
194      </Para></ListItem>
195      </VarListEntry>
196
197      <VarListEntry><Term>http</Term>
198      <ListItem><Para>
199      HTTP URIs; http::Proxy is the default http proxy to use. It is in the 
200      standard form of <literal>http://[[user][:pass]@]host[:port]/</>. Per 
201      host proxies can also be specified by using the form 
202      <literal/http::Proxy::&lt;host&gt;/ with the special keyword <literal/DIRECT/ 
203      meaning to use no proxies. The <envar/http_proxy/ environment variable
204      will override all settings.
205      </Para><Para>
206      Three settings are provided for cache control with HTTP/1.1 compliant 
207      proxy caches. <literal/No-Cache/ tells the proxy to not use its cached 
208      response under any circumstances, <literal/Max-Age/ is sent only for 
209      index files and tells the cache to refresh its object if it is older than 
210      the given number of seconds. Debian updates its index files daily so the 
211      default is 1 day. <literal/No-Store/ specifies that the cache should never 
212      store this request, it is only set for archive files. This may be useful 
213      to prevent polluting a proxy cache with very large .deb files. Note: 
214      Squid 2.0.2 does not support any of these options.
215      </Para><Para>
216      The option <literal/timeout/ sets the timeout timer used by the method, 
217      this applies to all things including connection timeout and data timeout.
218      </Para><Para>
219      One setting is provided to control the pipeline depth in cases where the
220      remote server is not RFC conforming or buggy (such as Squid 2.0.2)
221      <literal/Acquire::http::Pipeline-Depth/ can be a value from 0 to 5 
222      indicating how many outstanding requests APT should send. A value of
223      zero MUST be specified if the remote host does not properly linger
224      on TCP connections - otherwise data corruption will occur. Hosts which
225      require this are in violation of RFC 2068.     
226      </Para></ListItem>
227      </VarListEntry>
228
229      <VarListEntry><Term>ftp</Term>
230      <ListItem><Para>
231      FTP URIs; ftp::Proxy is the default proxy server to use. It is in the 
232      standard form of <literal>ftp://[[user][:pass]@]host[:port]/</> and is 
233      overridden by the <envar/ftp_proxy/ environment variable. To use a ftp 
234      proxy you will have to set the <literal/ftp::ProxyLogin/ script in the 
235      configuration file. This entry specifies the commands to send to tell 
236      the proxy server what to connect to. Please see 
237      &configureindex; for an example of 
238      how to do this. The subsitution variables available are 
239      <literal/$(PROXY_USER)/, <literal/$(PROXY_PASS)/, <literal/$(SITE_USER)/,
240      <literal/$(SITE_PASS)/, <literal/$(SITE)/, and <literal/$(SITE_PORT)/.
241      Each is taken from it's respective URI component.
242      </Para><Para>
243      The option <literal/timeout/ sets the timeout timer used by the method, 
244      this applies to all things including connection timeout and data timeout.
245      </Para><Para>
246      Several settings are provided to control passive mode. Generally it is 
247      safe to leave passive mode on, it works in nearly every environment. 
248      However some situations require that passive mode be disabled and port 
249      mode ftp used instead. This can be done globally, for connections that 
250      go through a proxy or for a specific host (See the sample config file 
251      for examples)
252      </Para><Para>
253      It is possible to proxy FTP over HTTP by setting the <envar/ftp_proxy/
254      environment variable to a http url - see the discussion of the http method
255      above for syntax. You cannot set this in the configuration file and it is
256      not recommended to use FTP over HTTP due to its low efficiency.
257      </Para><Para>
258      The setting <literal/ForceExtended/ controls the use of RFC2428 
259      <literal/EPSV/ and <literal/EPRT/ commands. The defaut is false, which means
260      these commands are only used if the control connection is IPv6. Setting this
261      to true forces their use even on IPv4 connections. Note that most FTP servers
262      do not support RFC2428.
263      </Para></ListItem>
264      </VarListEntry>
265
266      <VarListEntry><Term>cdrom</Term>
267      <ListItem><Para>
268      CDROM URIs; the only setting for CDROM URIs is the mount point, 
269      <literal/cdrom::Mount/ which must be the mount point for the CDROM drive 
270      as specified in <filename>/etc/fstab</>. It is possible to provide 
271      alternate mount and unmount commands if your mount point cannot be listed 
272      in the fstab (such as an SMB mount and old mount packages). The syntax 
273      is to put <literallayout>"/cdrom/"::Mount "foo";</literallayout> within 
274      the cdrom block. It is important to have the trailing slash. Unmount 
275      commands can be specified using UMount.
276      </Para></ListItem>
277      </VarListEntry>
278    </VariableList>
279    </para>
280  </RefSect1>
281
282  <RefSect1><Title>Directories</>
283    <para>   
284    The <literal/Dir::State/ section has directories that pertain to local 
285    state information. <literal/lists/ is the directory to place downloaded 
286    package lists in and <literal/status/ is the name of the dpkg status file.
287    <literal/preferences/ is the name of the APT preferences file.
288    <literal/Dir::State/ contains the default directory to prefix on all sub 
289    items if they do not start with <filename>/</> or <filename>./</>. 
290    </para><para>
291    <literal/Dir::Cache/ contains locations pertaining to local cache 
292    information, such as the two package caches <literal/srcpkgcache/ and 
293    <literal/pkgcache/ as well as the location to place downloaded archives, 
294    <literal/Dir::Cache::archives/. Generation of caches can be turned off
295    by setting their names to be blank. This will slow down startup but
296    save disk space. It is probably prefered to turn off the pkgcache rather
297    than the srcpkgcache. Like <literal/Dir::State/ the default
298    directory is contained in <literal/Dir::Cache/
299    </para><para>
300    <literal/Dir::Etc/ contains the location of configuration files, 
301    <literal/sourcelist/ gives the location of the sourcelist and 
302    <literal/main/ is the default configuration file (setting has no effect,
303    unless it is done from the config file specified by 
304    <envar/APT_CONFIG/).
305    </para><para>
306    The <literal/Dir::Parts/ setting reads in all the config fragments in 
307    lexical order from the directory specified. After this is done then the
308    main config file is loaded.
309    </para><para>
310    Binary programs are pointed to by <literal/Dir::Bin/. <literal/Dir::Bin::Methods/ 
311    specifies the location of the method handlers and <literal/gzip/, 
312    <literal/dpkg/, <literal/apt-get/, <literal/dpkg-source/, 
313    <literal/dpkg-buildpackage/ and <literal/apt-cache/ specify the location
314    of the respective programs.
315    </para>
316  </RefSect1>
317  
318  <RefSect1><Title>APT in DSelect</>
319    <para>   
320    When APT is used as a &dselect; method several configuration directives
321    control the default behaviour. These are in the <literal/DSelect/ section.
322    
323    <VariableList>
324      <VarListEntry><Term>Clean</Term>
325      <ListItem><Para>
326      Cache Clean mode; this value may be one of always, prompt, auto,
327      pre-auto and never.  always and prompt will remove all packages from
328      the cache after upgrading, prompt (the default) does so conditionally. 
329      auto removes only those packages which are no longer downloadable
330      (replaced with a new version for instance).  pre-auto performs this
331      action before downloading new packages.
332      </Para></ListItem>
333      </VarListEntry>
334
335      <VarListEntry><Term>Options</Term>
336      <ListItem><Para>
337      The contents of this variable is passed to &apt-get; as command line
338      options when it is run for the install phase.
339      </Para></ListItem>
340      </VarListEntry>
341
342      <VarListEntry><Term>UpdateOptions</Term>
343      <ListItem><Para>
344      The contents of this variable is passed to &apt-get; as command line
345      options when it is run for the update phase.
346      </Para></ListItem>
347      </VarListEntry>
348
349      <VarListEntry><Term>PromptAfterUpdate</Term>
350      <ListItem><Para>
351      If true the [U]pdate operation in &dselect; will always prompt to continue. 
352      The default is to prompt only on error.
353      </Para></ListItem>
354      </VarListEntry>
355    </VariableList>
356    </para>
357  </RefSect1>
358  
359  <RefSect1><Title>How APT calls dpkg</>
360    <para>   
361    Several configuration directives control how APT invokes &dpkg;. These are 
362    in the <literal/DPkg/ section.
363
364    <VariableList>
365      <VarListEntry><Term>Options</Term>
366      <ListItem><Para>
367      This is a list of options to pass to dpkg. The options must be specified
368      using the list notation and each list item is passed as a single argument
369      to &dpkg;.
370      </Para></ListItem>
371      </VarListEntry>
372      
373      <VarListEntry><Term>Pre-Invoke</Term><Term>Post-Invoke</Term>
374      <ListItem><Para>
375      This is a list of shell commands to run before/after invoking &dpkg;. 
376      Like <literal/Options/ this must be specified in list notation. The 
377      commands are invoked in order using <filename>/bin/sh</>, should any 
378      fail APT will abort.
379      </Para></ListItem>
380      </VarListEntry>
381
382      <VarListEntry><Term>Pre-Install-Pkgs</Term>
383      <ListItem><Para>
384      This is a list of shell commands to run before invoking dpkg. Like
385      <literal/Options/ this must be specified in list notation. The commands
386      are invoked in order using <filename>/bin/sh</>, should any fail APT 
387      will abort. APT will pass to the commands on standard input the 
388      filenames of all .deb files it is going to install, one per line.
389      </para><para>
390      Version 2 of this protocol dumps more information, including the 
391      protocol version, the APT configuration space and the packages, files
392      and versions being changed. Version 2 is enabled by setting 
393      <literal/DPkg::Tools::Options::cmd::Version/ to 2. <literal/cmd/ is a
394      command given to <literal/Pre-Install-Pkgs/.
395      </Para></ListItem>
396      </VarListEntry>
397
398      <VarListEntry><Term>Run-Directory</Term>
399      <ListItem><Para>
400      APT chdirs to this directory before invoking dpkg, the default is 
401      <filename>/</>.
402      </Para></ListItem>
403      </VarListEntry>
404
405      <VarListEntry><Term>Build-Options</Term>
406      <ListItem><Para>
407      These options are passed to &dpkg-buildpackage; when compiling packages,
408      the default is to disable signing and produce all binaries.
409      </Para></ListItem>
410      </VarListEntry>
411    </VariableList>
412    </para>
413  </RefSect1>
414
415  <RefSect1><Title>Debug Options</>
416    <para>   
417    Most of the options in the <literal/debug/ section are not interesting to 
418    the normal user, however <literal/Debug::pkgProblemResolver/ shows 
419    interesting output about the decisions dist-upgrade makes. 
420    <literal/Debug::NoLocking/ disables file locking so APT can do some 
421    operations as non-root and <literal/Debug::pkgDPkgPM/ will print out the 
422    command line for each dpkg invokation. <literal/Debug::IdentCdrom/ will 
423    disable the inclusion of statfs data in CDROM IDs.
424    </para>
425  </RefSect1>
426  
427  <RefSect1><Title>Examples</>
428    <para>
429    &configureindex; contains a 
430    sample configuration file showing the default values for all possible 
431    options.
432    </para>
433  </RefSect1>
434  
435  <RefSect1><Title>Files</>
436    <para>
437    <filename>/etc/apt/apt.conf</>
438    </para>
439  </RefSect1>
440  
441  <RefSect1><Title>See Also</>
442    <para>
443    &apt-cache;, &apt-config;<!-- ? reading apt.conf -->, &apt-preferences;.
444    </para>
445  </RefSect1>
446
447  &manbugs;
448  &manauthor;
449  
450 </refentry>