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      Download-Only "false";
  37      Simulate "false";
  38      Assume-Yes "false";
  39      Force-Yes "false";             // I would never set this.
  40      Fix-Broken "false";
  41      Fix-Missing "false";
  42      Show-Upgraded "false";
  43      Show-Versions "false";
  44      Upgrade "true";
  45      Print-URIs "false";
  46      Compile "false";
  47      Download "true";
  48      Purge "false";
  49      List-Cleanup "true";
  50      ReInstall "false";
  51      Trivial-Only "false";
  52      Remove "true";
  53      Only-Source "";
  54      Diff-Only "false";
  55      Tar-Only "false";
  56   };
  57
  58   Cache
  59   {
  60      Important "false";
  61      AllVersions "false";
  62      GivenOnly "false";
  63      RecurseDepends "false";
  64      ShowFull "false";
  65      Generate "true";
  66      NamesOnly "false";
  67      AllNames "false";
  68      Installed "false";
  69   };
  70
  71   CDROM
  72   {
  73      Rename "false";
  74      NoMount "false";
  75      Fast "false";
  76      NoAct "false";
  77   };
  78
  79   Authentication
  80   {
  81      TrustCDROM "false";            // consider the CDROM always trusted
  82   };
  83
  84   GPGV
  85   {
  86      TrustedKeyring "/etc/apt/trusted.gpg";
  87   };
  88
  89   // Some general options
  90   Ignore-Hold "false";
  91   Clean-Installed "true";
  92   Immediate-Configure "true";      // DO NOT turn this off, see the man page
  93   Force-LoopBreak "false";         // DO NOT turn this on, see the man page
  94   Cache-Limit "4194304";
  95   Default-Release "";
  96
  97
  98   // Write progress messages on this fd (for stuff like base-config)
  99   Status-Fd "-1";
 100   // Keep the list of FDs open (normally apt closes all fds when it
 101   // does a ExecFork)
 102   Keep-Fds {};
 103 };
 104
 105 // Options for the downloading routines
 106 Acquire
 107 {
 108   Queue-Mode "host";       // host|access
 109   Retries "0";
 110   Source-Symlinks "true";
 111
 112   // HTTP method configuration
 113   http
 114   {
 115     Proxy "http://127.0.0.1:3128";
 116     Proxy::http.us.debian.org "DIRECT";  // Specific per-host setting
 117     Timeout "120";
 118     Pipeline-Depth "5";
 119
 120     // Cache Control. Note these do not work with Squid 2.0.2
 121     No-Cache "false";
 122     Max-Age "86400";     // 1 Day age on index files
 123     No-Store "false";    // Prevent the cache from storing archives
 124   };
 125
 126   ftp
 127   {
 128     Proxy "ftp://127.0.0.1/";
 129     Proxy::http.us.debian.org "DIRECT"; // Specific per-host setting
 130
 131     /* Required script to perform proxy login. This example should work
 132        for tisfwtk */
 133     ProxyLogin
 134     {
 135        "USER $(PROXY_USER)";
 136        "PASS $(PROXY_PASS)";
 137        "USER $(SITE_USER)@$(SITE):$(SITE_PORT)";
 138        "PASS $(SITE_PASS)";
 139     };
 140
 141     Timeout "120";
 142
 143     /* Passive mode control, proxy, non-proxy and per-host. Pasv mode
 144        is prefered if possible */
 145     Passive "true";
 146     Proxy::Passive "true";
 147     Passive::http.us.debian.org "true"; // Specific per-host setting
 148   };
 149
 150   cdrom
 151   {
 152     mount "/cdrom";
 153
 154     // You need the trailing slash!
 155     "/cdrom/"
 156     {
 157        Mount "sleep 1000";
 158        UMount "sleep 500";
 159     }
 160   };
 161
 162   gpgv
 163   {
 164    Options {"--ignore-time-conflict";}  // not very usefull on a normal system
 165   };
 166 };
 167
 168 // Directory layout
 169 Dir "/"
 170 {
 171   // Location of the state dir
 172   State "var/lib/apt/"
 173   {
 174      Lists "lists/";
 175      xstatus "xstatus";
 176      userstatus "status.user";
 177      status "/var/lib/dpkg/status";
 178      cdroms "cdroms.list";
 179   };
 180
 181   // Location of the cache dir
 182   Cache "var/cache/apt/" {
 183      Archives "archives/";
 184      srcpkgcache "srcpkgcache.bin";
 185      pkgcache "pkgcache.bin";
 186   };
 187
 188   // Config files
 189   Etc "etc/apt/" {
 190      SourceList "sources.list";
 191      Main "apt.conf";
 192      Preferences "preferences";
 193      Parts "apt.conf.d/";
 194   };
 195
 196   // Locations of binaries
 197   Bin {
 198      methods "/usr/lib/apt/methods/";
 199      gzip "/bin/gzip";
 200      gpg  "/usr/bin/gpgv";
 201      dpkg "/usr/bin/dpkg";
 202      dpkg-source "/usr/bin/dpkg-source";
 203      dpkg-buildpackage "/usr/bin/dpkg-buildpackage";
 204      apt-get "/usr/bin/apt-get";
 205      apt-cache "/usr/bin/apt-cache";
 206   };
 207 };
 208
 209 // Things that effect the APT dselect method
 210 DSelect
 211 {
 212    Clean "auto";   // always|auto|prompt|never
 213    Options "-f";
 214    UpdateOptions "";
 215    PromptAfterUpdate "no";
 216    CheckDir "no";
 217 }
 218
 219 DPkg
 220 {
 221    // Probably don't want to use force-downgrade..
 222    Options {"--force-overwrite";"--force-downgrade";}
 223
 224    // Auto re-mounting of a readonly /usr
 225    Pre-Invoke {"mount -o remount,rw /usr";};
 226    Post-Invoke {"mount -o remount,ro /usr";};
 227
 228    // Prevents daemons from getting cwd as something mountable (default)
 229    Run-Directory "/";
 230
 231    // Build options for apt-get source --compile
 232    Build-Options "-b -uc";
 233
 234    // Pre-configure all packages before they are installed using debconf.
 235    Pre-Install-Pkgs {"dpkg-preconfigure --apt --priority=low --frontend=dialog";};
 236
 237    // Flush the contents of stdin before forking dpkg.
 238    FlushSTDIN "true";
 239
 240    // Control the size of the command line passed to dpkg.
 241    MaxBytes 1024;
 242    MaxArgs 350;
 243 }
 244
 245 /* Options you can set to see some debugging text They correspond to names
 246    of classes in the source code */
 247 Debug
 248 {
 249   pkgProblemResolver "false";
 250   pkgAcquire "false";
 251   pkgAcquire::Worker "false";
 252   pkgDPkgPM "false";
 253   pkgDPkgProgressReporting "false";
 254   pkgOrderList "false";
 255   pkgAutoRemove "false";   // show information about automatic removes
 256
 257   pkgInitialize "false";   // This one will dump the configuration space
 258   NoLocking "false";
 259   Acquire::Ftp "false";    // Show ftp command traffic
 260   Acquire::Http "false";   // Show http command traffic
 261   Acquire::gpgv "false";   // Show the gpgv traffic
 262   aptcdrom "false";        // Show found package files
 263   IdentCdrom "false";
 264
 265 }
 266
 267 /* Whatever you do, do not use this configuration file!! Take out ONLY
 268    the portions you need! */
 269 This Is Not A Valid Config File