]> git.saurik.com Git - apt.git/blame - doc/examples/configure-index
fix incorrect Korean translation of "manually" and "automatically"
[apt.git] / doc / examples / configure-index
CommitLineData
50e19557 1/* This file is an index of all APT configuration directives. It should
640c5d94
MZ
2 NOT actually be used as a real config file, though it is (except for the
3 last line) a completely valid file. Most of the options have sane default
e3a1f08d 4 values, unless you have specific needs you should NOT include arbitrary
640c5d94 5 items in a custom configuration.
50e19557
AL
6
7 In some instances involving filenames it is possible to set the default
8 directory when the path is evaluated. This means you can use relative
9 paths within the sub scope.
10
11 The configuration directives are specified in a tree with {} designating
12 a subscope relative to the tag before the {}. You can further specify
13 a subscope using scope notation eg,
14 APT::Architecture "i386";
15 This is prefixed with the current scope. Scope notation must be used
16 if an option is specified on the command line with -o.
17*/
18
640c5d94 19quiet "0";
2f6557b9 20quiet::NoUpdate "true"; // never update progress information - included in -q=1
640c5d94 21
50e19557
AL
22// Options for APT in general
23APT
24{
25 Architecture "i386";
58014adc 26 Architectures { "amd64"; "armel"; };
7d6f9f8f 27 Build-Essential "build-essential";
22dcc318 28
63b0c177 29 NeverAutoRemove { "linux-image.*"; }; // packages that should never
22dcc318
MV
30 // considered for autoRemove
31
50e19557
AL
32 // Options for apt-get
33 Get
34 {
234675b7 35 Host-Architecture "armel";
7d6f9f8f 36 Arch-Only "false";
c99fe2e1 37 AllowUnauthenticated "false"; // packages from unauthenticated
120365ce 38 AutomaticRemove "false";
7898bd97 39 HideAutoRemove "false";
50e19557
AL
40 Download-Only "false";
41 Simulate "false";
42 Assume-Yes "false";
43 Force-Yes "false"; // I would never set this.
44 Fix-Broken "false";
45 Fix-Missing "false";
46 Show-Upgraded "false";
640c5d94 47 Show-Versions "false";
b2e465d6 48 Upgrade "true";
50e19557
AL
49 Print-URIs "false";
50 Compile "false";
b2e465d6 51 Download "true";
50e19557
AL
52 Purge "false";
53 List-Cleanup "true";
54 ReInstall "false";
55 Trivial-Only "false";
b2e465d6 56 Remove "true";
640c5d94
MZ
57 Only-Source "";
58 Diff-Only "false";
59 Tar-Only "false";
d59228b0 60 Build-Dep-Automatic "true";
ecf59bfc 61 Show-User-Simulation-Note "true";
50e19557
AL
62 };
63
64 Cache
65 {
66 Important "false";
67 AllVersions "false";
8c6e33d8 68 GivenOnly "false";
153a849d 69 RecurseDepends "false";
640c5d94
MZ
70 ShowFull "false";
71 Generate "true";
72 NamesOnly "false";
73 AllNames "false";
74 Installed "false";
50e19557
AL
75 };
76
77 CDROM
78 {
79 Rename "false";
80 NoMount "false";
81 Fast "false";
82 NoAct "false";
83 };
84
f8477782
MV
85 Update
86 {
87 Pre-Invoke {"touch /var/lib/apt/pre-update-stamp"; };
88 Post-Invoke {"touch /var/lib/apt/post-update-stamp"; };
89 };
90
e8cdc56a
MV
91 Authentication
92 {
25838be6 93 TrustCDROM "false"; // consider the CD-ROM always trusted
e8cdc56a
MV
94 };
95
50e19557
AL
96 // Some general options
97 Ignore-Hold "false";
98 Clean-Installed "true";
99 Immediate-Configure "true"; // DO NOT turn this off, see the man page
100 Force-LoopBreak "false"; // DO NOT turn this on, see the man page
dcdf1ef1
DK
101 Cache-Start "20971520";
102 Cache-Grow "1048576";
103 Cache-Limit "0";
877d310f 104 Default-Release "";
75ef8f14 105
e9ae3677
MV
106 // consider Recommends, Suggests as important dependencies that should
107 // be installed by default
50c26918 108 Install-Recommends "true";
e53ee4ca 109 Install-Suggests "false";
75ef8f14 110
92b9551f 111 // consider dependencies of packages in this section manual
cb1933df 112 Never-MarkAuto-Sections {"metapackages"; "universe/metapackages"; };
2a7e07c7 113
75ef8f14
MV
114 // Write progress messages on this fd (for stuff like base-config)
115 Status-Fd "-1";
116 // Keep the list of FDs open (normally apt closes all fds when it
117 // does a ExecFork)
118 Keep-Fds {};
ff7c76f8
OA
119
120 // control parameters for cron jobs by /etc/cron.daily/apt
121 Periodic
122 {
c845d4ff
MV
123 BackupArchiveInterval "0";
124 // - Backup after n-days if archive contents changed.(0=disable)
125
126 BackupLevel "3";
127 // - Backup level.(0=disable), 1 is invalid.
128
129 // APT::Archives::MaxAge "0"; (old, deprecated)
130 MaxAge "0"; // (new)
131 // - Set maximum allowed age of a cache package file. If a cache
132 // package file is older it is deleted (0=disable)
133
134 // APT::Archives::MinAge "2"; (old, deprecated)
135 MinAge "2"; // (new)
136 // - Set minimum age of a package file. If a file is younger it
1e3f4083 137 // will not be deleted (0=disable). Useful to prevent races
c845d4ff
MV
138 // and to keep backups of the packages for emergency.
139
140 // APT::Archives::MaxSize "0"; (old, deprecated)
141 MaxSize "0"; // (new)
142 // - Set maximum size of the cache in MB (0=disable). If the cache
143 // is bigger, cached package files are deleted until the size
12c4e7c9 144 // requirement is met (the oldest packages will be deleted
c845d4ff
MV
145 // first).
146
147 Update-Package-Lists "0";
148 // - Do "apt-get update" automatically every n-days (0=disable)
149 //
150 Download-Upgradeable-Packages "0";
151 // - Do "apt-get upgrade --download-only" every n-days (0=disable)
152 //
153 Unattended-Upgrade "0";
154 // - Run the "unattended-upgrade" security upgrade script
155 // every n-days (0=disabled)
156 // Requires the package "unattended-upgrades" and will write
157 // a log in /var/log/unattended-upgrades
158 //
159 AutocleanInterval "0";
160 // - Do "apt-get autoclean" every n-days (0=disable)
161
162 Verbose "0";
163 // - Send report mail to root
164 // 0: no report (or null string)
165 // 1: progress report (actually any string)
166 // 2: + command outputs (remove -qq, remove 2>/dev/null, add -d)
167 // 3: + trace on
ff7c76f8 168 };
50e19557
AL
169};
170
171// Options for the downloading routines
172Acquire
173{
174 Queue-Mode "host"; // host|access
175 Retries "0";
176 Source-Symlinks "true";
a722b2c5 177 ForceHash "sha256"; // hashmethod used for expected hash: sha256, sha1 or md5sum
2ac3eeb6
MV
178
179 PDiffs "true"; // try to get the IndexFile diffs
02dceb31
DK
180 PDiffs::FileLimit "4"; // don't use diffs if we would need more than 4 diffs
181 PDiffs::SizeLimit "50"; // don't use diffs if size of all patches excess
182 // 50% of the size of the original file
183
b02fffa6
DK
184 Check-Valid-Until "true";
185 Max-ValidTime "864000"; // 10 days
186 Max-ValidTime::Debian-Security "604800"; // 7 days, label specific configuration
187
50e19557
AL
188 // HTTP method configuration
189 http
190 {
191 Proxy "http://127.0.0.1:3128";
192 Proxy::http.us.debian.org "DIRECT"; // Specific per-host setting
193 Timeout "120";
194 Pipeline-Depth "5";
09fab244
MV
195 AllowRedirect "true";
196
50e19557
AL
197 // Cache Control. Note these do not work with Squid 2.0.2
198 No-Cache "false";
199 Max-Age "86400"; // 1 Day age on index files
200 No-Store "false"; // Prevent the cache from storing archives
7c6e2dc7 201 Dl-Limit "7"; // 7Kb/sec maximum download rate
4494239c 202 User-Agent "Debian APT-HTTP/1.3";
50e19557
AL
203 };
204
c0d43847
DK
205
206
207 // HTTPS method configuration: uses the http
208 // - proxy config
209 // - cache-control values
210 // - Dl-Limit, Timout, ... values
211 // if not set explicit for https
212 //
213 // see /usr/share/doc/apt/examples/apt-https-method-example.conf.gz
214 // for more examples
215 https
714ee06c
MV
216 {
217 Verify-Peer "false";
218 SslCert "/etc/apt/some.pem";
c0d43847 219 CaPath "/etc/ssl/certs";
947da3eb 220 Verify-Host "true";
c0d43847
DK
221 AllowRedirect "true";
222
223 Timeout "120";
224 AllowRedirect "true";
225
226 // Cache Control. Note these do not work with Squid 2.0.2
227 No-Cache "false";
228 Max-Age "86400"; // 1 Day age on index files
229 No-Store "false"; // Prevent the cache from storing archives
230 Dl-Limit "7"; // 7Kb/sec maximum download rate
4494239c 231
c0d43847 232 User-Agent "Debian APT-CURL/1.0";
714ee06c
MV
233 };
234
50e19557
AL
235 ftp
236 {
237 Proxy "ftp://127.0.0.1/";
238 Proxy::http.us.debian.org "DIRECT"; // Specific per-host setting
239
240 /* Required script to perform proxy login. This example should work
241 for tisfwtk */
242 ProxyLogin
243 {
244 "USER $(PROXY_USER)";
245 "PASS $(PROXY_PASS)";
246 "USER $(SITE_USER)@$(SITE):$(SITE_PORT)";
247 "PASS $(SITE_PASS)";
248 };
249
250 Timeout "120";
251
252 /* Passive mode control, proxy, non-proxy and per-host. Pasv mode
e3a1f08d 253 is preferred if possible */
50e19557
AL
254 Passive "true";
255 Proxy::Passive "true";
256 Passive::http.us.debian.org "true"; // Specific per-host setting
257 };
258
259 cdrom
260 {
93adae19 261 // do auto detection of the cdrom mountpoint
c9952021
MV
262 AutoDetect "true";
263 // when auto-detecting, only look for cdrom/dvd. when this is false
264 // it will support any removable device as a "cdrom" source
265 CdromOnly "true";
93adae19
MV
266
267 // cdrom mountpoint (needs to be defined in fstab if AutoDetect is not used)
640c5d94 268 mount "/cdrom";
50e19557
AL
269
270 // You need the trailing slash!
271 "/cdrom/"
272 {
273 Mount "sleep 1000";
274 UMount "sleep 500";
275 }
276 };
e75f306e
MV
277
278 gpgv
279 {
e3a1f08d 280 Options {"--ignore-time-conflict";} // not very useful on a normal system
e75f306e 281 };
8bd02d8b
DK
282
283 CompressionTypes
284 {
285 bz2 "bzip2";
286 lzma "lzma";
287 gz "gzip";
288
5d885723 289 Order { "uncompressed"; "gz"; "lzma"; "bz2"; };
8bd02d8b 290 };
45df0ad2
DK
291
292 Languages
293 {
294 "environment";
295 "de";
296 "en";
297 "none";
298 "fr";
299 };
d56e2917 300
430481e7
DK
301 // Location of the changelogs with the placeholder @CHANGEPATH@ (e.g. "main/a/apt/apt_1.1")
302 Changelogs::URI::Origin::Debian "http://metadata.ftp-master.debian.org/changelogs/@CHANGEPATH@_changelog";
50e19557
AL
303};
304
305// Directory layout
b2e465d6 306Dir "/"
50e19557
AL
307{
308 // Location of the state dir
b2e465d6 309 State "var/lib/apt/"
50e19557 310 {
640c5d94 311 Lists "lists/";
50e19557 312 status "/var/lib/dpkg/status";
d34690e1 313 extended_states "extended_states";
50e19557
AL
314 cdroms "cdroms.list";
315 };
316
317 // Location of the cache dir
b2e465d6 318 Cache "var/cache/apt/" {
640c5d94 319 Archives "archives/";
ff7c76f8
OA
320 // backup directory created by /etc/cron.daily/apt
321 Backup "backup/";
50e19557
AL
322 srcpkgcache "srcpkgcache.bin";
323 pkgcache "pkgcache.bin";
324 };
325
326 // Config files
b2e465d6 327 Etc "etc/apt/" {
640c5d94 328 Main "apt.conf";
592b7800 329 Netrc "auth.conf";
640c5d94 330 Parts "apt.conf.d/";
13aa7588
JAK
331 Preferences "preferences";
332 PreferencesParts "preferences.d";
5541fea3
JAK
333 SourceList "sources.list";
334 SourceParts "sources.list.d";
335 VendorList "vendors.list";
336 VendorParts "vendors.list.d";
c24f6ce2
DK
337 Trusted "trusted.gpg";
338 TrustedParts "trusted.gpg.d";
50e19557
AL
339 };
340
341 // Locations of binaries
342 Bin {
343 methods "/usr/lib/apt/methods/";
344 gzip "/bin/gzip";
8a3642bd 345 gpg "/usr/bin/gpgv";
50e19557
AL
346 dpkg "/usr/bin/dpkg";
347 dpkg-source "/usr/bin/dpkg-source";
2a065e4e 348 dpkg-buildpackage "/usr/bin/dpkg-buildpackage";
50e19557
AL
349 apt-get "/usr/bin/apt-get";
350 apt-cache "/usr/bin/apt-cache";
351 };
ff56e980
MV
352
353 // Location of the logfile
354 Log "var/log/apt" {
8da1f029 355 Terminal "term.log";
06863651 356 History "history.log";
ff56e980 357 };
ffee221b
MV
358
359 // Media
360 Media
361 {
362 // Media AutoDetect mount path
363 MountPath "/media/apt";
ff56e980 364 };
93adae19
MV
365
366 // Media
367 Media
368 {
369 // Media AutoDetect mount path
370 MountPath "/media/apt";
371 };
50e19557
AL
372};
373
374// Things that effect the APT dselect method
375DSelect
376{
377 Clean "auto"; // always|auto|prompt|never
378 Options "-f";
379 UpdateOptions "";
380 PromptAfterUpdate "no";
b2e465d6 381 CheckDir "no";
50e19557
AL
382}
383
3e9c4f70 384DPkg
50e19557 385{
3e9c4f70
DK
386 // let apt aggressivly use dpkg triggers
387 NoTriggers "true";
3e9c4f70
DK
388 ConfigurePending "true";
389
50e19557
AL
390 // Probably don't want to use force-downgrade..
391 Options {"--force-overwrite";"--force-downgrade";}
3e9c4f70 392
50e19557
AL
393 // Auto re-mounting of a readonly /usr
394 Pre-Invoke {"mount -o remount,rw /usr";};
395 Post-Invoke {"mount -o remount,ro /usr";};
3e9c4f70
DK
396
397 Chroot-Directory "/";
398
50e19557
AL
399 // Prevents daemons from getting cwd as something mountable (default)
400 Run-Directory "/";
3e9c4f70 401
50e19557
AL
402 // Build options for apt-get source --compile
403 Build-Options "-b -uc";
404
405 // Pre-configure all packages before they are installed using debconf.
99a202d6 406 Pre-Install-Pkgs {"dpkg-preconfigure --apt --priority=low --frontend=dialog";};
8c6e33d8
AL
407
408 // Flush the contents of stdin before forking dpkg.
409 FlushSTDIN "true";
358688a8
AL
410
411 // Control the size of the command line passed to dpkg.
ee877edd
MV
412 MaxArgBytes 32768;
413 MaxArgs 8192;
c70496f9
MV
414
415 // controls if apt will apport on the first dpkg error or if it
416 // tries to install as many packages as possible
417 StopOnError "true";
50e19557
AL
418}
419
2d425135 420/* Options you can set to see some debugging text They correspond to names
50e19557
AL
421 of classes in the source code */
422Debug
423{
424 pkgProblemResolver "false";
8b4894fe 425 pkgProblemResolver::ShowScores "false";
d4c5f11f 426 pkgDepCache::AutoInstall "false"; // what packages apt install to satify dependencies
af29ffb4 427 pkgDepCache::Marker "false";
c8e572e3 428 pkgCacheGen "false";
50e19557
AL
429 pkgAcquire "false";
430 pkgAcquire::Worker "false";
5e9179a6 431 pkgAcquire::Auth "false";
50e19557 432 pkgDPkgPM "false";
75ef8f14 433 pkgDPkgProgressReporting "false";
b2e465d6 434 pkgOrderList "false";
131418cf 435 pkgPackageManager "false"; // OrderList/Configure debugging
120365ce 436 pkgAutoRemove "false"; // show information about automatic removes
efe9ba67 437 BuildDeps "false";
50e19557
AL
438 pkgInitialize "false"; // This one will dump the configuration space
439 NoLocking "false";
440 Acquire::Ftp "false"; // Show ftp command traffic
441 Acquire::Http "false"; // Show http command traffic
714ee06c 442 Acquire::Https "false"; // Show https debug
8a3642bd 443 Acquire::gpgv "false"; // Show the gpgv traffic
0c6b381f 444 Acquire::cdrom "false"; // Show cdrom debug output
50e19557 445 aptcdrom "false"; // Show found package files
640c5d94 446 IdentCdrom "false";
f1c081b6 447 acquire::netrc "false"; // netrc parser
e5b7e019 448 RunScripts "false"; // debug invocation of external scripts
50e19557
AL
449}
450
6bc703c2
DK
451pkgCacheGen::Essential "native"; // other modes: all, none, installed
452
50e19557
AL
453/* Whatever you do, do not use this configuration file!! Take out ONLY
454 the portions you need! */
455This Is Not A Valid Config File