]> git.saurik.com Git - apt.git/blame - doc/examples/configure-index
Added APT::Get::AllowUnauthenticated to configure-index.
[apt.git] / doc / examples / configure-index
CommitLineData
640c5d94 1// $Id: configure-index,v 1.10 2004/07/17 19:37:16 mdz Exp $
50e19557 2/* This file is an index of all APT configuration directives. It should
640c5d94
MZ
3 NOT actually be used as a real config file, though it is (except for the
4 last line) a completely valid file. Most of the options have sane default
e3a1f08d 5 values, unless you have specific needs you should NOT include arbitrary
640c5d94 6 items in a custom configuration.
50e19557
AL
7
8 In some instances involving filenames it is possible to set the default
9 directory when the path is evaluated. This means you can use relative
10 paths within the sub scope.
11
12 The configuration directives are specified in a tree with {} designating
13 a subscope relative to the tag before the {}. You can further specify
14 a subscope using scope notation eg,
15 APT::Architecture "i386";
16 This is prefixed with the current scope. Scope notation must be used
17 if an option is specified on the command line with -o.
18*/
19
640c5d94
MZ
20quiet "0";
21
50e19557
AL
22// Options for APT in general
23APT
24{
25 Architecture "i386";
7d6f9f8f 26 Build-Essential "build-essential";
22dcc318
MV
27
28 NeverAutoRemove { "linux-kernel.*"; }; // packages that should never
29 // considered for autoRemove
30
50e19557
AL
31 // Options for apt-get
32 Get
33 {
7d6f9f8f 34 Arch-Only "false";
8070717c 35 AllowUnauthenticated "false";
120365ce 36 AutomaticRemove "false";
7898bd97 37 HideAutoRemove "false";
50e19557
AL
38 Download-Only "false";
39 Simulate "false";
40 Assume-Yes "false";
41 Force-Yes "false"; // I would never set this.
42 Fix-Broken "false";
43 Fix-Missing "false";
44 Show-Upgraded "false";
640c5d94 45 Show-Versions "false";
b2e465d6 46 Upgrade "true";
50e19557
AL
47 Print-URIs "false";
48 Compile "false";
b2e465d6 49 Download "true";
50e19557
AL
50 Purge "false";
51 List-Cleanup "true";
52 ReInstall "false";
53 Trivial-Only "false";
b2e465d6 54 Remove "true";
640c5d94
MZ
55 Only-Source "";
56 Diff-Only "false";
57 Tar-Only "false";
50e19557
AL
58 };
59
60 Cache
61 {
62 Important "false";
63 AllVersions "false";
8c6e33d8 64 GivenOnly "false";
153a849d 65 RecurseDepends "false";
640c5d94
MZ
66 ShowFull "false";
67 Generate "true";
68 NamesOnly "false";
69 AllNames "false";
70 Installed "false";
50e19557
AL
71 };
72
73 CDROM
74 {
75 Rename "false";
76 NoMount "false";
77 Fast "false";
78 NoAct "false";
79 };
80
f8477782
MV
81 Update
82 {
83 Pre-Invoke {"touch /var/lib/apt/pre-update-stamp"; };
84 Post-Invoke {"touch /var/lib/apt/post-update-stamp"; };
85 };
86
e8cdc56a
MV
87 Authentication
88 {
4e0ad446 89 TrustCDROM "false"; // consider the CDROM always trusted
e8cdc56a
MV
90 };
91
8a3642bd
MV
92 GPGV
93 {
94 TrustedKeyring "/etc/apt/trusted.gpg";
95 };
96
50e19557
AL
97 // Some general options
98 Ignore-Hold "false";
99 Clean-Installed "true";
100 Immediate-Configure "true"; // DO NOT turn this off, see the man page
101 Force-LoopBreak "false"; // DO NOT turn this on, see the man page
102 Cache-Limit "4194304";
877d310f 103 Default-Release "";
75ef8f14 104
e9ae3677
MV
105 // consider Recommends, Suggests as important dependencies that should
106 // be installed by default
50c26918 107 Install-Recommends "true";
e53ee4ca 108 Install-Suggests "false";
75ef8f14 109
92b9551f 110 // consider dependencies of packages in this section manual
cb1933df 111 Never-MarkAuto-Sections {"metapackages"; "universe/metapackages"; };
2a7e07c7 112
75ef8f14
MV
113 // Write progress messages on this fd (for stuff like base-config)
114 Status-Fd "-1";
115 // Keep the list of FDs open (normally apt closes all fds when it
116 // does a ExecFork)
117 Keep-Fds {};
50e19557
AL
118};
119
120// Options for the downloading routines
121Acquire
122{
123 Queue-Mode "host"; // host|access
124 Retries "0";
125 Source-Symlinks "true";
2ac3eeb6
MV
126
127 PDiffs "true"; // try to get the IndexFile diffs
50e19557
AL
128
129 // HTTP method configuration
130 http
131 {
132 Proxy "http://127.0.0.1:3128";
133 Proxy::http.us.debian.org "DIRECT"; // Specific per-host setting
134 Timeout "120";
135 Pipeline-Depth "5";
136
137 // Cache Control. Note these do not work with Squid 2.0.2
138 No-Cache "false";
139 Max-Age "86400"; // 1 Day age on index files
140 No-Store "false"; // Prevent the cache from storing archives
7c6e2dc7 141 Dl-Limit "7"; // 7Kb/sec maximum download rate
50e19557
AL
142 };
143
714ee06c
MV
144 // HTTPS method configuration:
145 // - uses the http proxy config
146 // - uses the http cache-control values
147 // - uses the http Dl-Limit values
148 https
149 {
150 Verify-Peer "false";
151 SslCert "/etc/apt/some.pem";
152 CaPath "/etc/ssl/certs";
153 Verify-Host" "2";
154 };
155
50e19557
AL
156 ftp
157 {
158 Proxy "ftp://127.0.0.1/";
159 Proxy::http.us.debian.org "DIRECT"; // Specific per-host setting
160
161 /* Required script to perform proxy login. This example should work
162 for tisfwtk */
163 ProxyLogin
164 {
165 "USER $(PROXY_USER)";
166 "PASS $(PROXY_PASS)";
167 "USER $(SITE_USER)@$(SITE):$(SITE_PORT)";
168 "PASS $(SITE_PASS)";
169 };
170
171 Timeout "120";
172
173 /* Passive mode control, proxy, non-proxy and per-host. Pasv mode
e3a1f08d 174 is preferred if possible */
50e19557
AL
175 Passive "true";
176 Proxy::Passive "true";
177 Passive::http.us.debian.org "true"; // Specific per-host setting
178 };
179
180 cdrom
181 {
640c5d94 182 mount "/cdrom";
50e19557
AL
183
184 // You need the trailing slash!
185 "/cdrom/"
186 {
187 Mount "sleep 1000";
188 UMount "sleep 500";
189 }
190 };
e75f306e
MV
191
192 gpgv
193 {
e3a1f08d 194 Options {"--ignore-time-conflict";} // not very useful on a normal system
e75f306e 195 };
50e19557
AL
196};
197
198// Directory layout
b2e465d6 199Dir "/"
50e19557
AL
200{
201 // Location of the state dir
b2e465d6 202 State "var/lib/apt/"
50e19557 203 {
640c5d94 204 Lists "lists/";
50e19557
AL
205 xstatus "xstatus";
206 userstatus "status.user";
207 status "/var/lib/dpkg/status";
208 cdroms "cdroms.list";
209 };
210
211 // Location of the cache dir
b2e465d6 212 Cache "var/cache/apt/" {
640c5d94 213 Archives "archives/";
50e19557
AL
214 srcpkgcache "srcpkgcache.bin";
215 pkgcache "pkgcache.bin";
216 };
217
218 // Config files
b2e465d6 219 Etc "etc/apt/" {
640c5d94
MZ
220 SourceList "sources.list";
221 Main "apt.conf";
222 Preferences "preferences";
223 Parts "apt.conf.d/";
50e19557
AL
224 };
225
226 // Locations of binaries
227 Bin {
228 methods "/usr/lib/apt/methods/";
229 gzip "/bin/gzip";
8a3642bd 230 gpg "/usr/bin/gpgv";
50e19557
AL
231 dpkg "/usr/bin/dpkg";
232 dpkg-source "/usr/bin/dpkg-source";
2a065e4e 233 dpkg-buildpackage "/usr/bin/dpkg-buildpackage";
50e19557
AL
234 apt-get "/usr/bin/apt-get";
235 apt-cache "/usr/bin/apt-cache";
236 };
ff56e980
MV
237
238 // Location of the logfile
239 Log "var/log/apt" {
8da1f029 240 Terminal "term.log";
ff56e980 241 };
50e19557
AL
242};
243
244// Things that effect the APT dselect method
245DSelect
246{
247 Clean "auto"; // always|auto|prompt|never
248 Options "-f";
249 UpdateOptions "";
250 PromptAfterUpdate "no";
b2e465d6 251 CheckDir "no";
50e19557
AL
252}
253
254DPkg
255{
256 // Probably don't want to use force-downgrade..
257 Options {"--force-overwrite";"--force-downgrade";}
258
259 // Auto re-mounting of a readonly /usr
260 Pre-Invoke {"mount -o remount,rw /usr";};
261 Post-Invoke {"mount -o remount,ro /usr";};
262
263 // Prevents daemons from getting cwd as something mountable (default)
264 Run-Directory "/";
265
266 // Build options for apt-get source --compile
267 Build-Options "-b -uc";
268
269 // Pre-configure all packages before they are installed using debconf.
99a202d6 270 Pre-Install-Pkgs {"dpkg-preconfigure --apt --priority=low --frontend=dialog";};
8c6e33d8
AL
271
272 // Flush the contents of stdin before forking dpkg.
273 FlushSTDIN "true";
358688a8
AL
274
275 // Control the size of the command line passed to dpkg.
276 MaxBytes 1024;
277 MaxArgs 350;
c70496f9
MV
278
279 // controls if apt will apport on the first dpkg error or if it
280 // tries to install as many packages as possible
281 StopOnError "true";
50e19557
AL
282}
283
2d425135 284/* Options you can set to see some debugging text They correspond to names
50e19557
AL
285 of classes in the source code */
286Debug
287{
288 pkgProblemResolver "false";
d4c5f11f 289 pkgDepCache::AutoInstall "false"; // what packages apt install to satify dependencies
50e19557
AL
290 pkgAcquire "false";
291 pkgAcquire::Worker "false";
5e9179a6 292 pkgAcquire::Auth "false";
50e19557 293 pkgDPkgPM "false";
75ef8f14 294 pkgDPkgProgressReporting "false";
b2e465d6 295 pkgOrderList "false";
120365ce 296 pkgAutoRemove "false"; // show information about automatic removes
efe9ba67 297 BuildDeps "false";
50e19557
AL
298 pkgInitialize "false"; // This one will dump the configuration space
299 NoLocking "false";
300 Acquire::Ftp "false"; // Show ftp command traffic
301 Acquire::Http "false"; // Show http command traffic
714ee06c 302 Acquire::Https "false"; // Show https debug
8a3642bd 303 Acquire::gpgv "false"; // Show the gpgv traffic
50e19557 304 aptcdrom "false"; // Show found package files
640c5d94 305 IdentCdrom "false";
8a3642bd 306
50e19557
AL
307}
308
309/* Whatever you do, do not use this configuration file!! Take out ONLY
310 the portions you need! */
311This Is Not A Valid Config File