doc/examples/configure-index

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