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