]> git.saurik.com Git - apt.git/blame - doc/examples/configure-index
* merged with apt@packages.debian.org/apt--main--0
[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
5 values, unless you have specific needs you should NOT include arbitary
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";
50e19557
AL
27
28 // Options for apt-get
29 Get
30 {
7d6f9f8f 31 Arch-Only "false";
50e19557
AL
32 Download-Only "false";
33 Simulate "false";
34 Assume-Yes "false";
35 Force-Yes "false"; // I would never set this.
36 Fix-Broken "false";
37 Fix-Missing "false";
38 Show-Upgraded "false";
640c5d94 39 Show-Versions "false";
b2e465d6 40 Upgrade "true";
50e19557
AL
41 Print-URIs "false";
42 Compile "false";
b2e465d6 43 Download "true";
50e19557
AL
44 Purge "false";
45 List-Cleanup "true";
46 ReInstall "false";
47 Trivial-Only "false";
b2e465d6 48 Remove "true";
640c5d94
MZ
49 Only-Source "";
50 Diff-Only "false";
51 Tar-Only "false";
50e19557
AL
52 };
53
54 Cache
55 {
56 Important "false";
57 AllVersions "false";
8c6e33d8 58 GivenOnly "false";
153a849d 59 RecurseDepends "false";
640c5d94
MZ
60 ShowFull "false";
61 Generate "true";
62 NamesOnly "false";
63 AllNames "false";
64 Installed "false";
50e19557
AL
65 };
66
67 CDROM
68 {
69 Rename "false";
70 NoMount "false";
71 Fast "false";
72 NoAct "false";
73 };
74
8a3642bd
MV
75 GPGV
76 {
77 TrustedKeyring "/etc/apt/trusted.gpg";
78 };
79
50e19557
AL
80 // Some general options
81 Ignore-Hold "false";
82 Clean-Installed "true";
83 Immediate-Configure "true"; // DO NOT turn this off, see the man page
84 Force-LoopBreak "false"; // DO NOT turn this on, see the man page
85 Cache-Limit "4194304";
877d310f 86 Default-Release "";
f77bf408
MV
87
88
89 // Write progress messages on this fd (for stuff like base-config)
90 Status-Fd "-1";
91 // Keep the list of FDs open (normally apt closes all fds when it
92 // does a ExecFork)
93 Keep-Fds {};
50e19557
AL
94};
95
96// Options for the downloading routines
97Acquire
98{
99 Queue-Mode "host"; // host|access
100 Retries "0";
101 Source-Symlinks "true";
102
103 // HTTP method configuration
104 http
105 {
106 Proxy "http://127.0.0.1:3128";
107 Proxy::http.us.debian.org "DIRECT"; // Specific per-host setting
108 Timeout "120";
109 Pipeline-Depth "5";
110
111 // Cache Control. Note these do not work with Squid 2.0.2
112 No-Cache "false";
113 Max-Age "86400"; // 1 Day age on index files
114 No-Store "false"; // Prevent the cache from storing archives
115 };
116
117 ftp
118 {
119 Proxy "ftp://127.0.0.1/";
120 Proxy::http.us.debian.org "DIRECT"; // Specific per-host setting
121
122 /* Required script to perform proxy login. This example should work
123 for tisfwtk */
124 ProxyLogin
125 {
126 "USER $(PROXY_USER)";
127 "PASS $(PROXY_PASS)";
128 "USER $(SITE_USER)@$(SITE):$(SITE_PORT)";
129 "PASS $(SITE_PASS)";
130 };
131
132 Timeout "120";
133
134 /* Passive mode control, proxy, non-proxy and per-host. Pasv mode
135 is prefered if possible */
136 Passive "true";
137 Proxy::Passive "true";
138 Passive::http.us.debian.org "true"; // Specific per-host setting
139 };
140
141 cdrom
142 {
640c5d94 143 mount "/cdrom";
50e19557
AL
144
145 // You need the trailing slash!
146 "/cdrom/"
147 {
148 Mount "sleep 1000";
149 UMount "sleep 500";
150 }
151 };
e75f306e
MV
152
153 gpgv
154 {
155 Options {"--ignore-time-conflict";} // not very usefull on a normal system
156 };
50e19557
AL
157};
158
159// Directory layout
b2e465d6 160Dir "/"
50e19557
AL
161{
162 // Location of the state dir
b2e465d6 163 State "var/lib/apt/"
50e19557 164 {
640c5d94 165 Lists "lists/";
50e19557
AL
166 xstatus "xstatus";
167 userstatus "status.user";
168 status "/var/lib/dpkg/status";
169 cdroms "cdroms.list";
170 };
171
172 // Location of the cache dir
b2e465d6 173 Cache "var/cache/apt/" {
640c5d94 174 Archives "archives/";
50e19557
AL
175 srcpkgcache "srcpkgcache.bin";
176 pkgcache "pkgcache.bin";
177 };
178
179 // Config files
b2e465d6 180 Etc "etc/apt/" {
640c5d94
MZ
181 SourceList "sources.list";
182 Main "apt.conf";
183 Preferences "preferences";
184 Parts "apt.conf.d/";
50e19557
AL
185 };
186
187 // Locations of binaries
188 Bin {
189 methods "/usr/lib/apt/methods/";
190 gzip "/bin/gzip";
8a3642bd 191 gpg "/usr/bin/gpgv";
50e19557
AL
192 dpkg "/usr/bin/dpkg";
193 dpkg-source "/usr/bin/dpkg-source";
2a065e4e 194 dpkg-buildpackage "/usr/bin/dpkg-buildpackage";
50e19557
AL
195 apt-get "/usr/bin/apt-get";
196 apt-cache "/usr/bin/apt-cache";
197 };
198};
199
200// Things that effect the APT dselect method
201DSelect
202{
203 Clean "auto"; // always|auto|prompt|never
204 Options "-f";
205 UpdateOptions "";
206 PromptAfterUpdate "no";
b2e465d6 207 CheckDir "no";
50e19557
AL
208}
209
210DPkg
211{
212 // Probably don't want to use force-downgrade..
213 Options {"--force-overwrite";"--force-downgrade";}
214
215 // Auto re-mounting of a readonly /usr
216 Pre-Invoke {"mount -o remount,rw /usr";};
217 Post-Invoke {"mount -o remount,ro /usr";};
218
219 // Prevents daemons from getting cwd as something mountable (default)
220 Run-Directory "/";
221
222 // Build options for apt-get source --compile
223 Build-Options "-b -uc";
224
225 // Pre-configure all packages before they are installed using debconf.
99a202d6 226 Pre-Install-Pkgs {"dpkg-preconfigure --apt --priority=low --frontend=dialog";};
8c6e33d8
AL
227
228 // Flush the contents of stdin before forking dpkg.
229 FlushSTDIN "true";
358688a8
AL
230
231 // Control the size of the command line passed to dpkg.
232 MaxBytes 1024;
233 MaxArgs 350;
50e19557
AL
234}
235
2d425135 236/* Options you can set to see some debugging text They correspond to names
50e19557
AL
237 of classes in the source code */
238Debug
239{
240 pkgProblemResolver "false";
241 pkgAcquire "false";
242 pkgAcquire::Worker "false";
243 pkgDPkgPM "false";
f77bf408 244 pkgDPkgProgressReporting "false";
b2e465d6 245 pkgOrderList "false";
50e19557
AL
246
247 pkgInitialize "false"; // This one will dump the configuration space
248 NoLocking "false";
249 Acquire::Ftp "false"; // Show ftp command traffic
250 Acquire::Http "false"; // Show http command traffic
8a3642bd 251 Acquire::gpgv "false"; // Show the gpgv traffic
50e19557 252 aptcdrom "false"; // Show found package files
640c5d94 253 IdentCdrom "false";
8a3642bd 254
50e19557
AL
255}
256
257/* Whatever you do, do not use this configuration file!! Take out ONLY
258 the portions you need! */
259This Is Not A Valid Config File