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