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