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   ForceHash "sha256"; // hashmethod used for expected hash: sha256, sha1 or md5sum
 173
 174   PDiffs "true";     // try to get the IndexFile diffs
 175   PDiffs::FileLimit "4"; // don't use diffs if we would need more than 4 diffs
 176   PDiffs::SizeLimit "50"; // don't use diffs if size of all patches excess
 177                           // 50% of the size of the original file
 178
 179   Check-Valid-Until "true";
 180   Max-ValidTime "864000"; // 10 days
 181   Max-ValidTime::Debian-Security "604800"; // 7 days, label specific configuration
 182
 183   // HTTP method configuration
 184   http
 185   {
 186     Proxy "http://127.0.0.1:3128";
 187     Proxy::http.us.debian.org "DIRECT";  // Specific per-host setting
 188     Timeout "120";
 189     Pipeline-Depth "5";
 190     AllowRedirect  "true";
 191
 192     // Cache Control. Note these do not work with Squid 2.0.2
 193     No-Cache "false";
 194     Max-Age "86400";     // 1 Day age on index files
 195     No-Store "false";    // Prevent the cache from storing archives
 196     Dl-Limit "7";        // 7Kb/sec maximum download rate
 197     User-Agent "Debian APT-HTTP/1.3";
 198   };
 199
 200
 201
 202   // HTTPS method configuration: uses the http
 203   // - proxy config
 204   // - cache-control values
 205   // - Dl-Limit, Timout, ... values
 206   // if not set explicit for https
 207   //
 208   // see /usr/share/doc/apt/examples/apt-https-method-example.conf.gz
 209   // for more examples
 210   https
 211   {
 212         Verify-Peer "false";
 213         SslCert "/etc/apt/some.pem";
 214         CaPath  "/etc/ssl/certs";
 215         Verify-Host" "true";
 216         AllowRedirect  "true";
 217
 218         Timeout "120";
 219         AllowRedirect  "true";
 220
 221         // Cache Control. Note these do not work with Squid 2.0.2
 222         No-Cache "false";
 223         Max-Age "86400";     // 1 Day age on index files
 224         No-Store "false";    // Prevent the cache from storing archives
 225         Dl-Limit "7";        // 7Kb/sec maximum download rate
 226
 227         User-Agent "Debian APT-CURL/1.0";
 228   };
 229
 230   ftp
 231   {
 232     Proxy "ftp://127.0.0.1/";
 233     Proxy::http.us.debian.org "DIRECT"; // Specific per-host setting
 234
 235     /* Required script to perform proxy login. This example should work
 236        for tisfwtk */
 237     ProxyLogin
 238     {
 239        "USER $(PROXY_USER)";
 240        "PASS $(PROXY_PASS)";
 241        "USER $(SITE_USER)@$(SITE):$(SITE_PORT)";
 242        "PASS $(SITE_PASS)";
 243     };
 244
 245     Timeout "120";
 246
 247     /* Passive mode control, proxy, non-proxy and per-host. Pasv mode
 248        is preferred if possible */
 249     Passive "true";
 250     Proxy::Passive "true";
 251     Passive::http.us.debian.org "true"; // Specific per-host setting
 252   };
 253
 254   cdrom
 255   {
 256     // do auto detection of the cdrom mountpoint
 257     AutoDetect "true";
 258
 259     // cdrom mountpoint (needs to be defined in fstab if AutoDetect is not used)
 260     mount "/cdrom";
 261
 262     // You need the trailing slash!
 263     "/cdrom/"
 264     {
 265        Mount "sleep 1000";
 266        UMount "sleep 500";
 267     }
 268   };
 269
 270   gpgv
 271   {
 272    Options {"--ignore-time-conflict";}  // not very useful on a normal system
 273   };
 274
 275   CompressionTypes
 276   {
 277     bz2 "bzip2";
 278     lzma "lzma";
 279     gz "gzip";
 280
 281     Order { "gz"; "lzma"; "bz2"; };
 282   };
 283
 284   Languages
 285   {
 286      "environment";
 287      "de";
 288      "en";
 289      "none";
 290      "fr";
 291   };
 292 };
 293
 294 // Directory layout
 295 Dir "/"
 296 {
 297   // Location of the state dir
 298   State "var/lib/apt/"
 299   {
 300      Lists "lists/";
 301      status "/var/lib/dpkg/status";
 302      extended_states "extended_states";
 303      cdroms "cdroms.list";
 304   };
 305
 306   // Location of the cache dir
 307   Cache "var/cache/apt/" {
 308      Archives "archives/";
 309      // backup directory created by /etc/cron.daily/apt
 310      Backup "backup/";
 311      srcpkgcache "srcpkgcache.bin";
 312      pkgcache "pkgcache.bin";
 313   };
 314
 315   // Config files
 316   Etc "etc/apt/" {
 317      Main "apt.conf";
 318      Netrc "auth.conf";
 319      Parts "apt.conf.d/";
 320      Preferences "preferences";
 321      PreferencesParts "preferences.d";
 322      SourceList "sources.list";
 323      SourceParts "sources.list.d";
 324      VendorList "vendors.list";
 325      VendorParts "vendors.list.d";
 326      Trusted "trusted.gpg";
 327      TrustedParts "trusted.gpg.d";
 328   };
 329
 330   // Locations of binaries
 331   Bin {
 332      methods "/usr/lib/apt/methods/";
 333      gzip "/bin/gzip";
 334      gpg  "/usr/bin/gpgv";
 335      dpkg "/usr/bin/dpkg";
 336      dpkg-source "/usr/bin/dpkg-source";
 337      dpkg-buildpackage "/usr/bin/dpkg-buildpackage";
 338      apt-get "/usr/bin/apt-get";
 339      apt-cache "/usr/bin/apt-cache";
 340   };
 341
 342   // Location of the logfile
 343   Log "var/log/apt" {
 344         Terminal "term.log";
 345         History "history.log";
 346   };
 347
 348   // Media
 349   Media
 350   {
 351         // Media AutoDetect mount path
 352         MountPath "/media/apt";
 353   };
 354
 355   // Media
 356   Media
 357   {
 358         // Media AutoDetect mount path
 359         MountPath "/media/apt";
 360   };
 361 };
 362
 363 // Things that effect the APT dselect method
 364 DSelect
 365 {
 366    Clean "auto";   // always|auto|prompt|never
 367    Options "-f";
 368    UpdateOptions "";
 369    PromptAfterUpdate "no";
 370    CheckDir "no";
 371 }
 372
 373 DPkg
 374 {
 375    // let apt aggressivly use dpkg triggers
 376    NoTriggers "true";
 377    NoConfigure "true";
 378    ConfigurePending "true";
 379
 380    // Probably don't want to use force-downgrade..
 381    Options {"--force-overwrite";"--force-downgrade";}
 382
 383    // Auto re-mounting of a readonly /usr
 384    Pre-Invoke {"mount -o remount,rw /usr";};
 385    Post-Invoke {"mount -o remount,ro /usr";};
 386
 387    Chroot-Directory "/";
 388
 389    // Prevents daemons from getting cwd as something mountable (default)
 390    Run-Directory "/";
 391
 392    // Build options for apt-get source --compile
 393    Build-Options "-b -uc";
 394
 395    // Pre-configure all packages before they are installed using debconf.
 396    Pre-Install-Pkgs {"dpkg-preconfigure --apt --priority=low --frontend=dialog";};
 397
 398    // Flush the contents of stdin before forking dpkg.
 399    FlushSTDIN "true";
 400
 401    // Control the size of the command line passed to dpkg.
 402    MaxBytes 1024;
 403    MaxArgs 350;
 404
 405    // controls if apt will apport on the first dpkg error or if it
 406    // tries to install as many packages as possible
 407    StopOnError "true";
 408 }
 409
 410 /* Options you can set to see some debugging text They correspond to names
 411    of classes in the source code */
 412 Debug
 413 {
 414   pkgProblemResolver "false";
 415   pkgProblemResolver::ShowScores "false";
 416   pkgDepCache::AutoInstall "false"; // what packages apt install to satify dependencies
 417   pkgDepCache::Marker "false";
 418   pkgCacheGen "false";
 419   pkgAcquire "false";
 420   pkgAcquire::Worker "false";
 421   pkgAcquire::Auth "false";
 422   pkgDPkgPM "false";
 423   pkgDPkgProgressReporting "false";
 424   pkgOrderList "false";
 425   pkgPackageManager "false"; // OrderList/Configure debugging
 426   pkgAutoRemove "false";   // show information about automatic removes
 427   BuildDeps "false";
 428   pkgInitialize "false";   // This one will dump the configuration space
 429   NoLocking "false";
 430   Acquire::Ftp "false";    // Show ftp command traffic
 431   Acquire::Http "false";   // Show http command traffic
 432   Acquire::Https "false";   // Show https debug
 433   Acquire::gpgv "false";   // Show the gpgv traffic
 434   aptcdrom "false";        // Show found package files
 435   IdentCdrom "false";
 436   acquire::netrc "false";  // netrc parser
 437
 438 }
 439
 440 pkgCacheGen::Essential "native"; // other modes: all, none, installed
 441
 442 /* Whatever you do, do not use this configuration file!! Take out ONLY
 443    the portions you need! */
 444 This Is Not A Valid Config File