doc/examples/configure-index

   1 // $Id: configure-index,v 1.10 2004/07/17 19:37:16 mdz Exp $
   2 /* This file is an index of all APT configuration directives. It should
   3    NOT actually be used as a real config file, though it is (except for the
   4    last line) a completely valid file. Most of the options have sane default
   5    values, unless you have specific needs you should NOT include arbitary
   6    items in a custom configuration.
   7
   8    In some instances involving filenames it is possible to set the default
   9    directory when the path is evaluated. This means you can use relative
  10    paths within the sub scope.
  11
  12    The configuration directives are specified in a tree with {} designating
  13    a subscope relative to the tag before the {}. You can further specify
  14    a subscope using scope notation eg,
  15      APT::Architecture "i386";
  16    This is prefixed with the current scope. Scope notation must be used
  17    if an option is specified on the command line with -o.
  18 */
  19
  20 quiet "0";
  21
  22 // Options for APT in general
  23 APT
  24 {
  25   Architecture "i386";
  26   Build-Essential "build-essential";
  27
  28   NeverAutoRemove  { "linux-kernel.*";  };  // packages that should never
  29                                             // considered for autoRemove
  30
  31   // Options for apt-get
  32   Get
  33   {
  34      Arch-Only "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   };
  58
  59   Cache
  60   {
  61      Important "false";
  62      AllVersions "false";
  63      GivenOnly "false";
  64      RecurseDepends "false";
  65      ShowFull "false";
  66      Generate "true";
  67      NamesOnly "false";
  68      AllNames "false";
  69      Installed "false";
  70   };
  71
  72   CDROM
  73   {
  74      Rename "false";
  75      NoMount "false";
  76      Fast "false";
  77      NoAct "false";
  78   };
  79
  80   Authentication
  81   {
  82      TrustCDROM "false";            // consider the CDROM always trusted
  83   };
  84
  85   GPGV
  86   {
  87      TrustedKeyring "/etc/apt/trusted.gpg";
  88   };
  89
  90   // Some general options
  91   Ignore-Hold "false";
  92   Clean-Installed "true";
  93   Immediate-Configure "true";      // DO NOT turn this off, see the man page
  94   Force-LoopBreak "false";         // DO NOT turn this on, see the man page
  95   Cache-Limit "4194304";
  96   Default-Release "";
  97
  98   // consider Recommends, Suggests as important dependencies that should
  99   // be installed by default
 100   APT::Install-Recommends "false";
 101   APT::Install-Suggests "false";
 102
 103   // consider dependencies of packages in this section manual
 104   Never-MarkAuto-Section "metapackages";
 105
 106   // Write progress messages on this fd (for stuff like base-config)
 107   Status-Fd "-1";
 108   // Keep the list of FDs open (normally apt closes all fds when it
 109   // does a ExecFork)
 110   Keep-Fds {};
 111 };
 112
 113 // Options for the downloading routines
 114 Acquire
 115 {
 116   Queue-Mode "host";       // host|access
 117   Retries "0";
 118   Source-Symlinks "true";
 119
 120   PDiffs "true";     // try to get the IndexFile diffs
 121
 122   // HTTP method configuration
 123   http
 124   {
 125     Proxy "http://127.0.0.1:3128";
 126     Proxy::http.us.debian.org "DIRECT";  // Specific per-host setting
 127     Timeout "120";
 128     Pipeline-Depth "5";
 129
 130     // Cache Control. Note these do not work with Squid 2.0.2
 131     No-Cache "false";
 132     Max-Age "86400";     // 1 Day age on index files
 133     No-Store "false";    // Prevent the cache from storing archives
 134     Dl-Limit "7";        // 7Kb/sec maximum download rate
 135   };
 136
 137   // HTTPS method configuration:
 138   // - uses the http proxy config
 139   // - uses the http cache-control values
 140   // - uses the http Dl-Limit values
 141   https
 142   {
 143         Verify-Peer "false";
 144         SslCert "/etc/apt/some.pem";
 145         CaPath  "/etc/ssl/certs";
 146         Verify-Host" "2";
 147   };
 148
 149   ftp
 150   {
 151     Proxy "ftp://127.0.0.1/";
 152     Proxy::http.us.debian.org "DIRECT"; // Specific per-host setting
 153
 154     /* Required script to perform proxy login. This example should work
 155        for tisfwtk */
 156     ProxyLogin
 157     {
 158        "USER $(PROXY_USER)";
 159        "PASS $(PROXY_PASS)";
 160        "USER $(SITE_USER)@$(SITE):$(SITE_PORT)";
 161        "PASS $(SITE_PASS)";
 162     };
 163
 164     Timeout "120";
 165
 166     /* Passive mode control, proxy, non-proxy and per-host. Pasv mode
 167        is prefered if possible */
 168     Passive "true";
 169     Proxy::Passive "true";
 170     Passive::http.us.debian.org "true"; // Specific per-host setting
 171   };
 172
 173   cdrom
 174   {
 175     mount "/cdrom";
 176
 177     // You need the trailing slash!
 178     "/cdrom/"
 179     {
 180        Mount "sleep 1000";
 181        UMount "sleep 500";
 182     }
 183   };
 184
 185   gpgv
 186   {
 187    Options {"--ignore-time-conflict";}  // not very usefull on a normal system
 188   };
 189 };
 190
 191 // Directory layout
 192 Dir "/"
 193 {
 194   // Location of the state dir
 195   State "var/lib/apt/"
 196   {
 197      Lists "lists/";
 198      xstatus "xstatus";
 199      userstatus "status.user";
 200      status "/var/lib/dpkg/status";
 201      cdroms "cdroms.list";
 202   };
 203
 204   // Location of the cache dir
 205   Cache "var/cache/apt/" {
 206      Archives "archives/";
 207      srcpkgcache "srcpkgcache.bin";
 208      pkgcache "pkgcache.bin";
 209   };
 210
 211   // Config files
 212   Etc "etc/apt/" {
 213      SourceList "sources.list";
 214      Main "apt.conf";
 215      Preferences "preferences";
 216      Parts "apt.conf.d/";
 217   };
 218
 219   // Locations of binaries
 220   Bin {
 221      methods "/usr/lib/apt/methods/";
 222      gzip "/bin/gzip";
 223      gpg  "/usr/bin/gpgv";
 224      dpkg "/usr/bin/dpkg";
 225      dpkg-source "/usr/bin/dpkg-source";
 226      dpkg-buildpackage "/usr/bin/dpkg-buildpackage";
 227      apt-get "/usr/bin/apt-get";
 228      apt-cache "/usr/bin/apt-cache";
 229   };
 230
 231   // Location of the logfile
 232   Log "var/log/apt" {
 233         Name "term.log";
 234   };
 235 };
 236
 237 // Things that effect the APT dselect method
 238 DSelect
 239 {
 240    Clean "auto";   // always|auto|prompt|never
 241    Options "-f";
 242    UpdateOptions "";
 243    PromptAfterUpdate "no";
 244    CheckDir "no";
 245 }
 246
 247 DPkg
 248 {
 249    // Probably don't want to use force-downgrade..
 250    Options {"--force-overwrite";"--force-downgrade";}
 251
 252    // Auto re-mounting of a readonly /usr
 253    Pre-Invoke {"mount -o remount,rw /usr";};
 254    Post-Invoke {"mount -o remount,ro /usr";};
 255
 256    // Prevents daemons from getting cwd as something mountable (default)
 257    Run-Directory "/";
 258
 259    // Build options for apt-get source --compile
 260    Build-Options "-b -uc";
 261
 262    // Pre-configure all packages before they are installed using debconf.
 263    Pre-Install-Pkgs {"dpkg-preconfigure --apt --priority=low --frontend=dialog";};
 264
 265    // Flush the contents of stdin before forking dpkg.
 266    FlushSTDIN "true";
 267
 268    // Control the size of the command line passed to dpkg.
 269    MaxBytes 1024;
 270    MaxArgs 350;
 271
 272    // controls if apt will apport on the first dpkg error or if it
 273    // tries to install as many packages as possible
 274    StopOnError "true";
 275 }
 276
 277 /* Options you can set to see some debugging text They correspond to names
 278    of classes in the source code */
 279 Debug
 280 {
 281   pkgProblemResolver "false";
 282   pkgDepCache::AutoInstall "false"; // what packages apt install to satify dependencies
 283   pkgAcquire "false";
 284   pkgAcquire::Worker "false";
 285   pkgAcquire::Auth "false";
 286   pkgDPkgPM "false";
 287   pkgDPkgProgressReporting "false";
 288   pkgOrderList "false";
 289   pkgAutoRemove "false";   // show information about automatic removes
 290   BuildDeps "false";
 291   pkgInitialize "false";   // This one will dump the configuration space
 292   NoLocking "false";
 293   Acquire::Ftp "false";    // Show ftp command traffic
 294   Acquire::Http "false";   // Show http command traffic
 295   Acquire::Https "false";   // Show https debug
 296   Acquire::gpgv "false";   // Show the gpgv traffic
 297   aptcdrom "false";        // Show found package files
 298   IdentCdrom "false";
 299
 300 }
 301
 302 /* Whatever you do, do not use this configuration file!! Take out ONLY
 303    the portions you need! */
 304 This Is Not A Valid Config File