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 arbitrary
   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   NeverAutoRemove  { "linux-kernel.*";  };  // packages that should never
  29                                             // considered for autoRemove
  30
  31   // Options for apt-get
  32   Get
  33   {
  34      Arch-Only "false";
  35      AutomaticRemove "false";
  36      HideAutoRemove "false";
  37      Download-Only "false";
  38      Simulate "false";
  39      Assume-Yes "false";
  40      Force-Yes "false";             // I would never set this.
  41      Fix-Broken "false";
  42      Fix-Missing "false";
  43      Show-Upgraded "false";
  44      Show-Versions "false";
  45      Upgrade "true";
  46      Print-URIs "false";
  47      Compile "false";
  48      Download "true";
  49      Purge "false";
  50      List-Cleanup "true";
  51      ReInstall "false";
  52      Trivial-Only "false";
  53      Remove "true";
  54      Only-Source "";
  55      Diff-Only "false";
  56      Tar-Only "false";
  57   };
  58
  59   Cache
  60   {
  61      Important "false";
  62      AllVersions "false";
  63      GivenOnly "false";
  64      RecurseDepends "false";
  65      ShowFull "false";
  66      Generate "true";
  67      NamesOnly "false";
  68      AllNames "false";
  69      Installed "false";
  70   };
  71
  72   CDROM
  73   {
  74      Rename "false";
  75      NoMount "false";
  76      Fast "false";
  77      NoAct "false";
  78   };
  79
  80   Update
  81   {
  82      Pre-Invoke {"touch /var/lib/apt/pre-update-stamp"; };
  83      Post-Invoke {"touch /var/lib/apt/post-update-stamp"; };
  84   };
  85
  86   Authentication
  87   {
  88      TrustCDROM "false";            // consider the CDROM always trusted
  89   };
  90
  91   GPGV
  92   {
  93      TrustedKeyring "/etc/apt/trusted.gpg";
  94   };
  95
  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
 101   Cache-Limit "4194304";
 102   Default-Release "";
 103
 104   // consider Recommends, Suggests as important dependencies that should
 105   // be installed by default
 106   Install-Recommends "false";
 107   Install-Suggests "false";
 108
 109   // install recommends automatically for packages in this section
 110   Install-Recommends-Section { "metapackages"; "universe/metapackages"; };
 111
 112   // consider dependencies of packages in this section manual
 113   Never-MarkAuto-Sections {"metapackages"; "universe/metapackages"; };
 114
 115   // Write progress messages on this fd (for stuff like base-config)
 116   Status-Fd "-1";
 117   // Keep the list of FDs open (normally apt closes all fds when it
 118   // does a ExecFork)
 119   Keep-Fds {};
 120 };
 121
 122 // Options for the downloading routines
 123 Acquire
 124 {
 125   Queue-Mode "host";       // host|access
 126   Retries "0";
 127   Source-Symlinks "true";
 128
 129   PDiffs "true";     // try to get the IndexFile diffs
 130
 131   // HTTP method configuration
 132   http
 133   {
 134     Proxy "http://127.0.0.1:3128";
 135     Proxy::http.us.debian.org "DIRECT";  // Specific per-host setting
 136     Timeout "120";
 137     Pipeline-Depth "5";
 138
 139     // Cache Control. Note these do not work with Squid 2.0.2
 140     No-Cache "false";
 141     Max-Age "86400";     // 1 Day age on index files
 142     No-Store "false";    // Prevent the cache from storing archives
 143     Dl-Limit "7";        // 7Kb/sec maximum download rate
 144   };
 145
 146   // HTTPS method configuration:
 147   // - uses the http proxy config
 148   // - uses the http cache-control values
 149   // - uses the http Dl-Limit values
 150   https
 151   {
 152         Verify-Peer "false";
 153         SslCert "/etc/apt/some.pem";
 154         CaPath  "/etc/ssl/certs";
 155         Verify-Host" "2";
 156   };
 157
 158   ftp
 159   {
 160     Proxy "ftp://127.0.0.1/";
 161     Proxy::http.us.debian.org "DIRECT"; // Specific per-host setting
 162
 163     /* Required script to perform proxy login. This example should work
 164        for tisfwtk */
 165     ProxyLogin
 166     {
 167        "USER $(PROXY_USER)";
 168        "PASS $(PROXY_PASS)";
 169        "USER $(SITE_USER)@$(SITE):$(SITE_PORT)";
 170        "PASS $(SITE_PASS)";
 171     };
 172
 173     Timeout "120";
 174
 175     /* Passive mode control, proxy, non-proxy and per-host. Pasv mode
 176        is preferred if possible */
 177     Passive "true";
 178     Proxy::Passive "true";
 179     Passive::http.us.debian.org "true"; // Specific per-host setting
 180   };
 181
 182   cdrom
 183   {
 184     mount "/cdrom";
 185
 186     // You need the trailing slash!
 187     "/cdrom/"
 188     {
 189        Mount "sleep 1000";
 190        UMount "sleep 500";
 191     }
 192   };
 193
 194   gpgv
 195   {
 196    Options {"--ignore-time-conflict";}  // not very useful on a normal system
 197   };
 198
 199   mirror
 200   {
 201    RefreshInterval "360"; // refresh interval in minutes
 202    MaxAge "90";           // max age for a mirror file in days before
 203                           // it gets deleted
 204    // mirror failure reporting script
 205    ProblemReporting "/usr/lib/apt/apt-report-mirror-failure";
 206    // mirror failure reporting url
 207    ReportFailures "http://example.com/mirror-failure";
 208   };
 209
 210   // translations can be set here to "none", "environment" or "$locale"
 211   Translation "none";
 212 };
 213
 214 // Directory layout
 215 Dir "/"
 216 {
 217   // Location of the state dir
 218   State "var/lib/apt/"
 219   {
 220      Lists "lists/";
 221      xstatus "xstatus";
 222      userstatus "status.user";
 223      status "/var/lib/dpkg/status";
 224      cdroms "cdroms.list";
 225      mirrors "mirrors/";
 226   };
 227
 228   // Location of the cache dir
 229   Cache "var/cache/apt/" {
 230      Archives "archives/";
 231      srcpkgcache "srcpkgcache.bin";
 232      pkgcache "pkgcache.bin";
 233   };
 234
 235   // Config files
 236   Etc "etc/apt/" {
 237      SourceList "sources.list";
 238      Main "apt.conf";
 239      Preferences "preferences";
 240      Parts "apt.conf.d/";
 241   };
 242
 243   // Locations of binaries
 244   Bin {
 245      methods "/usr/lib/apt/methods/";
 246      gzip "/bin/gzip";
 247      gpg  "/usr/bin/gpgv";
 248      dpkg "/usr/bin/dpkg";
 249      dpkg-source "/usr/bin/dpkg-source";
 250      dpkg-buildpackage "/usr/bin/dpkg-buildpackage";
 251      apt-get "/usr/bin/apt-get";
 252      apt-cache "/usr/bin/apt-cache";
 253   };
 254
 255   // Location of the logfile
 256   Log "var/log/apt" {
 257         Terminal "term.log";
 258   };
 259 };
 260
 261 // Things that effect the APT dselect method
 262 DSelect
 263 {
 264    Clean "auto";   // always|auto|prompt|never
 265    Options "-f";
 266    UpdateOptions "";
 267    PromptAfterUpdate "no";
 268    CheckDir "no";
 269 }
 270
 271 DPkg
 272 {
 273    // Probably don't want to use force-downgrade..
 274    Options {"--force-overwrite";"--force-downgrade";}
 275
 276    // Auto re-mounting of a readonly /usr
 277    Pre-Invoke {"mount -o remount,rw /usr";};
 278    Post-Invoke {"mount -o remount,ro /usr";};
 279
 280    // Prevents daemons from getting cwd as something mountable (default)
 281    Run-Directory "/";
 282
 283    // Build options for apt-get source --compile
 284    Build-Options "-b -uc";
 285
 286    // Pre-configure all packages before they are installed using debconf.
 287    Pre-Install-Pkgs {"dpkg-preconfigure --apt --priority=low --frontend=dialog";};
 288
 289    // Flush the contents of stdin before forking dpkg.
 290    FlushSTDIN "true";
 291
 292    // Control the size of the command line passed to dpkg.
 293    MaxBytes 1024;
 294    MaxArgs 350;
 295
 296    // controls if apt will apport on the first dpkg error or if it
 297    // tries to install as many packages as possible
 298    StopOnError "true";
 299 }
 300
 301 /* Options you can set to see some debugging text They correspond to names
 302    of classes in the source code */
 303 Debug
 304 {
 305   pkgProblemResolver "false";
 306   pkgDepCache::AutoInstall "false"; // what packages apt install to satify dependencies
 307   pkgAcquire "false";
 308   pkgAcquire::Worker "false";
 309   pkgAcquire::Auth "false";
 310   pkgDPkgPM "false";
 311   pkgDPkgProgressReporting "false";
 312   pkgOrderList "false";
 313   pkgAutoRemove "false";   // show information about automatic removes
 314   BuildDeps "false";
 315   pkgInitialize "false";   // This one will dump the configuration space
 316   NoLocking "false";
 317   Acquire::Ftp "false";    // Show ftp command traffic
 318   Acquire::Http "false";   // Show http command traffic
 319   Acquire::Https "false";   // Show https debug
 320   Acquire::gpgv "false";   // Show the gpgv traffic
 321   Acquire::Mirror "false"; // Show debugging of the mirror method
 322   aptcdrom "false";        // Show found package files
 323   IdentCdrom "false";
 324 }
 325
 326 /* Whatever you do, do not use this configuration file!! Take out ONLY
 327    the portions you need! */
 328 This Is Not A Valid Config File