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