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