doc/examples/configure-index

   1 /* This file is an index of all APT configuration directives. It should
   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
   4    values, unless you have specific needs you should NOT include arbitrary
   5    items in a custom configuration.
   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
  19 quiet "0";
  20
  21 // Options for APT in general
  22 APT
  23 {
  24   Architecture "i386";
  25   Build-Essential "build-essential";
  26
  27   NeverAutoRemove  { "linux-image.*";  };  // packages that should never
  28                                             // considered for autoRemove
  29
  30   // Options for apt-get
  31   Get
  32   {
  33      Arch-Only "false";
  34      AllowUnauthenticated "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      Build-Dep-Automatic "true";
  58      Show-User-Simulation-Note "true";
  59   };
  60
  61   Cache
  62   {
  63      Important "false";
  64      AllVersions "false";
  65      GivenOnly "false";
  66      RecurseDepends "false";
  67      ShowFull "false";
  68      Generate "true";
  69      NamesOnly "false";
  70      AllNames "false";
  71      Installed "false";
  72   };
  73
  74   CDROM
  75   {
  76      Rename "false";
  77      NoMount "false";
  78      Fast "false";
  79      NoAct "false";
  80   };
  81
  82   Update
  83   {
  84      Pre-Invoke {"touch /var/lib/apt/pre-update-stamp"; };
  85      Post-Invoke {"touch /var/lib/apt/post-update-stamp"; };
  86   };
  87
  88   Authentication
  89   {
  90      TrustCDROM "false";            // consider the CDROM always trusted
  91   };
  92
  93   // Some general options
  94   Ignore-Hold "false";
  95   Clean-Installed "true";
  96   Immediate-Configure "true";      // DO NOT turn this off, see the man page
  97   Force-LoopBreak "false";         // DO NOT turn this on, see the man page
  98   Cache-Limit "4194304";
  99   Default-Release "";
 100
 101   // consider Recommends, Suggests as important dependencies that should
 102   // be installed by default
 103   Install-Recommends "true";
 104   Install-Suggests "false";
 105
 106   // consider dependencies of packages in this section manual
 107   Never-MarkAuto-Sections {"metapackages"; "universe/metapackages"; };
 108
 109   // Write progress messages on this fd (for stuff like base-config)
 110   Status-Fd "-1";
 111   // Keep the list of FDs open (normally apt closes all fds when it
 112   // does a ExecFork)
 113   Keep-Fds {};
 114
 115   // control parameters for cron jobs by /etc/cron.daily/apt
 116   Periodic
 117   {
 118   BackupArchiveInterval "0";
 119   // - Backup after n-days if archive contents changed.(0=disable)
 120
 121   BackupLevel "3";
 122   // - Backup level.(0=disable), 1 is invalid.
 123
 124   // APT::Archives::MaxAge "0"; (old, deprecated)
 125   MaxAge "0"; // (new)
 126   // - Set maximum allowed age of a cache package file. If a cache
 127   //   package file is older it is deleted (0=disable)
 128
 129   // APT::Archives::MinAge "2"; (old, deprecated)
 130   MinAge "2"; // (new)
 131   // - Set minimum age of a package file. If a file is younger it
 132   //   will not be deleted (0=disable). Usefull to prevent races
 133   //   and to keep backups of the packages for emergency.
 134
 135   // APT::Archives::MaxSize "0"; (old, deprecated)
 136   MaxSize "0"; // (new)
 137   // - Set maximum size of the cache in MB (0=disable). If the cache
 138   //   is bigger, cached package files are deleted until the size
 139   //   requirement is met (the biggest packages will be deleted
 140   //   first).
 141
 142   Update-Package-Lists "0";
 143   // - Do "apt-get update" automatically every n-days (0=disable)
 144   //
 145   Download-Upgradeable-Packages "0";
 146   // - Do "apt-get upgrade --download-only" every n-days (0=disable)
 147   //
 148   Unattended-Upgrade "0";
 149   // - Run the "unattended-upgrade" security upgrade script
 150   //   every n-days (0=disabled)
 151   //   Requires the package "unattended-upgrades" and will write
 152   //   a log in /var/log/unattended-upgrades
 153   //
 154   AutocleanInterval "0";
 155   // - Do "apt-get autoclean" every n-days (0=disable)
 156
 157   Verbose "0";
 158   // - Send report mail to root
 159   //   0:  no report             (or null string)
 160   //   1:  progress report       (actually any string)
 161   //   2:  + command outputs     (remove -qq, remove 2>/dev/null, add -d)
 162   //   3:  + trace on
 163   };
 164 };
 165
 166 // Options for the downloading routines
 167 Acquire
 168 {
 169   Queue-Mode "host";       // host|access
 170   Retries "0";
 171   Source-Symlinks "true";
 172
 173   PDiffs "true";     // try to get the IndexFile diffs
 174   PDiffs::FileLimit "4"; // don't use diffs if we would need more than 4 diffs
 175   PDiffs::SizeLimit "50"; // don't use diffs if size of all patches excess
 176                           // 50% of the size of the original file
 177
 178   // HTTP method configuration
 179   http
 180   {
 181     Proxy "http://127.0.0.1:3128";
 182     Proxy::http.us.debian.org "DIRECT";  // Specific per-host setting
 183     Timeout "120";
 184     Pipeline-Depth "5";
 185     AllowRedirect  "true";
 186
 187     // Cache Control. Note these do not work with Squid 2.0.2
 188     No-Cache "false";
 189     Max-Age "86400";     // 1 Day age on index files
 190     No-Store "false";    // Prevent the cache from storing archives
 191     Dl-Limit "7";        // 7Kb/sec maximum download rate
 192     User-Agent "Debian APT-HTTP/1.3";
 193   };
 194
 195
 196
 197   // HTTPS method configuration: uses the http
 198   // - proxy config
 199   // - cache-control values
 200   // - Dl-Limit, Timout, ... values
 201   // if not set explicit for https
 202   //
 203   // see /usr/share/doc/apt/examples/apt-https-method-example.conf.gz
 204   // for more examples
 205   https
 206   {
 207         Verify-Peer "false";
 208         SslCert "/etc/apt/some.pem";
 209         CaPath  "/etc/ssl/certs";
 210         Verify-Host" "true";
 211         AllowRedirect  "true";
 212
 213         Timeout "120";
 214         AllowRedirect  "true";
 215
 216         // Cache Control. Note these do not work with Squid 2.0.2
 217         No-Cache "false";
 218         Max-Age "86400";     // 1 Day age on index files
 219         No-Store "false";    // Prevent the cache from storing archives
 220         Dl-Limit "7";        // 7Kb/sec maximum download rate
 221
 222         User-Agent "Debian APT-CURL/1.0";
 223   };
 224
 225   ftp
 226   {
 227     Proxy "ftp://127.0.0.1/";
 228     Proxy::http.us.debian.org "DIRECT"; // Specific per-host setting
 229
 230     /* Required script to perform proxy login. This example should work
 231        for tisfwtk */
 232     ProxyLogin
 233     {
 234        "USER $(PROXY_USER)";
 235        "PASS $(PROXY_PASS)";
 236        "USER $(SITE_USER)@$(SITE):$(SITE_PORT)";
 237        "PASS $(SITE_PASS)";
 238     };
 239
 240     Timeout "120";
 241
 242     /* Passive mode control, proxy, non-proxy and per-host. Pasv mode
 243        is preferred if possible */
 244     Passive "true";
 245     Proxy::Passive "true";
 246     Passive::http.us.debian.org "true"; // Specific per-host setting
 247   };
 248
 249   cdrom
 250   {
 251     // do auto detection of the cdrom mountpoint
 252     AutoDetect "true";
 253
 254     // cdrom mountpoint (needs to be defined in fstab if AutoDetect is not used)
 255     mount "/cdrom";
 256
 257     // You need the trailing slash!
 258     "/cdrom/"
 259     {
 260        Mount "sleep 1000";
 261        UMount "sleep 500";
 262     }
 263   };
 264
 265   gpgv
 266   {
 267    Options {"--ignore-time-conflict";}  // not very useful on a normal system
 268   };
 269
 270   CompressionTypes
 271   {
 272     bz2 "bzip2";
 273     lzma "lzma";
 274     gz "gzip";
 275
 276     Order { "gz"; "lzma"; "bz2"; };
 277   };
 278
 279   Languages
 280   {
 281      "environment";
 282      "de";
 283      "en";
 284      "none";
 285      "fr";
 286   };
 287 };
 288
 289 // Directory layout
 290 Dir "/"
 291 {
 292   // Location of the state dir
 293   State "var/lib/apt/"
 294   {
 295      Lists "lists/";
 296      xstatus "xstatus";
 297      userstatus "status.user";
 298      status "/var/lib/dpkg/status";
 299      cdroms "cdroms.list";
 300   };
 301
 302   // Location of the cache dir
 303   Cache "var/cache/apt/" {
 304      Archives "archives/";
 305      // backup directory created by /etc/cron.daily/apt
 306      Backup "backup/";
 307      srcpkgcache "srcpkgcache.bin";
 308      pkgcache "pkgcache.bin";
 309   };
 310
 311   // Config files
 312   Etc "etc/apt/" {
 313      Main "apt.conf";
 314      Netrc "auth.conf";
 315      Parts "apt.conf.d/";
 316      Preferences "preferences";
 317      PreferencesParts "preferences.d";
 318      SourceList "sources.list";
 319      SourceParts "sources.list.d";
 320      VendorList "vendors.list";
 321      VendorParts "vendors.list.d";
 322      Trusted "trusted.gpg";
 323      TrustedParts "trusted.gpg.d";
 324   };
 325
 326   // Locations of binaries
 327   Bin {
 328      methods "/usr/lib/apt/methods/";
 329      gzip "/bin/gzip";
 330      gpg  "/usr/bin/gpgv";
 331      dpkg "/usr/bin/dpkg";
 332      dpkg-source "/usr/bin/dpkg-source";
 333      dpkg-buildpackage "/usr/bin/dpkg-buildpackage";
 334      apt-get "/usr/bin/apt-get";
 335      apt-cache "/usr/bin/apt-cache";
 336   };
 337
 338   // Location of the logfile
 339   Log "var/log/apt" {
 340         Terminal "term.log";
 341         History "history.log";
 342   };
 343
 344   // Media
 345   Media
 346   {
 347         // Media AutoDetect mount path
 348         MountPath "/media/apt";
 349   };
 350
 351   // Media
 352   Media
 353   {
 354         // Media AutoDetect mount path
 355         MountPath "/media/apt";
 356   };
 357 };
 358
 359 // Things that effect the APT dselect method
 360 DSelect
 361 {
 362    Clean "auto";   // always|auto|prompt|never
 363    Options "-f";
 364    UpdateOptions "";
 365    PromptAfterUpdate "no";
 366    CheckDir "no";
 367 }
 368
 369 DPkg
 370 {
 371    // let apt aggressivly use dpkg triggers
 372    NoTriggers "true";
 373    NoConfigure "true";
 374    ConfigurePending "true";
 375
 376    // Probably don't want to use force-downgrade..
 377    Options {"--force-overwrite";"--force-downgrade";}
 378
 379    // Auto re-mounting of a readonly /usr
 380    Pre-Invoke {"mount -o remount,rw /usr";};
 381    Post-Invoke {"mount -o remount,ro /usr";};
 382
 383    Chroot-Directory "/";
 384
 385    // Prevents daemons from getting cwd as something mountable (default)
 386    Run-Directory "/";
 387
 388    // Build options for apt-get source --compile
 389    Build-Options "-b -uc";
 390
 391    // Pre-configure all packages before they are installed using debconf.
 392    Pre-Install-Pkgs {"dpkg-preconfigure --apt --priority=low --frontend=dialog";};
 393
 394    // Flush the contents of stdin before forking dpkg.
 395    FlushSTDIN "true";
 396
 397    // Control the size of the command line passed to dpkg.
 398    MaxBytes 1024;
 399    MaxArgs 350;
 400
 401    // controls if apt will apport on the first dpkg error or if it
 402    // tries to install as many packages as possible
 403    StopOnError "true";
 404 }
 405
 406 /* Options you can set to see some debugging text They correspond to names
 407    of classes in the source code */
 408 Debug
 409 {
 410   pkgProblemResolver "false";
 411   pkgProblemResolver::ShowScores "false";
 412   pkgDepCache::AutoInstall "false"; // what packages apt install to satify dependencies
 413   pkgDepCache::Marker "false";
 414   pkgCacheGen "false";
 415   pkgAcquire "false";
 416   pkgAcquire::Worker "false";
 417   pkgAcquire::Auth "false";
 418   pkgDPkgPM "false";
 419   pkgDPkgProgressReporting "false";
 420   pkgOrderList "false";
 421   pkgPackageManager "false"; // OrderList/Configure debugging
 422   pkgAutoRemove "false";   // show information about automatic removes
 423   BuildDeps "false";
 424   pkgInitialize "false";   // This one will dump the configuration space
 425   NoLocking "false";
 426   Acquire::Ftp "false";    // Show ftp command traffic
 427   Acquire::Http "false";   // Show http command traffic
 428   Acquire::Https "false";   // Show https debug
 429   Acquire::gpgv "false";   // Show the gpgv traffic
 430   aptcdrom "false";        // Show found package files
 431   IdentCdrom "false";
 432   acquire::netrc "false";  // netrc parser
 433
 434 }
 435
 436 pkgCacheGen::Essential "native"; // other modes: all, none, installed
 437
 438 /* Whatever you do, do not use this configuration file!! Take out ONLY
 439    the portions you need! */
 440 This Is Not A Valid Config File