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
 120 // Options for the downloading routines
 121 Acquire
 122 {
 123   Queue-Mode "host";       // host|access
 124   Retries "0";
 125   Source-Symlinks "true";
 126
 127   PDiffs "true";     // try to get the IndexFile diffs
 128
 129   // HTTP method configuration
 130   http
 131   {
 132     Proxy "http://127.0.0.1:3128";
 133     Proxy::http.us.debian.org "DIRECT";  // Specific per-host setting
 134     Timeout "120";
 135     Pipeline-Depth "5";
 136     AllowRedirect  "true";
 137
 138     // Cache Control. Note these do not work with Squid 2.0.2
 139     No-Cache "false";
 140     Max-Age "86400";     // 1 Day age on index files
 141     No-Store "false";    // Prevent the cache from storing archives
 142     Dl-Limit "7";        // 7Kb/sec maximum download rate
 143   };
 144
 145   // HTTPS method configuration:
 146   // - uses the http proxy config
 147   // - uses the http cache-control values
 148   // - uses the http Dl-Limit values
 149   https
 150   {
 151         Verify-Peer "false";
 152         SslCert "/etc/apt/some.pem";
 153         CaPath  "/etc/ssl/certs";
 154         Verify-Host" "true";
 155         AllowRedirect  "true";
 156   };
 157
 158   ftp
 159   {
 160     Proxy "ftp://127.0.0.1/";
 161     Proxy::http.us.debian.org "DIRECT"; // Specific per-host setting
 162
 163     /* Required script to perform proxy login. This example should work
 164        for tisfwtk */
 165     ProxyLogin
 166     {
 167        "USER $(PROXY_USER)";
 168        "PASS $(PROXY_PASS)";
 169        "USER $(SITE_USER)@$(SITE):$(SITE_PORT)";
 170        "PASS $(SITE_PASS)";
 171     };
 172
 173     Timeout "120";
 174
 175     /* Passive mode control, proxy, non-proxy and per-host. Pasv mode
 176        is preferred if possible */
 177     Passive "true";
 178     Proxy::Passive "true";
 179     Passive::http.us.debian.org "true"; // Specific per-host setting
 180   };
 181
 182   cdrom
 183   {
 184     mount "/cdrom";
 185
 186     // You need the trailing slash!
 187     "/cdrom/"
 188     {
 189        Mount "sleep 1000";
 190        UMount "sleep 500";
 191     }
 192   };
 193
 194   gpgv
 195   {
 196    Options {"--ignore-time-conflict";}  // not very useful on a normal system
 197   };
 198 };
 199
 200 // Directory layout
 201 Dir "/"
 202 {
 203   // Location of the state dir
 204   State "var/lib/apt/"
 205   {
 206      Lists "lists/";
 207      xstatus "xstatus";
 208      userstatus "status.user";
 209      status "/var/lib/dpkg/status";
 210      cdroms "cdroms.list";
 211   };
 212
 213   // Location of the cache dir
 214   Cache "var/cache/apt/" {
 215      Archives "archives/";
 216      srcpkgcache "srcpkgcache.bin";
 217      pkgcache "pkgcache.bin";
 218   };
 219
 220   // Config files
 221   Etc "etc/apt/" {
 222      Main "apt.conf";
 223      Parts "apt.conf.d/";
 224      Preferences "preferences";
 225      SourceList "sources.list";
 226      SourceParts "sources.list.d";
 227      VendorList "vendors.list";
 228      VendorParts "vendors.list.d";
 229   };
 230
 231   // Locations of binaries
 232   Bin {
 233      methods "/usr/lib/apt/methods/";
 234      gzip "/bin/gzip";
 235      gpg  "/usr/bin/gpgv";
 236      dpkg "/usr/bin/dpkg";
 237      dpkg-source "/usr/bin/dpkg-source";
 238      dpkg-buildpackage "/usr/bin/dpkg-buildpackage";
 239      apt-get "/usr/bin/apt-get";
 240      apt-cache "/usr/bin/apt-cache";
 241   };
 242
 243   // Location of the logfile
 244   Log "var/log/apt" {
 245         Terminal "term.log";
 246   };
 247 };
 248
 249 // Things that effect the APT dselect method
 250 DSelect
 251 {
 252    Clean "auto";   // always|auto|prompt|never
 253    Options "-f";
 254    UpdateOptions "";
 255    PromptAfterUpdate "no";
 256    CheckDir "no";
 257 }
 258
 259 DPkg
 260 {
 261    // Probably don't want to use force-downgrade..
 262    Options {"--force-overwrite";"--force-downgrade";}
 263
 264    // Auto re-mounting of a readonly /usr
 265    Pre-Invoke {"mount -o remount,rw /usr";};
 266    Post-Invoke {"mount -o remount,ro /usr";};
 267
 268    // Prevents daemons from getting cwd as something mountable (default)
 269    Run-Directory "/";
 270
 271    // Build options for apt-get source --compile
 272    Build-Options "-b -uc";
 273
 274    // Pre-configure all packages before they are installed using debconf.
 275    Pre-Install-Pkgs {"dpkg-preconfigure --apt --priority=low --frontend=dialog";};
 276
 277    // Flush the contents of stdin before forking dpkg.
 278    FlushSTDIN "true";
 279
 280    // Control the size of the command line passed to dpkg.
 281    MaxBytes 1024;
 282    MaxArgs 350;
 283
 284    // controls if apt will apport on the first dpkg error or if it
 285    // tries to install as many packages as possible
 286    StopOnError "true";
 287 }
 288
 289 /* Options you can set to see some debugging text They correspond to names
 290    of classes in the source code */
 291 Debug
 292 {
 293   pkgProblemResolver "false";
 294   pkgProblemResolver::ShowScores "false";
 295   pkgDepCache::AutoInstall "false"; // what packages apt install to satify dependencies
 296   pkgDepCache::Marker "false";
 297   pkgAcquire "false";
 298   pkgAcquire::Worker "false";
 299   pkgAcquire::Auth "false";
 300   pkgDPkgPM "false";
 301   pkgDPkgProgressReporting "false";
 302   pkgOrderList "false";
 303   pkgAutoRemove "false";   // show information about automatic removes
 304   BuildDeps "false";
 305   pkgInitialize "false";   // This one will dump the configuration space
 306   NoLocking "false";
 307   Acquire::Ftp "false";    // Show ftp command traffic
 308   Acquire::Http "false";   // Show http command traffic
 309   Acquire::Https "false";   // Show https debug
 310   Acquire::gpgv "false";   // Show the gpgv traffic
 311   aptcdrom "false";        // Show found package files
 312   IdentCdrom "false";
 313
 314 }
 315
 316 /* Whatever you do, do not use this configuration file!! Take out ONLY
 317    the portions you need! */
 318 This Is Not A Valid Config File