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