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