doc/examples/configure-index

   1 // $Id: configure-index,v 1.4 2001/12/05 07:22:40 tausq 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 a completely
   4    valid file. Most of the options have sane default values, unless
   5    you have specific needs you should NOT include arbitary items in a custom
   6    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 // Options for APT in general
  21 APT
  22 {
  23   Architecture "i386";
  24   Build-Essential "build-essential";
  25
  26   // Options for apt-get
  27   Get
  28   {
  29      Arch-Only "false";
  30      Download-Only "false";
  31      Simulate "false";
  32      Assume-Yes "false";
  33      Force-Yes "false";             // I would never set this.
  34      Fix-Broken "false";
  35      Fix-Missing "false";
  36      Show-Upgraded "false";
  37      Upgrade "true";
  38      Print-URIs "false";
  39      Compile "false";
  40      Download "true";
  41      Purge "false";
  42      List-Cleanup "true";
  43      ReInstall "false";
  44      Trivial-Only "false";
  45      Remove "true";
  46   };
  47
  48   Cache
  49   {
  50      Important "false";
  51      AllVersions "false";
  52      GivenOnly "false";
  53      RecruseDepends "false";
  54   };
  55
  56   CDROM
  57   {
  58      Rename "false";
  59      NoMount "false";
  60      Fast "false";
  61      NoAct "false";
  62   };
  63
  64   // Some general options
  65   Ignore-Hold "false";
  66   Clean-Installed "true";
  67   Immediate-Configure "true";      // DO NOT turn this off, see the man page
  68   Force-LoopBreak "false";         // DO NOT turn this on, see the man page
  69   Cache-Limit "4194304";
  70 };
  71
  72 // Options for the downloading routines
  73 Acquire
  74 {
  75   Queue-Mode "host";       // host|access
  76   Retries "0";
  77   Source-Symlinks "true";
  78
  79   // HTTP method configuration
  80   http
  81   {
  82     Proxy "http://127.0.0.1:3128";
  83     Proxy::http.us.debian.org "DIRECT";  // Specific per-host setting
  84     Timeout "120";
  85     Pipeline-Depth "5";
  86
  87     // Cache Control. Note these do not work with Squid 2.0.2
  88     No-Cache "false";
  89     Max-Age "86400";     // 1 Day age on index files
  90     No-Store "false";    // Prevent the cache from storing archives
  91   };
  92
  93   ftp
  94   {
  95     Proxy "ftp://127.0.0.1/";
  96     Proxy::http.us.debian.org "DIRECT"; // Specific per-host setting
  97
  98     /* Required script to perform proxy login. This example should work
  99        for tisfwtk */
 100     ProxyLogin
 101     {
 102        "USER $(PROXY_USER)";
 103        "PASS $(PROXY_PASS)";
 104        "USER $(SITE_USER)@$(SITE):$(SITE_PORT)";
 105        "PASS $(SITE_PASS)";
 106     };
 107
 108     Timeout "120";
 109
 110     /* Passive mode control, proxy, non-proxy and per-host. Pasv mode
 111        is prefered if possible */
 112     Passive "true";
 113     Proxy::Passive "true";
 114     Passive::http.us.debian.org "true"; // Specific per-host setting
 115   };
 116
 117   cdrom
 118   {
 119     Mount "/cdrom";
 120
 121     // You need the trailing slash!
 122     "/cdrom/"
 123     {
 124        Mount "sleep 1000";
 125        UMount "sleep 500";
 126     }
 127   };
 128 };
 129
 130 // Directory layout
 131 Dir "/"
 132 {
 133   // Location of the state dir
 134   State "var/lib/apt/"
 135   {
 136      lists "lists/";
 137      xstatus "xstatus";
 138      userstatus "status.user";
 139      status "/var/lib/dpkg/status";
 140      cdroms "cdroms.list";
 141   };
 142
 143   // Location of the cache dir
 144   Cache "var/cache/apt/" {
 145      archives "archives/";
 146      srcpkgcache "srcpkgcache.bin";
 147      pkgcache "pkgcache.bin";
 148   };
 149
 150   // Config files
 151   Etc "etc/apt/" {
 152      sourcelist "sources.list";
 153      main "apt.conf";
 154      preferences "preferences";
 155   };
 156
 157   // Locations of binaries
 158   Bin {
 159      methods "/usr/lib/apt/methods/";
 160      gzip "/bin/gzip";
 161      dpkg "/usr/bin/dpkg";
 162      dpkg-source "/usr/bin/dpkg-source";
 163      dpkg-buildpackage "/usr/bin/dpkg-buildpackage"
 164      apt-get "/usr/bin/apt-get";
 165      apt-cache "/usr/bin/apt-cache";
 166   };
 167 };
 168
 169 // Things that effect the APT dselect method
 170 DSelect
 171 {
 172    Clean "auto";   // always|auto|prompt|never
 173    Options "-f";
 174    UpdateOptions "";
 175    PromptAfterUpdate "no";
 176    CheckDir "no";
 177 }
 178
 179 DPkg
 180 {
 181    // Probably don't want to use force-downgrade..
 182    Options {"--force-overwrite";"--force-downgrade";}
 183
 184    // Auto re-mounting of a readonly /usr
 185    Pre-Invoke {"mount -o remount,rw /usr";};
 186    Post-Invoke {"mount -o remount,ro /usr";};
 187
 188    // Prevents daemons from getting cwd as something mountable (default)
 189    Run-Directory "/";
 190
 191    // Build options for apt-get source --compile
 192    Build-Options "-b -uc";
 193
 194    // Pre-configure all packages before they are installed using debconf.
 195    Pre-Install-Pkgs {"dpkg-preconfig --apt --priority=low --frontend=dialog";};
 196
 197    // Flush the contents of stdin before forking dpkg.
 198    FlushSTDIN "true";
 199 }
 200
 201 /* Options you can set to see some debugging text They corrispond to names
 202    of classes in the source code */
 203 Debug
 204 {
 205   pkgProblemResolver "false";
 206   pkgAcquire "false";
 207   pkgAcquire::Worker "false";
 208   pkgDPkgPM "false";
 209   pkgOrderList "false";
 210
 211   pkgInitialize "false";   // This one will dump the configuration space
 212   NoLocking "false";
 213   Acquire::Ftp "false";    // Show ftp command traffic
 214   Acquire::Http "false";   // Show http command traffic
 215   aptcdrom "false";        // Show found package files
 216 }
 217
 218 /* Whatever you do, do not use this configuration file!! Take out ONLY
 219    the portions you need! */
 220 This Is Not A Valid Config File