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

PHP Warning

lib/blame.php:177: Warning: Invalid argument supplied for foreach()