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